Package org.odpi.openmetadata.governanceservers.enginehostservices.server

Class EngineHostOperationalServices

java.lang.Object
org.odpi.openmetadata.governanceservers.enginehostservices.server.EngineHostOperationalServices
public class EngineHostOperationalServices extends Object
EngineHostOperationalServices is responsible for controlling the startup and shutdown of the engine host services.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EngineHostOperationalServices(String localServerName, String localServerId, String localServerUserId, String localServerPassword, int maxPageSize)
    Constructor used at server startup.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.serveroperations.properties.OMAGServerServiceStatus>
    getServiceStatuses()
    Return a summary of the status of this server and the services within it.
    List<String>
    initialize(org.odpi.openmetadata.adminservices.configuration.properties.EngineHostServicesConfig configuration, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Initialize the service.
    void
    terminate()
    Shutdown the service.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EngineHostOperationalServices

      public EngineHostOperationalServices(String localServerName, String localServerId, String localServerUserId, String localServerPassword, int maxPageSize)
      Constructor used at server startup.
      Parameters:
      localServerName - name of the local server
      localServerId - unique identifier for this server
      localServerUserId - user id for this server to use on REST calls if processing inbound messages.
      localServerPassword - user password for this server to use on REST calls if processing inbound messages.
      maxPageSize - maximum number of records that can be requested on the pageSize parameter

  • Method Details

    • initialize

      public List<String> initialize(org.odpi.openmetadata.adminservices.configuration.properties.EngineHostServicesConfig configuration, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Initialize the service.
      Parameters:
      configuration - config properties
      auditLog - destination for audit log messages.
      Returns:
      activated services list
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - error in configuration preventing startup

    • getServiceStatuses

      public List<org.odpi.openmetadata.serveroperations.properties.OMAGServerServiceStatus> getServiceStatuses()
      Return a summary of the status of this server and the services within it.
      Returns:
      server status

    • terminate

      public void terminate()
      Shutdown the service.