Package io.apicurio.registry.events

Class EventSourcedRegistryStorage

java.lang.Object

io.apicurio.registry.storage.decorator.RegistryStorageDecorator

io.apicurio.registry.events.EventSourcedRegistryStorage

All Implemented Interfaces:

RegistryStorage

@ApplicationScoped
public class EventSourcedRegistryStorage
extends RegistryStorageDecorator

Author:

Fabian Martinez

Field Summary

Fields inherited from class io.apicurio.registry.storage.decorator.RegistryStorageDecorator

delegate

Constructor Summary

Constructors

Constructor	Description
EventSourcedRegistryStorage()

Method Summary

Modifier and Type	Method	Description
ArtifactMetaDataDto	createArtifact(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content)	Creates a new artifact (from the given value) in the artifactStore.
void	createArtifactRule(String groupId, String artifactId, RuleType rule, RuleConfigurationDto config)	Creates an artifact rule for a specific Artifact.
ArtifactMetaDataDto	createArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, EditableArtifactMetaDataDto metaData)	Creates a new artifact (from the given value including metadata) in the artifactStore.
void	createGlobalRule(RuleType rule, RuleConfigurationDto config)	Creates a single global rule.
void	createGroup(GroupMetaDataDto group)	Creates a new empty group and stores it's metadata.
List<String>	deleteArtifact(String groupId, String artifactId)	Deletes an artifact by its group and unique id.
void	deleteArtifactRule(String groupId, String artifactId, RuleType rule)	Deletes a single stored/configured rule for a given artifact.
void	deleteArtifactRules(String groupId, String artifactId)	Deletes all rules stored/configured for the artifact.
void	deleteArtifacts(String groupId)	Deletes all artifacts in the given group.
void	deleteArtifactVersion(String groupId, String artifactId, String version)	Deletes a single version of a given artifact.
void	deleteGlobalRule(RuleType rule)	Deletes a single global rule.
void	deleteGlobalRules()	Deletes all of the globally configured rules.
void	deleteGroup(String groupId)	Deletes a group intified by the given groupId and DELETES ALL resources related to this group
StoredArtifactDto	getArtifact(String groupId, String artifactId)	Gets the most recent version of the value of the artifact with the given group and ID.
ContentHandle	getArtifactByContentHash(String contentHash)	Gets some artifact content by the SHA-256 hash of that content.
ContentHandle	getArtifactByContentId(long contentId)	Gets some artifact content by the unique contentId.
List<RuleType>	getArtifactRules(String groupId, String artifactId)	Gets a list of rules configured for a specific Artifact (by group and ID).
boolean	isEnabled()
int	order()
ArtifactMetaDataDto	updateArtifact(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content)	Updates the artifact value by storing the given value as a new version of the artifact.
void	updateArtifactMetaData(String groupId, String artifactId, EditableArtifactMetaDataDto metaData)	Updates the stored meta-data for an artifact by group and ID.
void	updateArtifactRule(String groupId, String artifactId, RuleType rule, RuleConfigurationDto config)	Updates the configuration information for a single rule on a given artifact.
void	updateArtifactState(String groupId, String artifactId, ArtifactState state)	Update artifact state.
void	updateArtifactState(String groupId, String artifactId, String version, ArtifactState state)	Update artifact state.
ArtifactMetaDataDto	updateArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, EditableArtifactMetaDataDto metaData)	Updates the artifact value by storing the given value and metadata as a new version of the artifact.
void	updateGlobalRule(RuleType rule, RuleConfigurationDto config)	Updates the configuration settings for a single global rule.
void	updateGroupMetaData(GroupMetaDataDto group)	Updates the metadata of an existent group.

Methods inherited from class io.apicurio.registry.storage.decorator.RegistryStorageDecorator

