Package io.apicurio.registry.storage.impl.sql

Class AbstractSqlRegistryStorage

java.lang.Object

io.apicurio.registry.storage.impl.AbstractRegistryStorage

io.apicurio.registry.storage.impl.sql.AbstractSqlRegistryStorage

All Implemented Interfaces:

RegistryStorage

Direct Known Subclasses:

InMemoryRegistryStorage

public abstract class AbstractSqlRegistryStorage
extends AbstractRegistryStorage

A SQL implementation of the RegistryStorage interface. This impl does not use any ORM technology - it simply uses native SQL for all operations.

Author:

eric.wittmann@gmail.com

Constructor Summary

Constructors

Constructor	Description
AbstractSqlRegistryStorage()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected ContentHandle	canonicalizeContent(ArtifactType artifactType, ContentHandle content)	Canonicalize the given content, returns the content unchanged in the case of an error.
DownloadContextDto	consumeDownload(String downloadId)	Called to consume a download from the DB (single-use) and return its context info.
long	countArtifacts()	Counts the total number of artifacts
long	countArtifactVersions(String groupId, String artifactId)	Counts the total number of versions for one artifact
long	countTotalArtifactVersions()	Counts the total number of versions for all artifacts
ArtifactMetaDataDto	createArtifact(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content)	Creates a new artifact (from the given value) in the artifactStore.
protected ArtifactMetaDataDto	createArtifact(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, GlobalIdGenerator globalIdGenerator)
void	createArtifactRule(String groupId, String artifactId, RuleType rule, RuleConfigurationDto config)	Creates an artifact rule for a specific Artifact.
protected ArtifactMetaDataDto	createArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, long contentId, String createdBy, Date createdOn, EditableArtifactMetaDataDto metaData, GlobalIdGenerator globalIdGenerator)
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.
protected ArtifactMetaDataDto	createArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, EditableArtifactMetaDataDto metaData, GlobalIdGenerator globalIdGenerator)
String	createDownload(DownloadContextDto context)	Called to create a single-use download "link".
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.
protected Long	createOrUpdateContent(Handle handle, ArtifactType artifactType, ContentHandle content)	Store the content in the database and return the ID of the new row.
void	createRoleMapping(String principalId, String role, String principalName)	Creates a role mapping for a user.
void	deleteAllExpiredDownloads()	Called to delete any expired rows in the downloads table.
protected void	deleteAllOrphanedContent()
void	deleteAllUserData()	Deletes ALL user (tenant) data.
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	deleteArtifactVersionMetaData(String groupId, String artifactId, String version)	Deletes the user-editable meta-data for a singel 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
void	deleteRoleMapping(String principalId)	Deletes a single role mapping.
void	exportData(Function<Entity,Void> handler)	Called to export all data in the registry.
protected EditableArtifactMetaDataDto	extractMetaData(ArtifactType artifactType, ContentHandle content)
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.
Set<String>	getArtifactIds(Integer limit)	Get all artifact ids.
ArtifactMetaDataDto	getArtifactMetaData(long globalId)	Gets the stored meta-data for an artifact by global ID.
ArtifactMetaDataDto	getArtifactMetaData(String groupId, String artifactId)	Gets the stored meta-data for an artifact by group and ID.
RuleConfigurationDto	getArtifactRule(String groupId, String artifactId, RuleType rule)	Gets all of the information for a single rule configured on a given artifact.
List<RuleType>	getArtifactRules(String groupId, String artifactId)	Gets a list of rules configured for a specific Artifact (by group and ID).
StoredArtifactDto	getArtifactVersion(long globalId)	Gets the stored artifact content for the artifact version with the given unique global ID.
StoredArtifactDto	getArtifactVersion(String groupId, String artifactId, String version)	Gets the stored value for a single version of a given artifact.
ArtifactVersionMetaDataDto	getArtifactVersionMetaData(String groupId, String artifactId, boolean canonical, ContentHandle content)	Gets the metadata of the version that matches content.
ArtifactVersionMetaDataDto	getArtifactVersionMetaData(String groupId, String artifactId, String version)	Gets the stored meta-data for a single version of an artifact.
List<String>	getArtifactVersions(String groupId, String artifactId)	Gets a sorted set of all artifact versions that exist for a given artifact.
List<ArtifactMetaDataDto>	getArtifactVersionsByContentId(long contentId)	Get artifact metadata for a given contentId
RuleConfigurationDto	getGlobalRule(RuleType rule)	Gets all information about a single global rule.
List<RuleType>	getGlobalRules()	Gets a list of all global rule names.
List<String>	getGroupIds(Integer limit)	Get all groupIds
GroupMetaDataDto	getGroupMetaData(String groupId)	Get the metadata information for a group identified by the given groupId
LogConfigurationDto	getLogConfiguration(String logger)	Returns the log configuration persisted in the storage for the given logger
String	getRoleForPrincipal(String principalId)	Gets the role for a single user.
RoleMappingDto	getRoleMapping(String principalId)	Gets the details of a single role mapping.
List<RoleMappingDto>	getRoleMappings()	Gets the list of all the role mappings in the registry.
protected void	importArtifactRule(Handle handle, ArtifactRuleEntity entity)
protected void	importArtifactVersion(Handle handle, ArtifactVersionEntity entity)
protected void	importContent(Handle handle, ContentEntity entity)
void	importData(EntityInputStream entities)	Called to import previously exported data into the registry.
protected void	importEntity(Handle handle, Entity entity)
protected void	importGlobalRule(Handle handle, GlobalRuleEntity entity)
protected void	importGroup(Handle handle, GroupEntity entity)
protected void	initialize()
boolean	isArtifactExists(String groupId, String artifactId)
boolean	isContentExists(long contentId)
protected boolean	isGlobalIdExists(long globalId)
List<LogConfigurationDto>	listLogConfigurations()	Returns the list of log configuration persisted in the storage
protected long	nextContentId(Handle handle)
protected long	nextGlobalId(Handle handle)
void	removeLogConfiguration(String logger)	Removes the persisted log configuration for the given logger
protected void	resetContentId(Handle handle)
protected void	resetGlobalId(Handle handle)
ArtifactSearchResultsDto	searchArtifacts(Set<SearchFilter> filters, OrderBy orderBy, OrderDirection orderDirection, int offset, int limit)	Search artifacts by given criteria
VersionSearchResultsDto	searchVersions(String groupId, String artifactId, int offset, int limit)	Fetch the versions of the given artifact
void	setLogConfiguration(LogConfigurationDto logConfiguration)	Persists the given log configuration
protected SqlStatements	sqlStatements()
String	storageName()	The storage name
boolean	supportsMultiTenancy()	Returns true if the storage implementation supports multitenancy.
protected TenantContext	tenantContext()
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.
protected ArtifactMetaDataDto	updateArtifact(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, GlobalIdGenerator globalIdGenerator)
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.
void	updateArtifactVersionMetaData(String groupId, String artifactId, String version, EditableArtifactMetaDataDto metaData)	Updates the user-editable meta-data for a single version of a given artifact.
protected ArtifactMetaDataDto	updateArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, long contentId, String createdBy, Date createdOn, EditableArtifactMetaDataDto metaData, GlobalIdGenerator globalIdGenerator)
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.
protected ArtifactMetaDataDto	updateArtifactWithMetadata(String groupId, String artifactId, String version, ArtifactType artifactType, ContentHandle content, EditableArtifactMetaDataDto metaData, GlobalIdGenerator globalIdGenerator)
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.
void	updateRoleMapping(String principalId, String role)	Updates a single role mapping.

