Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector

Interface OMRSMetadataCollectionManager

All Known Implementing Classes:

EnterpriseOMRSRepositoryConnector, GraphOMRSRepositoryConnector, InMemoryOMRSRepositoryConnector, LocalOMRSRepositoryConnector, OMRSRepositoryConnector, OMRSRESTRepositoryConnector, ReadOnlyOMRSRepositoryConnector

public interface OMRSMetadataCollectionManager

OMRSRepositoryConnectors are used by OMRS to retrieve metadata from metadata repositories. Each implementation of the OMRSRepositoryConnector is for a different type of repository. This interface defines the extension that an OMRSRepositoryConnector must implement over the base connector definition. It describes the concept of a metadata collection. This is a collection of metadata that includes the type definitions (TypeDefs) and metadata instances (Entities and Relationships) stored in the repository.

Method Summary

Modifier and Type	Method	Description
int	getMaxPageSize()	Return the maximum page size
OMRSMetadataCollection	getMetadataCollection()	Returns the metadata collection object that provides an OMRS abstraction of the metadata within a metadata repository.
java.lang.String	getMetadataCollectionId()	Return the unique id for this metadata collection.
java.lang.String	getOrganizationName()	Return the name of the organization that runs/owns the server used to access the repository.
java.lang.String	getRepositoryName()	Return the name of the repository where the metadata collection resides.
java.lang.String	getServerName()	Return the name of the server where the metadata collection resides.
java.lang.String	getServerType()	Return the descriptive string describing the type of the server.
java.lang.String	getServerUserId()	Return the userId that the local server should use when processing events and there is no external user driving the operation.
void	setMaxPageSize(int maxPageSize)	Set up the maximum PageSize
void	setMetadataCollectionId(java.lang.String metadataCollectionId)	Set up the unique Id for this metadata collection.
void	setOrganizationName(java.lang.String organizationName)	Set up the name of the organization that runs/owns the server used to access the repository.
void	setRepositoryHelper(OMRSRepositoryHelper repositoryHelper)	Set up a repository helper object for the repository connector to use.
void	setRepositoryName(java.lang.String repositoryName)	Set up the name of the repository where the metadata collection resides.
void	setRepositoryValidator(OMRSRepositoryValidator repositoryValidator)	Set up a repository validator for the repository connector to use.
void	setServerName(java.lang.String serverName)	Set up the name of the server where the metadata collection resides.
void	setServerType(java.lang.String serverType)	Set up the descriptive string describing the type of the server.
void	setServerUserId(java.lang.String serverUserId)	Set up the userId that the local server should use when processing events and there is no external user driving the operation.

Method Detail

setRepositoryHelper

void setRepositoryHelper(OMRSRepositoryHelper repositoryHelper)

Set up a repository helper object for the repository connector to use.

Parameters:

repositoryHelper - helper object for building TypeDefs and metadata instances.

setRepositoryValidator

void setRepositoryValidator(OMRSRepositoryValidator repositoryValidator)

Set up a repository validator for the repository connector to use.

Parameters:

repositoryValidator - validator object to check the validity of TypeDefs and metadata instances.

getRepositoryName

java.lang.String getRepositoryName()

Return the name of the repository where the metadata collection resides.

Returns:

String name

setRepositoryName

void setRepositoryName(java.lang.String repositoryName)

Set up the name of the repository where the metadata collection resides.

Parameters:

repositoryName - String name

getServerName

java.lang.String getServerName()

Return the name of the server where the metadata collection resides.

Returns:

String name

setServerName

void setServerName(java.lang.String serverName)

Set up the name of the server where the metadata collection resides.

Parameters:

serverName - String name

getServerType

java.lang.String getServerType()

Return the descriptive string describing the type of the server. This might be the name of the product, or similar identifier.

Returns:

String name

setServerType

void setServerType(java.lang.String serverType)

Set up the descriptive string describing the type of the server. This might be the name of the product, or similar identifier.

Parameters:

serverType - String server type

getOrganizationName

java.lang.String getOrganizationName()

Return the name of the organization that runs/owns the server used to access the repository.

Returns:

String name

setOrganizationName

void setOrganizationName(java.lang.String organizationName)

Set up the name of the organization that runs/owns the server used to access the repository.

Parameters:

organizationName - String organization name

getServerUserId

java.lang.String getServerUserId()

Return the userId that the local server should use when processing events and there is no external user driving the operation.

Returns:

user id

setServerUserId

void setServerUserId(java.lang.String serverUserId)

Set up the userId that the local server should use when processing events and there is no external user driving the operation.

Parameters:

serverUserId - string user id

getMaxPageSize

int getMaxPageSize()

Return the maximum page size

Returns:

maximum number of elements that can be retrieved on a request.

setMaxPageSize

void setMaxPageSize(int maxPageSize)

Set up the maximum PageSize

Parameters:

maxPageSize - maximum number of elements that can be retrieved on a request.

getMetadataCollectionId

java.lang.String getMetadataCollectionId()

Return the unique id for this metadata collection.

Returns:

String unique id

setMetadataCollectionId

void setMetadataCollectionId(java.lang.String metadataCollectionId)

Set up the unique Id for this metadata collection.

Parameters:

metadataCollectionId - String unique id

getMetadataCollection

OMRSMetadataCollection getMetadataCollection()
                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Returns the metadata collection object that provides an OMRS abstraction of the metadata within a metadata repository.

Returns:

OMRSMetadataInstanceStore metadata TypeDefs and instances retrieved from the metadata repository.

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - no metadata collection