consumeDownload, countArtifacts, countArtifactVersions, countTotalArtifactVersions, createDownload, createRoleMapping, deleteAllExpiredDownloads, deleteAllUserData, deleteArtifactVersionMetaData, deleteRoleMapping, exportData, getArtifactIds, getArtifactMetaData, getArtifactMetaData, getArtifactRule, getArtifactVersion, getArtifactVersion, getArtifactVersionMetaData, getArtifactVersionMetaData, getArtifactVersions, getArtifactVersionsByContentId, getGlobalRule, getGlobalRules, getGroupIds, getGroupMetaData, getLogConfiguration, getRoleForPrincipal, getRoleMapping, getRoleMappings, importData, isAlive, isReady, listLogConfigurations, removeLogConfiguration, searchArtifacts, searchVersions, setDelegate, setLogConfiguration, storageName, supportsMultiTenancy, updateArtifactVersionMetaData, updateRoleMapping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventSourcedRegistryStorage

public EventSourcedRegistryStorage()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in class RegistryStorageDecorator

See Also:

io.apicurio.registry.delegate.decorator.RegistryStorageDecorator#isEnabled()

order

public int order()

Specified by:

order in class RegistryStorageDecorator

See Also:

io.apicurio.registry.delegate.decorator.RegistryStorageDecorator#order()

updateArtifactState

public void updateArtifactState(String groupId,
                                String artifactId,
                                ArtifactState state)
                         throws ArtifactNotFoundException,
                                RegistryStorageException

Description copied from interface: RegistryStorage

Update artifact state.

Specified by:

updateArtifactState in interface RegistryStorage

Overrides:

updateArtifactState in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifactState(java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactState)

updateArtifactState

public void updateArtifactState(String groupId,
                                String artifactId,
                                String version,
                                ArtifactState state)
                         throws ArtifactNotFoundException,
                                VersionNotFoundException,
                                RegistryStorageException

Description copied from interface: RegistryStorage

Update artifact state.

Specified by:

updateArtifactState in interface RegistryStorage

Overrides:

updateArtifactState in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifactState(java.lang.String, java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactState)

createArtifact

public ArtifactMetaDataDto createArtifact(String groupId,
                                          String artifactId,
                                          String version,
                                          ArtifactType artifactType,
                                          ContentHandle content)
                                   throws ArtifactAlreadyExistsException,
                                          RegistryStorageException

Description copied from interface: RegistryStorage

Creates a new artifact (from the given value) in the artifactStore. The artifactId must be unique within the given artifact group. Returns a map of meta-data generated by the artifactStore layer, such as the generated, globally unique globalId of the new value. If the group did not exist previously it is created automatically.

Specified by:

createArtifact in interface RegistryStorage

Overrides:

createArtifact in class RegistryStorageDecorator

Parameters:

groupId - (optional)

version - (optional)

Throws:

ArtifactAlreadyExistsException

RegistryStorageException

See Also:

RegistryStorage.createArtifact(java.lang.String, java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactType, io.apicurio.registry.content.ContentHandle)

createArtifactWithMetadata

public ArtifactMetaDataDto createArtifactWithMetadata(String groupId,
                                                      String artifactId,
                                                      String version,
                                                      ArtifactType artifactType,
                                                      ContentHandle content,
                                                      EditableArtifactMetaDataDto metaData)
                                               throws ArtifactAlreadyExistsException,
                                                      RegistryStorageException

Description copied from interface: RegistryStorage

Creates a new artifact (from the given value including metadata) in the artifactStore. The artifactId must be unique within the given artifact group. Returns a map of meta-data generated by the artifactStore layer, such as the generated, globally unique globalId of the new value.

Specified by:

createArtifactWithMetadata in interface RegistryStorage

Overrides:

createArtifactWithMetadata in class RegistryStorageDecorator

Parameters:

groupId - (optional)

version - (optional)

Throws:

ArtifactAlreadyExistsException

RegistryStorageException

See Also:

io.apicurio.registry.delegate.RegistryStorage#createArtifactWithMetadata(java.lang.String, java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactType, io.apicurio.registry.content.ContentHandle, io.apicurio.registry.delegate.dto.EditableArtifactMetaDataDto)

deleteArtifact