Methods inherited from class io.apicurio.registry.storage.impl.AbstractRegistryStorage

isAlive, isReady

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSqlRegistryStorage

public AbstractSqlRegistryStorage()

Constructor.

Method Detail

tenantContext

protected TenantContext tenantContext()

sqlStatements

protected SqlStatements sqlStatements()

initialize

@PostConstruct
protected void initialize()

storageName

public String storageName()

Description copied from interface: RegistryStorage

The storage name

See Also:

RegistryStorage.storageName()

supportsMultiTenancy

public boolean supportsMultiTenancy()

Description copied from interface: RegistryStorage

Returns true if the storage implementation supports multitenancy. If the storage supports multitenancy, it will get the tenant information from the TenantContext

Returns:

if multitenancy is supported

See Also:

RegistryStorage.supportsMultiTenancy()

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.

Throws:

ContentNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactByContentId(long)

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.

Throws:

ContentNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactByContentHash(java.lang.String)

getArtifactVersionsByContentId

public List<ArtifactMetaDataDto> getArtifactVersionsByContentId(long contentId)

Description copied from interface: RegistryStorage

Get artifact metadata for a given contentId

Returns:

See Also:

RegistryStorage.getArtifactByContentId(long)

updateArtifactState

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

Description copied from interface: RegistryStorage

