Class OMRSRepositoryConnector

    • Field Detail

      • repositoryName

        protected java.lang.String repositoryName
      • serverName

        protected java.lang.String serverName
      • serverType

        protected java.lang.String serverType
      • organizationName

        protected java.lang.String organizationName
      • serverUserId

        protected java.lang.String serverUserId
      • maxPageSize

        protected int maxPageSize
      • metadataCollectionId

        protected java.lang.String metadataCollectionId
      • metadataCollectionName

        protected java.lang.String metadataCollectionName
    • Constructor Detail

      • OMRSRepositoryConnector

        public OMRSRepositoryConnector()
        Default constructor nothing to do
    • Method Detail

      • setAuditLog

        public void setAuditLog​(AuditLog auditLog)
        Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.
        Specified by:
        setAuditLog in interface AuditLoggingComponent
        Parameters:
        auditLog - audit log object
      • setRepositoryHelper

        public void setRepositoryHelper​(OMRSRepositoryHelper repositoryHelper)
        Set up a repository helper object for the repository connector to use.
        Specified by:
        setRepositoryHelper in interface OMRSMetadataCollectionManager
        Parameters:
        repositoryHelper - helper object for building and querying TypeDefs and metadata instances.
      • getRepositoryHelper

        public OMRSRepositoryHelper getRepositoryHelper()
        Return the repository helper for this connector.
        Returns:
        helper object for building and querying TypeDefs and metadata instances.
      • getRepositoryValidator

        public OMRSRepositoryValidator getRepositoryValidator()
        Return the repository validator for this connector.
        Returns:
        validator object to check the validity of TypeDefs and metadata instances.
      • getRepositoryName

        public java.lang.String getRepositoryName()
        Return the name of the repository where the metadata collection resides.
        Specified by:
        getRepositoryName in interface OMRSMetadataCollectionManager
        Returns:
        String name
      • setRepositoryName

        public void setRepositoryName​(java.lang.String repositoryName)
        Set up the name of the repository where the metadata collection resides.
        Specified by:
        setRepositoryName in interface OMRSMetadataCollectionManager
        Parameters:
        repositoryName - String name
      • getServerName

        public java.lang.String getServerName()
        Return the name of the server where the metadata collection resides.
        Specified by:
        getServerName in interface OMRSMetadataCollectionManager
        Returns:
        String name
      • setServerName

        public void setServerName​(java.lang.String serverName)
        Set up the name of the server where the metadata collection resides.
        Specified by:
        setServerName in interface OMRSMetadataCollectionManager
        Parameters:
        serverName - String name
      • getServerType

        public 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.
        Specified by:
        getServerType in interface OMRSMetadataCollectionManager
        Returns:
        String name
      • setServerType

        public 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.
        Specified by:
        setServerType in interface OMRSMetadataCollectionManager
        Parameters:
        serverType - String server type
      • getOrganizationName

        public java.lang.String getOrganizationName()
        Return the name of the organization that runs/owns the server used to access the repository.
        Specified by:
        getOrganizationName in interface OMRSMetadataCollectionManager
        Returns:
        String name
      • setOrganizationName

        public void setOrganizationName​(java.lang.String organizationName)
        Set up the name of the organization that runs/owns the server used to access the repository.
        Specified by:
        setOrganizationName in interface OMRSMetadataCollectionManager
        Parameters:
        organizationName - String organization name
      • getServerUserId

        public 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.
        Specified by:
        getServerUserId in interface OMRSMetadataCollectionManager
        Returns:
        user id
      • setServerUserId

        public void setServerUserId​(java.lang.String localServerUserId)
        Set up the userId that the local server should use when processing events and there is no external user driving the operation.
        Specified by:
        setServerUserId in interface OMRSMetadataCollectionManager
        Parameters:
        localServerUserId - string user id
      • setMetadataCollectionId

        public void setMetadataCollectionId​(java.lang.String metadataCollectionId)
        Set up the unique Id for this metadata collection.
        Specified by:
        setMetadataCollectionId in interface OMRSMetadataCollectionManager
        Parameters:
        metadataCollectionId - String unique Id
      • getMetadataCollectionName

        public java.lang.String getMetadataCollectionName()
        Return the metadata collection name of this repository connector. It defaults to the server name if not set up explicitly.
        Returns:
        display name of the metadata collection.
      • setMetadataCollectionName

        public void setMetadataCollectionName​(java.lang.String metadataCollectionName)
        Explicitly set up the metadata collection name.
        Parameters:
        metadataCollectionName - display name of the metadata collection.
      • getMaxPageSize

        public int getMaxPageSize()
        Return the maximum PageSize
        Specified by:
        getMaxPageSize in interface OMRSMetadataCollectionManager
        Returns:
        maximum number of elements that can be retrieved on a request.
      • setMaxPageSize

        public void setMaxPageSize​(int maxPageSize)
        Set up the maximum PageSize
        Specified by:
        setMaxPageSize in interface OMRSMetadataCollectionManager
        Parameters:
        maxPageSize - maximum number of elements that can be retrieved on a request.
      • validateRepositoryIsActive

        public void validateRepositoryIsActive​(java.lang.String methodName)
                                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Throw a RepositoryErrorException if the connector is not active.
        Parameters:
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - repository connector has not started or has been disconnected.
      • getMetadataCollection

        public 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.
        Specified by:
        getMetadataCollection in interface OMRSMetadataCollectionManager
        Returns:
        OMRSMetadataInstanceStore metadata information retrieved from the metadata repository.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - no metadata collection