public List<String> deleteArtifact(String groupId,
                                   String artifactId)
                            throws ArtifactNotFoundException,
                                   RegistryStorageException

Description copied from interface: RegistryStorage

Deletes an artifact by its group and unique id. Returns list of artifact versions.

Specified by:

deleteArtifact in interface RegistryStorage

Overrides:

deleteArtifact in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteArtifact(java.lang.String, java.lang.String)

deleteArtifacts

public void deleteArtifacts(String groupId)
                     throws RegistryStorageException

Description copied from interface: RegistryStorage

Deletes all artifacts in the given group. DOES NOT delete the group.

Specified by:

deleteArtifacts in interface RegistryStorage

Overrides:

deleteArtifacts in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

RegistryStorageException

See Also:

RegistryStorage.deleteArtifacts(java.lang.String)

getArtifact

public StoredArtifactDto getArtifact(String groupId,
                                     String artifactId)
                              throws ArtifactNotFoundException,
                                     RegistryStorageException

Description copied from interface: RegistryStorage

Gets the most recent version of the value of the artifact with the given group and ID.

Specified by:

getArtifact in interface RegistryStorage

Overrides:

getArtifact in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifact(java.lang.String, java.lang.String)

getArtifactByContentHash

public ContentHandle getArtifactByContentHash(String contentHash)
                                       throws ContentNotFoundException,
                                              RegistryStorageException

Description copied from interface: RegistryStorage

Gets some artifact content by the SHA-256 hash of that content. This method of getting content from storage does not allow extra meta-data to be returned, because the content hash only points to a piece of content/data - it is divorced from any artifact version.

Specified by:

getArtifactByContentHash in interface RegistryStorage

Overrides:

getArtifactByContentHash in class RegistryStorageDecorator

Throws:

ContentNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactByContentHash(java.lang.String)

getArtifactByContentId

public ContentHandle getArtifactByContentId(long contentId)
                                     throws ContentNotFoundException,
                                            RegistryStorageException

Description copied from interface: RegistryStorage

Gets some artifact content by the unique contentId. This method of getting content from storage does not allow extra meta-data to be returned, because the contentId only points to a piece of content/data - it is divorced from any artifact version.

Specified by:

getArtifactByContentId in interface RegistryStorage

Overrides:

getArtifactByContentId in class RegistryStorageDecorator

Throws:

ContentNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactByContentId(long)

updateArtifact

public ArtifactMetaDataDto updateArtifact(String groupId,
                                          String artifactId,
                                          String version,
                                          ArtifactType artifactType,
                                          ContentHandle content)
                                   throws ArtifactNotFoundException,
                                          RegistryStorageException

Description copied from interface: RegistryStorage

Updates the artifact value by storing the given value as a new version of the artifact. Previous value is NOT overwitten. Returns a map of meta-data generated by the artifactStore layer, such as the generated, globally unique globalId of the new value.

Specified by:

updateArtifact in interface RegistryStorage

Overrides:

updateArtifact in class RegistryStorageDecorator

Parameters:

groupId - (optional)

version - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifact(java.lang.String, java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactType, io.apicurio.registry.content.ContentHandle)

updateArtifactWithMetadata

public ArtifactMetaDataDto updateArtifactWithMetadata(String groupId,
                                                      String artifactId,
                                                      String version,
                                                      ArtifactType artifactType,
                                                      ContentHandle content,
                                                      EditableArtifactMetaDataDto metaData)
                                               throws ArtifactNotFoundException,
                                                      RegistryStorageException

Description copied from interface: RegistryStorage

Updates the artifact value by storing the given value and metadata as a new version of the artifact. Previous value is NOT overwitten. Returns a map of meta-data generated by the artifactStore layer, such as the generated, globally unique globalId of the new value.

Specified by:

updateArtifactWithMetadata in interface RegistryStorage

Overrides:

updateArtifactWithMetadata in class RegistryStorageDecorator

Parameters:

groupId - (optional)

version - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifactWithMetadata(java.lang.String, java.lang.String, java.lang.String, io.apicurio.registry.types.ArtifactType, io.apicurio.registry.content.ContentHandle, io.apicurio.registry.storage.dto.EditableArtifactMetaDataDto)

updateArtifactMetaData

public void updateArtifactMetaData(String groupId,
                                   String artifactId,
                                   EditableArtifactMetaDataDto metaData)
                            throws ArtifactNotFoundException,
                                   RegistryStorageException

Description copied from interface: RegistryStorage

Updates the stored meta-data for an artifact by group and ID. Only the client-editable meta-data can be updated. Client editable meta-data includes e.g. name and description. TODO what if set to null?

Specified by:

updateArtifactMetaData in interface RegistryStorage

Overrides:

updateArtifactMetaData in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifactMetaData(java.lang.String, java.lang.String, io.apicurio.registry.storage.dto.EditableArtifactMetaDataDto)

getArtifactRules

public List<RuleType> getArtifactRules(String groupId,
                                       String artifactId)
                                throws ArtifactNotFoundException,
                                       RegistryStorageException

Description copied from interface: RegistryStorage

Gets a list of rules configured for a specific Artifact (by group and ID). This will return only the names of the rules.

Specified by:

getArtifactRules in interface RegistryStorage

Overrides:

getArtifactRules in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactRules(java.lang.String, java.lang.String)

createArtifactRule

public void createArtifactRule(String groupId,
                               String artifactId,
                               RuleType rule,
                               RuleConfigurationDto config)
                        throws ArtifactNotFoundException,
                               RuleAlreadyExistsException,
                               RegistryStorageException

Description copied from interface: RegistryStorage

Creates an artifact rule for a specific Artifact. If the named rule already exists for the artifact, then this should fail.

Specified by:

createArtifactRule in interface RegistryStorage

Overrides:

createArtifactRule in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleAlreadyExistsException

RegistryStorageException

See Also:

io.apicurio.registry.delegate.RegistryStorage#createArtifactRule(java.lang.String, java.lang.String, io.apicurio.registry.types.RuleType, io.apicurio.registry.delegate.dto.RuleConfigurationDto)

deleteArtifactRules

public void deleteArtifactRules(String groupId,
                                String artifactId)
                         throws ArtifactNotFoundException,
                                RegistryStorageException

Description copied from interface: RegistryStorage

Deletes all rules stored/configured for the artifact.

Specified by:

deleteArtifactRules in interface RegistryStorage

Overrides:

deleteArtifactRules in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteArtifactRules(java.lang.String, java.lang.String)

updateArtifactRule

public void updateArtifactRule(String groupId,
                               String artifactId,
                               RuleType rule,
                               RuleConfigurationDto config)
                        throws ArtifactNotFoundException,
                               RuleNotFoundException,
                               RegistryStorageException

Description copied from interface: RegistryStorage

Updates the configuration information for a single rule on a given artifact.

Specified by:

updateArtifactRule in interface RegistryStorage

Overrides:

updateArtifactRule in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateArtifactRule(java.lang.String, java.lang.String, io.apicurio.registry.types.RuleType, io.apicurio.registry.storage.dto.RuleConfigurationDto)

deleteArtifactRule

public void deleteArtifactRule(String groupId,
                               String artifactId,
                               RuleType rule)
                        throws ArtifactNotFoundException,
                               RuleNotFoundException,
                               RegistryStorageException

Description copied from interface: RegistryStorage

Deletes a single stored/configured rule for a given artifact.

Specified by:

deleteArtifactRule in interface RegistryStorage

Overrides:

deleteArtifactRule in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteArtifactRule(java.lang.String, java.lang.String, io.apicurio.registry.types.RuleType)

deleteArtifactVersion

public void deleteArtifactVersion(String groupId,
                                  String artifactId,
                                  String version)
                           throws ArtifactNotFoundException,
                                  VersionNotFoundException,
                                  RegistryStorageException

Description copied from interface: RegistryStorage

Deletes a single version of a given artifact.

Specified by:

deleteArtifactVersion in interface RegistryStorage

