Package org.odpi.openmetadata.platformservices.server.spring

Class OMAGServerOperationResource

java.lang.Object
org.odpi.openmetadata.platformservices.server.spring.OMAGServerOperationResource
@RestController @RequestMapping("/open-metadata/platform-services/users/{userId}/server-platform") public class OMAGServerOperationResource extends Object
OMAGServerOperationResource provides the REST API for controlling the start-up, management and shutdown of services in the OMAG Server.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OMAGServerOperationResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.serveroperations.rest.SuccessMessageResponse
    activateWithStoredConfig(String userId, String serverName)
    Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
    org.odpi.openmetadata.serveroperations.rest.SuccessMessageResponse
    activateWithSuppliedConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig configuration)
    Activate the open metadata and governance services using the supplied configuration document.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addOpenMetadataArchive(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Add a new open metadata archive to running repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addOpenMetadataArchiveFile(String userId, String serverName, String fileName)
    Add a new open metadata archive to running repository.
    org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse
    getActiveConfiguration(String userId, String serverName)
    Return the configuration used for the current active instance of the server.
    org.odpi.openmetadata.serveroperations.rest.OMAGServerStatusResponse
    getActiveServerStatus(String userId, String serverName)
    Return the status for the current active instance of the server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownAllServers(String userId)
    Temporarily shutdown all running servers.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownAndUnregisterAllServers(String userId)
    Shutdown any active servers and unregister them from any cohorts.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownAndUnregisterServer(String userId, String serverName)
    Permanently deactivate any active servers and unregister from any cohorts.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownPlatform(String userId)
    Shutdown the platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownServer(String userId, String serverName)
    Temporarily shutdown the named OMAG server.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OMAGServerOperationResource

      public OMAGServerOperationResource()

  • Method Details

    • activateWithStoredConfig

      @PostMapping(path="/servers/{serverName}/instance") public org.odpi.openmetadata.serveroperations.rest.SuccessMessageResponse activateWithStoredConfig(@PathVariable String userId, @PathVariable String serverName)
      Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this 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 server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • activateWithSuppliedConfig

      @PostMapping(path="/servers/{serverName}/instance/configuration") public org.odpi.openmetadata.serveroperations.rest.SuccessMessageResponse activateWithSuppliedConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig configuration)
      Activate the open metadata and governance services using the supplied configuration document.
      Parameters:
      userId - user that is issuing the request
      configuration - properties used to initialize the services
      serverName - local server name
      Returns:
      void 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.

    • shutdownServer

      @DeleteMapping(path="/servers/{serverName}/instance") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownServer(@PathVariable String userId, @PathVariable String serverName)
      Temporarily shutdown the named OMAG server. This server can be restarted as a later time.
      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.

    • shutdownAllServers

      @DeleteMapping(path="/servers/instance") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownAllServers(@PathVariable String userId)
      Temporarily shutdown 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.

    • shutdownAndUnregisterServer

      @DeleteMapping(path="/servers/{serverName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownAndUnregisterServer(@PathVariable String userId, @PathVariable String serverName)
      Permanently deactivate any active servers and unregister from any cohorts.
      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.

    • shutdownAndUnregisterAllServers

      @DeleteMapping(path="/servers") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownAndUnregisterAllServers(@PathVariable String userId)
      Shutdown any active servers and unregister them from any cohorts.
      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

      @DeleteMapping(path="/instance") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownPlatform(@PathVariable String userId)
      Shutdown the 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.

    • getActiveConfiguration

      @GetMapping(path="/servers/{serverName}/instance/configuration") public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse getActiveConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the configuration used for the current active instance of the server. Null is returned if the server instance is not running.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      Returns:
      configuration properties used to initialize the server or null if not running 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.

    • getActiveServerStatus

      @GetMapping(path="/servers/{serverName}/instance/status") public org.odpi.openmetadata.serveroperations.rest.OMAGServerStatusResponse getActiveServerStatus(@PathVariable String userId, @PathVariable String serverName)
      Return the status for the current active instance of the server. Null is returned if the server instance is not running.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      Returns:
      status of the server or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or not running or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • addOpenMetadataArchiveFile

      @PostMapping(path="/servers/{serverName}/instance/open-metadata-archives/file") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addOpenMetadataArchiveFile(@PathVariable String userId, @PathVariable String serverName, @RequestBody 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

      @PostMapping(path="/servers/{serverName}/instance/open-metadata-archives/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addOpenMetadataArchive(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.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 for the open metadata archive.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or connection parameter.