Package org.odpi.openmetadata.adminservices.server

Class OMAGServerOperationalServices

  • public class OMAGServerOperationalServices
extends Object
    OMAGServerOperationalServices will provide support to start, manage and stop services in the OMAG Server.

    • Constructor Detail

      • OMAGServerOperationalServices

        public OMAGServerOperationalServices()

    • Method Detail

      • activateServerListWithStoredConfig

        public SuccessMessageResponse activateServerListWithStoredConfig​(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 serverName)
        Activate the open metadata and governance services using the stored configuration information.
        Parameters:
        userId - user that is issuing the 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 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
        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.

      • deactivateTemporarilyServerList

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

      • deactivateTemporarily

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

      • deactivatePermanently

        public VoidResponse deactivatePermanently​(String userId,
                                          String serverName)
        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
        serverName - local server name
        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 userId,
                                                       String serverName)
        Return the complete set of configuration properties in use by the server.
        Parameters:
        userId - user that is issuing the request
        serverName - local server name
        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 runing.

      • getActiveServerStatus

        public OMAGServerStatusResponse getActiveServerStatus​(String userId,
                                                      String serverName)
        Return the status of the server and it services within.
        Parameters:
        userId - user that is issuing the request
        serverName - local server name
        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.

      • addOpenMetadataArchiveFile

        public VoidResponse addOpenMetadataArchiveFile​(String userId,
                                               String serverName,
                                               String fileName)
        Add a new open metadata archive to running repository.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        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 userId,
                                           String serverName,
                                           Connection connection)
        Add a new open metadata archive to running repository.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        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.