Package org.odpi.openmetadata.serveroperations.server

Class OMAGServerOperationalServices

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

  • Constructor Details

    • OMAGServerOperationalServices

      public OMAGServerOperationalServices()

  • Method Details

    • activateAutoStartServerListWithStoredConfig

      public SuccessMessageResponse activateAutoStartServerListWithStoredConfig(String userId, List<String> serverNames)
      Activate the list of open metadata and governance servers using the stored configuration information. The code works through the list, starting each server in turn. It stops if one of the servers fails to start and returns the error. Otherwise, it continues through the list, returning the successful start-up messages.
      Parameters:
      userId - user that is issuing the request
      serverNames - list of server names
      Returns:
      success message or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • activateWithStoredConfig

      public SuccessMessageResponse activateWithStoredConfig(String userId, String delegatingUserId, String serverName)
      Activate the open metadata and governance services using the stored configuration information.
      Parameters:
      userId - user that is issuing the request
      delegatingUserId - external userId making request
      serverName - local server name
      Returns:
      success message response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • activateWithStoredConfig

      public SuccessMessageResponse activateWithStoredConfig(String serverName, String delegatingUserId)
      Activate the open metadata and governance services using the stored configuration information.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      success message response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • activateWithSuppliedConfig

      public SuccessMessageResponse activateWithSuppliedConfig(String serverName, String delegatingUserId, OMAGServerConfig configuration)
      Activate the open metadata and governance services using the supplied configuration document. Inside the configuration document are sections that each relate to an open metadata and governance subsystem. This method reads the configuration document, starting up each requested subsystem. If any subsystem throws an exception, the whole start up process is halted and the exception is returned to the caller.
      Parameters:
      configuration - properties used to initialize the services
      delegatingUserId - external userId making request
      serverName - local server name
      Returns:
      success message response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • activateWithSuppliedConfig

      public SuccessMessageResponse activateWithSuppliedConfig(String userId, String delegatingUserId, String serverName, OMAGServerConfig configuration)
      Activate the open metadata and governance services using the supplied configuration document. Inside the configuration document are sections that each relate to an open metadata and governance subsystem. This method reads the configuration document, starting up each requested subsystem. If any subsystem throws an exception, the whole start up process is halted and the exception is returned to the caller.
      Parameters:
      userId - user that is issuing the request
      delegatingUserId - external userId making request
      configuration - properties used to initialize the services
      serverName - local server name
      Returns:
      success message response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • deactivateRunningServiceInstances

      public void deactivateRunningServiceInstances(String userId, String serverName, String methodName, OMAGOperationalServicesInstance instance, boolean permanentDeactivation) throws InvalidParameterException, PropertyServerException
      Shutdown any running services for a specific server instance. Note that authorization checks have already occurred.
      Parameters:
      userId - calling user
      serverName - name of this server
      methodName - calling method
      instance - a list of the running services
      permanentDeactivation - should the server be permanently disconnected
      Throws:
      InvalidParameterException - one of the services detected an invalid parameter
      PropertyServerException - one of the services had problems shutting down

    • deactivateTemporarilyServerList

      public void deactivateTemporarilyServerList(List<String> serverNames, String delegatingUserId)
      Temporarily deactivate the open metadata and governance servers in th supplied list.
      Parameters:
      serverNames - list of server names
      delegatingUserId - external userId making request

    • shutdownServer

      public VoidResponse shutdownServer(String serverName, String delegatingUserId)
      Temporarily deactivate any open metadata and governance services for the requested server.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • shutdownAndUnregisterServer

      public VoidResponse shutdownAndUnregisterServer(String serverName, String delegatingUserId)
      Terminate any running open metadata and governance services, remove the server from any open metadata cohorts.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • getActiveConfiguration

      public OMAGServerConfigResponse getActiveConfiguration(String serverName, String delegatingUserId)
      Return the complete set of configuration properties in use by the server.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      OMAGServerConfig properties or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or the server is not running.

    • getActiveServerStatus

      public OMAGServerStatusResponse getActiveServerStatus(String serverName, String delegatingUserId)
      Return the status of the server along with it services within.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      OMAGServerConfig properties or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or the server is not running.

    • getActiveServices

      public ServerServicesListResponse getActiveServices(String serverName, String delegatingUserId)
      Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.
      Parameters:
      serverName - name of the server of interest
      delegatingUserId - external userId making request
      Returns:
      List of service names

    • addOpenMetadataArchiveFile

      public VoidResponse addOpenMetadataArchiveFile(String serverName, String delegatingUserId, String fileName)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      fileName - name of the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or fileName parameter.

    • addOpenMetadataArchive

      public VoidResponse addOpenMetadataArchive(String serverName, String delegatingUserId, Connection connection)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      connection - connection to access the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or connection parameter.

    • addOpenMetadataArchive

      public VoidResponse addOpenMetadataArchive(String serverName, String delegatingUserId, OpenMetadataArchive openMetadataArchive)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      openMetadataArchive - contents of the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or openMetadataArchive parameter.