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

Interface OMRSMetadataCollectionManager

All Known Subinterfaces:
OMRSLocalRepository
All Known Implementing Classes:
EnterpriseOMRSRepositoryConnector, GraphOMRSRepositoryConnector, InMemoryOMRSRepositoryConnector, LocalOMRSRepositoryConnector, OMRSRepositoryConnector, OMRSRESTRepositoryConnector, PostgresOMRSRepositoryConnector, ReadOnlyOMRSRepositoryConnector, XTDBOMRSRepositoryConnector
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 Details

    • 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

      String getRepositoryName()
      Return the name of the repository where the metadata collection resides.
      Returns:
      String name

    • setRepositoryName

      void setRepositoryName(String repositoryName)
      Set up the name of the repository where the metadata collection resides.
      Parameters:
      repositoryName - String name

    • getServerName

      String getServerName()
      Return the name of the server where the metadata collection resides.
      Returns:
      String name

    • setServerName

      void setServerName(String serverName)
      Set up the name of the server where the metadata collection resides.
      Parameters:
      serverName - String name

    • getServerType

      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(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

      String getOrganizationName()
      Return the name of the organization that runs/owns the server used to access the repository.
      Returns:
      String name

    • setOrganizationName

      void setOrganizationName(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

      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(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

      String getMetadataCollectionId()
      Return the unique id for this metadata collection.
      Returns:
      String unique id

    • setMetadataCollectionId

      void setMetadataCollectionId(String metadataCollectionId)
      Set up the unique Id for this metadata collection.
      Parameters:
      metadataCollectionId - String unique id

    • getMetadataCollection

      OMRSMetadataCollection getMetadataCollection() throws 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:
      RepositoryErrorException - no metadata collection