Package org.odpi.openmetadata.adminservices.registration

Class AccessServiceAdmin

java.lang.Object
org.odpi.openmetadata.adminservices.registration.AccessServiceAdmin
public abstract class AccessServiceAdmin extends Object
AccessServiceAdmin is the interface that an access service implements to receive its configuration. The java class that implements this interface is created with a default constructor and then the initialize method is called. It is configured in the AccessServiceDescription enumeration.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AccessServiceAdmin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFullServiceName()
    Return the cached service name.
    <T> T
    getTopicConnector(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection topicConnection, Class<T> topicConnectorClass, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String accessServiceFullName, String methodName)
    Create an instance of an open metadata topic connector using the supplied connection.
    void
    initialize(org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig accessServiceConfigurationProperties, org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicConnector enterpriseOMRSTopicConnector, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String serverUserName)
    Initialize the access service.
    void
    initialize(org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig accessServiceConfigurationProperties, org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicConnector enterpriseOMRSTopicConnector, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditLog auditLog, String serverUserName)
    Deprecated.
    void
    setFullServiceName(String fullServiceName)
    Set up the cached service name.
    abstract void
    shutdown()
    Shutdown the access service.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AccessServiceAdmin

      public AccessServiceAdmin()

  • Method Details

    • initialize

      @Deprecated public void initialize(org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig accessServiceConfigurationProperties, org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicConnector enterpriseOMRSTopicConnector, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditLog auditLog, String serverUserName) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Deprecated.
      Initialize the access service.
      Parameters:
      accessServiceConfigurationProperties - specific configuration properties for this access service.
      enterpriseOMRSTopicConnector - connector for receiving OMRS Events from the cohorts
      enterpriseOMRSRepositoryConnector - connector for querying the cohort repositories
      auditLog - audit log component for logging messages.
      serverUserName - user id to use on OMRS calls where there is no end user.
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - invalid parameters in the configuration properties.

    • initialize

      public void initialize(org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig accessServiceConfigurationProperties, org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicConnector enterpriseOMRSTopicConnector, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnector enterpriseOMRSRepositoryConnector, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String serverUserName) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Initialize the access service.
      Parameters:
      accessServiceConfigurationProperties - specific configuration properties for this access service.
      enterpriseOMRSTopicConnector - connector for receiving OMRS Events from the cohorts
      enterpriseOMRSRepositoryConnector - connector for querying the cohort repositories
      auditLog - audit log component for logging messages.
      serverUserName - user id to use on OMRS calls where there is no end user.
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - invalid parameters in the configuration properties.

    • getFullServiceName

      public String getFullServiceName()
      Return the cached service name.
      Returns:
      string name

    • setFullServiceName

      public void setFullServiceName(String fullServiceName)
      Set up the cached service name.
      Parameters:
      fullServiceName - string name

    • shutdown

      public abstract void shutdown()
      Shutdown the access service.

    • getTopicConnector

      public <T> T getTopicConnector(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection topicConnection, Class<T> topicConnectorClass, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String accessServiceFullName, String methodName) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Create an instance of an open metadata topic connector using the supplied connection.
      Type Parameters:
      T - type name
      Parameters:
      topicConnection - connection needed to create the connector
      topicConnectorClass - class to cast to
      accessServiceFullName - name of the calling access service
      auditLog - audit log for this connector
      methodName - calling method
      Returns:
      connector to access the topic
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - problem creating connector