Package org.odpi.openmetadata.governanceservers.enginehostservices.admin

Class EngineServiceAdmin

java.lang.Object
org.odpi.openmetadata.governanceservers.enginehostservices.admin.EngineServiceAdmin
public abstract class EngineServiceAdmin extends Object
EngineServiceAdmin is the interface that an engine 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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.odpi.openmetadata.frameworks.auditlog.AuditLog
    auditLog
     
    protected org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler
    invalidParameterHandler
     
    protected String
    localServerName
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    EngineServiceAdmin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<org.odpi.openmetadata.adminservices.configuration.properties.EngineConfig>
    getEngines(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig)
    Retrieve the list of engine names for this engine service from the configuration.
    protected String
    getPartnerServiceRootURL(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServicesConfig)
    Return the open metadata server's root URL from the configuration.
    protected String
    getPartnerServiceServerName(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig)
    Return the open metadata server's name from the configuration.
    abstract Map<String,GovernanceEngineHandler>
    initialize(String localServerId, String localServerName, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String localServerUserId, String localServerPassword, int maxPageSize, org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineConfigurationClient configurationClient, org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineClient governanceActionClient, org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig)
    Initialize engine service.
    abstract void
    shutdown()
    Shutdown the engine service.
    protected void
    validateConfigDocument(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig)
    Validate the content of the configuration.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • localServerName

      protected String localServerName

    • auditLog

      protected org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog

    • invalidParameterHandler

      protected org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler

  • Constructor Details

    • EngineServiceAdmin

      public EngineServiceAdmin()

  • Method Details

    • initialize

      public abstract Map<String,GovernanceEngineHandler> initialize(String localServerId, String localServerName, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String localServerUserId, String localServerPassword, int maxPageSize, org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineConfigurationClient configurationClient, org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineClient governanceActionClient, org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Initialize engine service.
      Parameters:
      localServerId - unique identifier of this server
      localServerName - name of this server
      auditLog - link to the repository responsible for servicing the REST calls
      localServerUserId - user id for this server to use if sending REST requests and processing inbound messages
      localServerPassword - password for this server to use if sending REST requests
      maxPageSize - maximum number of records that can be requested on the pageSize parameter
      configurationClient - client used to connect to the Governance Engine OMAS to retrieve the governance engine definitions
      governanceActionClient - client used to connect to the Governance Engine OMAS to manage governance actions
      engineServiceConfig - details of the options and the engines to run
      Returns:
      map of governance engine names to handlers
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - an issue in the configuration prevented initialization

    • shutdown

      public abstract void shutdown()
      Shutdown the engine service.

    • getPartnerServiceRootURL

      protected String getPartnerServiceRootURL(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServicesConfig) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Return the open metadata server's root URL from the configuration.
      Parameters:
      engineServicesConfig - configuration
      Returns:
      root URL
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - No root URL present in the config

    • validateConfigDocument

      protected void validateConfigDocument(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Validate the content of the configuration.
      Parameters:
      engineServiceConfig - configuration
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - Missing content from the config

    • getPartnerServiceServerName

      protected String getPartnerServiceServerName(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Return the open metadata server's name from the configuration.
      Parameters:
      engineServiceConfig - configuration
      Returns:
      server name
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - No server name present in the config

    • getEngines

      protected List<org.odpi.openmetadata.adminservices.configuration.properties.EngineConfig> getEngines(org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig engineServiceConfig) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Retrieve the list of engine names for this engine service from the configuration.
      Parameters:
      engineServiceConfig - configuration
      Returns:
      list of engines
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - an issue in the configuration prevented initialization