Package org.odpi.openmetadata.serveroperations.server

Class OMAGOperationalServicesInstance

java.lang.Object
org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance
org.odpi.openmetadata.serveroperations.server.OMAGOperationalServicesInstance
public class OMAGOperationalServicesInstance extends org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance
OMAGOperationalServicesInstance provides the references to the active services for an instance of an OMAG Server.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getActiveServiceListForServer()
    Return the list of services that are active in the server.
    List<org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin>
    getOperationalViewServerGenericServiceAdminList()
    Return the list of references to the admin object for each active Open Metadata View Service (OMVS).
    org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus
    getServerStatus()
    Return a summary of the status of this server and the services within it.
    void
    setOperationalViewServerGenericServiceAdminList(List<org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin> operationalViewServerGenericServiceAdminList)
    Set up the list of references to the admin object for each active Open Metadata View Service (OMVS).
    void
    setServerActiveStatus(org.odpi.openmetadata.serveroperations.properties.ServerActiveStatus serverActiveStatus)
    Set the status of the server.
    void
    setServerServiceActiveStatus(String serviceName, org.odpi.openmetadata.serveroperations.properties.ServerActiveStatus activeStatus)
    Set the status of a particular service.

    Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

    getInvalidParameterHandler, getServerName, getServiceInstanceStatus, getServiceName, setMaxPageSize, setSecurityVerifier, setServiceInstanceStatus, shutdown

    Methods inherited from class java.lang.Object

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

  • Method Details

    • setServerActiveStatus

      public void setServerActiveStatus(org.odpi.openmetadata.serveroperations.properties.ServerActiveStatus serverActiveStatus)
      Set the status of the server.
      Parameters:
      serverActiveStatus - new status

    • setServerServiceActiveStatus

      public void setServerServiceActiveStatus(String serviceName, org.odpi.openmetadata.serveroperations.properties.ServerActiveStatus activeStatus)
      Set the status of a particular service.
      Parameters:
      serviceName - name of service
      activeStatus - new status

    • getServerStatus

      public org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus getServerStatus()
      Return a summary of the status of this server and the services within it.
      Returns:
      server status

    • getActiveServiceListForServer

      public List<String> getActiveServiceListForServer()
      Return the list of services that are active in the server.
      Returns:
      list of services names

    • getOperationalViewServerGenericServiceAdminList

      public List<org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin> getOperationalViewServerGenericServiceAdminList()
      Return the list of references to the admin object for each active Open Metadata View Service (OMVS).
      Returns:
      list of ViewServiceAdmin objects

    • setOperationalViewServerGenericServiceAdminList

      public void setOperationalViewServerGenericServiceAdminList(List<org.odpi.openmetadata.adminservices.registration.ViewServerGenericServiceAdmin> operationalViewServerGenericServiceAdminList)
      Set up the list of references to the admin object for each active Open Metadata View Service (OMVS).
      Parameters:
      operationalViewServerGenericServiceAdminList - list of ViewServiceAdmin objects