Update artifact state.

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.

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.

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)

createArtifact

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

Throws:

ArtifactAlreadyExistsException

RegistryStorageException

createOrUpdateContent

protected Long createOrUpdateContent(Handle handle,
                                     ArtifactType artifactType,
                                     ContentHandle content)

Store the content in the database and return the ID of the new row. If the content already exists, just return the content ID of the existing row.

Parameters:

handle -

artifactType -

content -

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.

Parameters:

groupId - (optional)

version - (optional)

Throws:

ArtifactAlreadyExistsException

RegistryStorageException

See Also:

RegistryStorage.createArtifactWithMetadata(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)

createArtifactWithMetadata

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

Throws:

ArtifactAlreadyExistsException

RegistryStorageException

createArtifactWithMetadata

protected ArtifactMetaDataDto createArtifactWithMetadata(String groupId,
                                                         String artifactId,
                                                         String version,
                                                         ArtifactType artifactType,
                                                         long contentId,
                                                         String createdBy,
                                                         Date createdOn,
                                                         EditableArtifactMetaDataDto metaData,
                                                         GlobalIdGenerator globalIdGenerator)

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.

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.

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.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

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

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.

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)

updateArtifact

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

Throws:

ArtifactNotFoundException

RegistryStorageException

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.

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)

updateArtifactWithMetadata

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

Throws:

ArtifactNotFoundException

RegistryStorageException

updateArtifactWithMetadata

protected ArtifactMetaDataDto updateArtifactWithMetadata(String groupId,
                                                         String artifactId,
                                                         String version,
                                                         ArtifactType artifactType,
                                                         long contentId,
                                                         String createdBy,
                                                         Date createdOn,
                                                         EditableArtifactMetaDataDto metaData,
                                                         GlobalIdGenerator globalIdGenerator)
                                                  throws ArtifactNotFoundException,
                                                         RegistryStorageException

Throws:

ArtifactNotFoundException

RegistryStorageException

getArtifactIds

public Set<String> getArtifactIds(Integer limit)

Description copied from interface: RegistryStorage

Get all artifact ids. --- Note: This should only be used in older APIs such as the registry V1 REST API and the Confluent API ---

Parameters:

limit - the limit of artifacts

Returns:

all artifact ids

See Also:

RegistryStorage.getArtifactIds(java.lang.Integer)

searchArtifacts

public ArtifactSearchResultsDto searchArtifacts(Set<SearchFilter> filters,
                                                OrderBy orderBy,
                                                OrderDirection orderDirection,
                                                int offset,
                                                int limit)

Description copied from interface: RegistryStorage

Search artifacts by given criteria

Parameters:

filters - the set of filters to apply when searching

orderBy - the field to order by

orderDirection - the direction to order the results

offset - the number of artifacts to skip

limit - the result size limit

See Also:

RegistryStorage.searchArtifacts(java.util.Set, io.apicurio.registry.storage.dto.OrderBy, io.apicurio.registry.storage.dto.OrderDirection, int, int)

getArtifactMetaData

public ArtifactMetaDataDto getArtifactMetaData(String groupId,
                                               String artifactId)
                                        throws ArtifactNotFoundException,
                                               RegistryStorageException

Description copied from interface: RegistryStorage

Gets the stored meta-data for an artifact by group and ID. This will include client-editable meta-data such as name and description, but also generated meta-data such as "modifedOn" and "globalId".

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

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

getArtifactVersionMetaData

public ArtifactVersionMetaDataDto getArtifactVersionMetaData(String groupId,
                                                             String artifactId,
                                                             boolean canonical,
                                                             ContentHandle content)
                                                      throws ArtifactNotFoundException,
                                                             RegistryStorageException

Description copied from interface: RegistryStorage

Gets the metadata of the version that matches content.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactVersionMetaData(java.lang.String, java.lang.String, boolean, io.apicurio.registry.content.ContentHandle)

getArtifactMetaData

public ArtifactMetaDataDto getArtifactMetaData(long globalId)
                                        throws ArtifactNotFoundException,
                                               RegistryStorageException

Description copied from interface: RegistryStorage

Gets the stored meta-data for an artifact by global ID. This will include client-editable meta-data such as name and description, but also generated meta-data such as "modifedOn" and "globalId".

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactMetaData(long)

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?

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.

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.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleAlreadyExistsException

