Package org.odpi.openmetadata.platformservices.server

Class OMAGServerPlatformOperationalServices

java.lang.Object
org.odpi.openmetadata.platformservices.server.OMAGServerPlatformOperationalServices
public class OMAGServerPlatformOperationalServices extends Object
OMAGServerPlatformOperationalServices will provide support to start, manage and stop services in the OMAG Server.

  • Constructor Details

    • OMAGServerPlatformOperationalServices

      public OMAGServerPlatformOperationalServices()

  • Method Details

    • shutdownAllServers

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownAllServers(String userId)
      Temporarily deactivate any open metadata and governance services for all running servers.
      Parameters:
      userId - user that is issuing the request
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • shutdownAndUnregisterAllServers

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownAndUnregisterAllServers(String userId)
      Terminate any running open metadata and governance services, remove the server from any open metadata cohorts and delete the server's configuration.
      Parameters:
      userId - user that is issuing the request
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • shutdownPlatform

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownPlatform(String userId)
      Terminate this platform.
      Parameters:
      userId - user that is issuing the request
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.