Package io.apicurio.registry.rules

Interface RulesService

All Known Implementing Classes:

RulesServiceImpl

public interface RulesService

A service used to apply configured rules to a given content update. In other words, when artifact content is being created or updated, this service is used to apply any rules configured for the artifact.

Author:

Ales Justin, Jakub Senko 'jsenko@redhat.com'

Method Summary

Modifier and Type	Method	Description
void	applyRule(String groupId, String artifactId, ArtifactType artifactType, ContentHandle artifactContent, RuleType ruleType, String ruleConfiguration, RuleApplicationType ruleApplicationType)	Applies a single, specific rule to the content update for the given artifact.
void	applyRules(String groupId, String artifactId, ArtifactType artifactType, ContentHandle artifactContent, RuleApplicationType ruleApplicationType)	Applies all configured rules to check whether a content update for an artifact is allowed.
void	applyRules(String groupId, String artifactId, String artifactVersion, ArtifactType artifactType, ContentHandle updatedContent)	Applies configured rules to the content update, relative to ANY artifact version.

Method Detail

applyRules

void applyRules(String groupId,
                String artifactId,
                ArtifactType artifactType,
                ContentHandle artifactContent,
                RuleApplicationType ruleApplicationType)
         throws RuleViolationException

Applies all configured rules to check whether a content update for an artifact is allowed.

Parameters:

groupId -

artifactId -

artifactType -

artifactContent -

ruleApplicationType -

Throws:

RuleViolationException

applyRule

void applyRule(String groupId,
               String artifactId,
               ArtifactType artifactType,
               ContentHandle artifactContent,
               RuleType ruleType,
               String ruleConfiguration,
               RuleApplicationType ruleApplicationType)
        throws RuleViolationException

Applies a single, specific rule to the content update for the given artifact.

Parameters:

groupId -

artifactId -

artifactType -

artifactContent -

ruleType -

ruleConfiguration -

ruleApplicationType -

Throws:

RuleViolationException

applyRules

void applyRules(String groupId,
                String artifactId,
                String artifactVersion,
                ArtifactType artifactType,
                ContentHandle updatedContent)
         throws RuleViolationException

Applies configured rules to the content update, relative to ANY artifact version.

Parameters:

groupId -

artifactId -

artifactVersion -

artifactType -

updatedContent -

Throws:

RuleViolationException