Class RepositoryGovernanceService

    • Field Detail

      • repositoryGovernanceServiceName

        protected java.lang.String repositoryGovernanceServiceName
      • embeddedConnectors

        protected java.util.List<Connector> embeddedConnectors
    • Constructor Detail

      • RepositoryGovernanceService

        public RepositoryGovernanceService()
    • 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
      • initializeEmbeddedConnectors

        public void initializeEmbeddedConnectors​(java.util.List<Connector> embeddedConnectors)
        Set up the list of connectors that this virtual connector will use to support its interface. The connectors are initialized waiting to start. When start() is called on the virtual connector, it needs to pass start() to each of the embedded connectors. Similarly for disconnect().
        Specified by:
        initializeEmbeddedConnectors in interface VirtualConnectorExtension
        Parameters:
        embeddedConnectors - list of connectors
      • setRepositoryGovernanceContext

        public void setRepositoryGovernanceContext​(RepositoryGovernanceContext repositoryGovernanceContext)
        Set up access to the open metadata ecosystem.
        Parameters:
        repositoryGovernanceContext - interface to the enterprise repository services and the ability to register a listener to the enterprise OMRS topic.
      • setRepositoryGovernanceServiceName

        public void setRepositoryGovernanceServiceName​(java.lang.String archiveServiceName)
        Set up the archive service name. This is used in error messages.
        Parameters:
        archiveServiceName - name of the archive service
      • getRepositoryGovernanceContext

        public RepositoryGovernanceContext getRepositoryGovernanceContext()
        Return the archive context for this archive service. This is typically called after the disconnect() method is called. If called before disconnect(), it may only contain partial results.
        Returns:
        archive context containing the results discovered (so far) by the archive service.
      • start

        public void start()
                   throws ConnectorCheckedException
        Indicates that the archive service is completely configured and can begin processing. Any embedded connectors are started. This is the method where the function of the archive service is implemented in the subclass. This is a standard method from the Open Connector Framework (OCF) so be sure to call super.start() in your version.
        Overrides:
        start in class ConnectorBase
        Throws:
        ConnectorCheckedException - there is a problem within the archive service.
      • handleUnexpectedException

        protected void handleUnexpectedException​(java.lang.String methodName,
                                                 java.lang.Exception error)
                                          throws ConnectorCheckedException
        Provide a common exception for unexpected errors.
        Parameters:
        methodName - calling method
        error - caught exception
        Throws:
        ConnectorCheckedException - wrapped exception
      • validateContext

        protected void validateContext​(RepositoryGovernanceContext governanceContext)
                                throws ConnectorCheckedException
        Verify that the context has been set up for the subclass
        Parameters:
        governanceContext - context from the subclass
        Throws:
        ConnectorCheckedException - error to say that the connector (governance action service) is not able to proceed because it has not been set up correctly.