RegistryStorageException

See Also:

RegistryStorage.createArtifactRule(java.lang.String, java.lang.String, io.apicurio.registry.types.RuleType, io.apicurio.registry.storage.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.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

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

getArtifactRule

public RuleConfigurationDto getArtifactRule(String groupId,
                                            String artifactId,
                                            RuleType rule)
                                     throws ArtifactNotFoundException,
                                            RuleNotFoundException,
                                            RegistryStorageException

Description copied from interface: RegistryStorage

Gets all of the information for a single rule configured on a given artifact.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleNotFoundException

RegistryStorageException

See Also:

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

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.

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.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RuleNotFoundException

RegistryStorageException

See Also:

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

getArtifactVersions

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

Description copied from interface: RegistryStorage

Gets a sorted set of all artifact versions that exist for a given artifact.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

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

searchVersions

public VersionSearchResultsDto searchVersions(String groupId,
                                              String artifactId,
                                              int offset,
                                              int limit)

Description copied from interface: RegistryStorage

Fetch the versions of the given artifact

Parameters:

groupId - (optional)

artifactId - the artifact used to fetch versions

offset - the number of versions to skip

limit - the result size limit

Returns:

the artifact versions, limited

See Also:

RegistryStorage.searchVersions(java.lang.String, java.lang.String, int, int)

getArtifactVersion

public StoredArtifactDto getArtifactVersion(long globalId)
                                     throws ArtifactNotFoundException,
                                            RegistryStorageException

Description copied from interface: RegistryStorage

Gets the stored artifact content for the artifact version with the given unique global ID.

Throws:

ArtifactNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getArtifactVersion(long)

getArtifactVersion

public StoredArtifactDto getArtifactVersion(String groupId,
                                            String artifactId,
                                            String version)
                                     throws ArtifactNotFoundException,
                                            VersionNotFoundException,
                                            RegistryStorageException

Description copied from interface: RegistryStorage

Gets the stored value for a single version of a given artifact.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

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

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.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

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

getArtifactVersionMetaData

public ArtifactVersionMetaDataDto getArtifactVersionMetaData(String groupId,
                                                             String artifactId,
                                                             String version)
                                                      throws ArtifactNotFoundException,
                                                             VersionNotFoundException,
                                                             RegistryStorageException

Description copied from interface: RegistryStorage

Gets the stored meta-data for a single version of an artifact. This will return all meta-data for the version, including any user edited meta-data along with anything generated by the artifactStore.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

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

updateArtifactVersionMetaData

public void updateArtifactVersionMetaData(String groupId,
                                          String artifactId,
                                          String version,
                                          EditableArtifactMetaDataDto metaData)
                                   throws ArtifactNotFoundException,
                                          VersionNotFoundException,
                                          RegistryStorageException

Description copied from interface: RegistryStorage

Updates the user-editable meta-data for a single version of a given artifact. Only the client-editable meta-data can be updated. Client editable meta-data includes e.g. name and description.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

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

deleteArtifactVersionMetaData

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

Description copied from interface: RegistryStorage

Deletes the user-editable meta-data for a singel version of a given artifact. Only the client-editable meta-data is deleted. Any meta-data generated by the artifactStore is preserved.

Parameters:

groupId - (optional)

Throws:

ArtifactNotFoundException

VersionNotFoundException

RegistryStorageException

See Also:

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

getGlobalRules

public List<RuleType> getGlobalRules()
                              throws RegistryStorageException

Description copied from interface: RegistryStorage

Gets a list of all global rule names.

Throws:

RegistryStorageException

See Also:

RegistryStorage.getGlobalRules()

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.

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.

Throws:

RegistryStorageException

See Also:

RegistryStorage.deleteGlobalRules()

getGlobalRule

public RuleConfigurationDto getGlobalRule(RuleType rule)
                                   throws RuleNotFoundException,
                                          RegistryStorageException

Description copied from interface: RegistryStorage

Gets all information about a single global rule.

Throws:

RuleNotFoundException

RegistryStorageException

See Also:

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

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.

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.

Throws:

RuleNotFoundException

RegistryStorageException

See Also:

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

getLogConfiguration

public LogConfigurationDto getLogConfiguration(String logger)
                                        throws RegistryStorageException,
                                               LogConfigurationNotFoundException

Description copied from interface: RegistryStorage

Returns the log configuration persisted in the storage for the given logger

Throws:

RegistryStorageException

LogConfigurationNotFoundException

See Also:

RegistryStorage.getLogConfiguration(java.lang.String)

setLogConfiguration

public void setLogConfiguration(LogConfigurationDto logConfiguration)
                         throws RegistryStorageException

Description copied from interface: RegistryStorage

Persists the given log configuration

Throws:

RegistryStorageException

See Also:

RegistryStorage.setLogConfiguration(io.apicurio.registry.storage.dto.LogConfigurationDto)

removeLogConfiguration

public void removeLogConfiguration(String logger)
                            throws RegistryStorageException,
                                   LogConfigurationNotFoundException

Description copied from interface: RegistryStorage

Removes the persisted log configuration for the given logger

Throws:

RegistryStorageException

LogConfigurationNotFoundException

See Also:

RegistryStorage.removeLogConfiguration(java.lang.String)

listLogConfigurations

public List<LogConfigurationDto> listLogConfigurations()
                                                throws RegistryStorageException

Description copied from interface: RegistryStorage

Returns the list of log configuration persisted in the storage

Throws:

RegistryStorageException

See Also:

RegistryStorage.listLogConfigurations()

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.

Throws:

GroupAlreadyExistsException

RegistryStorageException

See Also:

RegistryStorage.createGroup(io.apicurio.registry.storage.dto.GroupMetaDataDto)

updateGroupMetaData

public void updateGroupMetaData(GroupMetaDataDto group)
                         throws GroupNotFoundException,
                                RegistryStorageException

Description copied from interface: RegistryStorage

Updates the metadata of an existent group.

Throws:

RegistryStorageException

GroupNotFoundException

See Also:

RegistryStorage.updateGroupMetaData(io.apicurio.registry.storage.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

Parameters:

groupId - (optional)

Throws:

GroupNotFoundException

RegistryStorageException

See Also:

RegistryStorage.deleteGroup(java.lang.String)

getGroupIds

public List<String> getGroupIds(Integer limit)
                         throws RegistryStorageException

Description copied from interface: RegistryStorage

Get all groupIds

Throws:

RegistryStorageException

See Also:

RegistryStorage.getGroupIds(java.lang.Integer)

getGroupMetaData

public GroupMetaDataDto getGroupMetaData(String groupId)
                                  throws GroupNotFoundException,
                                         RegistryStorageException

Description copied from interface: RegistryStorage

Get the metadata information for a group identified by the given groupId

Parameters:

groupId - (optional)

Throws:

GroupNotFoundException

RegistryStorageException

See Also:

RegistryStorage.getGroupMetaData(java.lang.String)

exportData

public void exportData(Function<Entity,Void> handler)
                throws RegistryStorageException

Description copied from interface: RegistryStorage

Called to export all data in the registry. Caller provides a handle to handle the data/entities. This should be used to stream the data from the storage to some output source (e.g. a HTTP response). It is important that the full dataset is *not* kept in memory.

Throws:

RegistryStorageException

See Also:

RegistryStorage.exportData(java.util.function.Function)

importData

public void importData(EntityInputStream entities)
                throws RegistryStorageException

Description copied from interface: RegistryStorage

Called to import previously exported data into the registry.

Throws:

RegistryStorageException

See Also:

RegistryStorage.importData(io.apicurio.registry.storage.impexp.EntityInputStream)

countArtifacts

public long countArtifacts()
                    throws RegistryStorageException

Description copied from interface: RegistryStorage

Counts the total number of artifacts

Returns:

artifacts count

Throws:

RegistryStorageException

See Also:

RegistryStorage.countArtifacts()

countArtifactVersions

public long countArtifactVersions(String groupId,
                                  String artifactId)
                           throws RegistryStorageException

Description copied from interface: RegistryStorage

Counts the total number of versions for one artifact

Returns:

Throws:

RegistryStorageException

See Also:

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

countTotalArtifactVersions

public long countTotalArtifactVersions()
                                throws RegistryStorageException

Description copied from interface: RegistryStorage

Counts the total number of versions for all artifacts

Returns:

Throws:

RegistryStorageException

See Also:

RegistryStorage.countTotalArtifactVersions()

createRoleMapping

public void createRoleMapping(String principalId,
                              String role,
                              String principalName)
                       throws RegistryStorageException

Description copied from interface: RegistryStorage

Creates a role mapping for a user.

Throws:

RegistryStorageException

See Also:

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

deleteRoleMapping

public void deleteRoleMapping(String principalId)
                       throws RegistryStorageException

Description copied from interface: RegistryStorage

Deletes a single role mapping.

Throws:

RegistryStorageException

See Also:

RegistryStorage.deleteRoleMapping(java.lang.String)

getRoleMapping

public RoleMappingDto getRoleMapping(String principalId)
                              throws RegistryStorageException

Description copied from interface: RegistryStorage

Gets the details of a single role mapping.

Throws:

RegistryStorageException

See Also:

RegistryStorage.getRoleMapping(java.lang.String)

getRoleForPrincipal

public String getRoleForPrincipal(String principalId)
                           throws RegistryStorageException

Description copied from interface: RegistryStorage

Gets the role for a single user. This returns null if there is no role mapped for the given principal.

Throws:

RegistryStorageException

See Also:

RegistryStorage.getRoleForPrincipal(java.lang.String)

getRoleMappings

public List<RoleMappingDto> getRoleMappings()
                                     throws RegistryStorageException

Description copied from interface: RegistryStorage

Gets the list of all the role mappings in the registry.

Throws:

RegistryStorageException

See Also:

RegistryStorage.getRoleMappings()

updateRoleMapping

public void updateRoleMapping(String principalId,
                              String role)
                       throws RegistryStorageException

Description copied from interface: RegistryStorage

Updates a single role mapping.

Throws:

RegistryStorageException

See Also:

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

createDownload

public String createDownload(DownloadContextDto context)
                      throws RegistryStorageException

Description copied from interface: RegistryStorage

Called to create a single-use download "link". This can then be consumed using "consumeDownload()". Used to support browser flows for features like /admin/export.

Throws:

RegistryStorageException

See Also:

RegistryStorage.createDownload(io.apicurio.registry.storage.dto.DownloadContextDto)

consumeDownload

public DownloadContextDto consumeDownload(String downloadId)
                                   throws RegistryStorageException

Description copied from interface: RegistryStorage

Called to consume a download from the DB (single-use) and return its context info.

Throws:

RegistryStorageException

See Also:

RegistryStorage.consumeDownload(java.lang.String)

deleteAllExpiredDownloads

public void deleteAllExpiredDownloads()
                               throws RegistryStorageException

Description copied from interface: RegistryStorage

Called to delete any expired rows in the downloads table. This is basically cleaning up any single-use download links that were never "clicked".

Throws:

RegistryStorageException

See Also:

RegistryStorage.deleteAllExpiredDownloads()

deleteAllUserData

public void deleteAllUserData()

Description copied from interface: RegistryStorage

Deletes ALL user (tenant) data. Does not delete global data, such as log configuration.

deleteAllOrphanedContent

protected void deleteAllOrphanedContent()

resetGlobalId

protected void resetGlobalId(Handle handle)

resetContentId

protected void resetContentId(Handle handle)

importEntity

protected void importEntity(Handle handle,
                            Entity entity)
                     throws RegistryStorageException

Throws:

RegistryStorageException

importArtifactRule

protected void importArtifactRule(Handle handle,
                                  ArtifactRuleEntity entity)

importArtifactVersion

protected void importArtifactVersion(Handle handle,
                                     ArtifactVersionEntity entity)

importContent

protected void importContent(Handle handle,
                             ContentEntity entity)

importGlobalRule

protected void importGlobalRule(Handle handle,
                                GlobalRuleEntity entity)

importGroup

protected void importGroup(Handle handle,
                           GroupEntity entity)

isArtifactExists

public boolean isArtifactExists(String groupId,
                                String artifactId)
                         throws RegistryStorageException

Throws:

RegistryStorageException

isContentExists

public boolean isContentExists(long contentId)
                        throws RegistryStorageException

Throws:

RegistryStorageException

isGlobalIdExists

protected boolean isGlobalIdExists(long globalId)
                            throws RegistryStorageException

Throws:

RegistryStorageException

canonicalizeContent

protected ContentHandle canonicalizeContent(ArtifactType artifactType,
                                            ContentHandle content)

Canonicalize the given content, returns the content unchanged in the case of an error.

Parameters:

artifactType -

content -

extractMetaData

protected EditableArtifactMetaDataDto extractMetaData(ArtifactType artifactType,
                                                      ContentHandle content)

nextContentId

protected long nextContentId(Handle handle)

nextGlobalId

protected long nextGlobalId(Handle handle)