Overrides:

deleteArtifactVersion in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteArtifactVersion(java.lang.String, java.lang.String, java.lang.String)

createGlobalRule

public void createGlobalRule(RuleType rule,
                             RuleConfigurationDto config)
                      throws RuleAlreadyExistsException,
                             RegistryStorageException

Description copied from interface: RegistryStorage

Creates a single global rule. Duplicates (by name) are not allowed. Stores the rule name and configuration.

Specified by:

createGlobalRule in interface RegistryStorage

Overrides:

createGlobalRule in class RegistryStorageDecorator

Throws:

RuleAlreadyExistsException

RegistryStorageException

See Also:

RegistryStorage.createGlobalRule(io.apicurio.registry.types.RuleType, io.apicurio.registry.storage.dto.RuleConfigurationDto)

deleteGlobalRules

public void deleteGlobalRules()
                       throws RegistryStorageException

Description copied from interface: RegistryStorage

Deletes all of the globally configured rules.

Specified by:

deleteGlobalRules in interface RegistryStorage

Overrides:

deleteGlobalRules in class RegistryStorageDecorator

Throws:

RegistryStorageException

See Also:

RegistryStorage.deleteGlobalRules()

updateGlobalRule

public void updateGlobalRule(RuleType rule,
                             RuleConfigurationDto config)
                      throws RuleNotFoundException,
                             RegistryStorageException

Description copied from interface: RegistryStorage

Updates the configuration settings for a single global rule.

Specified by:

updateGlobalRule in interface RegistryStorage

Overrides:

updateGlobalRule in class RegistryStorageDecorator

Throws:

RuleNotFoundException

RegistryStorageException

See Also:

RegistryStorage.updateGlobalRule(io.apicurio.registry.types.RuleType, io.apicurio.registry.storage.dto.RuleConfigurationDto)

deleteGlobalRule

public void deleteGlobalRule(RuleType rule)
                      throws RuleNotFoundException,
                             RegistryStorageException

Description copied from interface: RegistryStorage

Deletes a single global rule.

Specified by:

deleteGlobalRule in interface RegistryStorage

Overrides:

deleteGlobalRule in class RegistryStorageDecorator

Throws:

RuleNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteGlobalRule(io.apicurio.registry.types.RuleType)

createGroup

public void createGroup(GroupMetaDataDto group)
                 throws GroupAlreadyExistsException,
                        RegistryStorageException

Description copied from interface: RegistryStorage

Creates a new empty group and stores it's metadata. When creating an artifact the group is automatically created in it does not exist.

Specified by:

createGroup in interface RegistryStorage

Overrides:

createGroup in class RegistryStorageDecorator

Throws:

GroupAlreadyExistsException

RegistryStorageException

See Also:

io.apicurio.registry.delegate.RegistryStorage#createGroup(io.apicurio.registry.delegate.dto.GroupMetaDataDto)

updateGroupMetaData

public void updateGroupMetaData(GroupMetaDataDto group)
                         throws GroupNotFoundException,
                                RegistryStorageException

Description copied from interface: RegistryStorage

Updates the metadata of an existent group.

Specified by:

updateGroupMetaData in interface RegistryStorage

Overrides:

updateGroupMetaData in class RegistryStorageDecorator

Throws:

RegistryStorageException

GroupNotFoundException

See Also:

io.apicurio.registry.delegate.RegistryStorage#updateGroupMetaData(io.apicurio.registry.delegate.dto.GroupMetaDataDto)

deleteGroup

public void deleteGroup(String groupId)
                 throws GroupNotFoundException,
                        RegistryStorageException

Description copied from interface: RegistryStorage

Deletes a group intified by the given groupId and DELETES ALL resources related to this group

Specified by:

deleteGroup in interface RegistryStorage

Overrides:

deleteGroup in class RegistryStorageDecorator

Parameters:

groupId - (optional)

Throws:

GroupNotFoundException

RegistryStorageException

See Also:

io.apicurio.registry.delegate.RegistryStorage#deleteGroup(java.lang.String)