Package org.odpi.openmetadata.serveroperations.server.spring

Class OMAGServerResource

java.lang.Object
org.odpi.openmetadata.serveroperations.server.spring.OMAGServerResource
@RestController @RequestMapping("/open-metadata/server-operations") public class OMAGServerResource extends Object
OMAGServerResource provides the REST API for controlling the start-up, management and shutdown of services in the OMAG Server.

  • Constructor Details

    • OMAGServerResource

      public OMAGServerResource()

  • Method Details

    • getActiveConfiguration

      @GetMapping(path="/servers/{serverName}/instance/configuration") public OMAGServerConfigResponse getActiveConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the configuration used for the current active instance of the server. Null is returned if the server instance is not running.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      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 OMAGServerStatusResponse getActiveServerStatus(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the status for the current active instance of the server. Null is returned if the server instance is not running.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      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.

    • getActiveServices

      @GetMapping(path="/servers/{serverName}/services") public ServerServicesListResponse getActiveServices(@PathVariable String serverName, @RequestParam(required=false) 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:
      server name and list od services running within

    • addOpenMetadataArchiveFile

      @PostMapping(path="/servers/{serverName}/instance/open-metadata-archives/file") public VoidResponse addOpenMetadataArchiveFile(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody 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

      @PostMapping(path="/servers/{serverName}/instance/open-metadata-archives/connection") public VoidResponse addOpenMetadataArchive(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody Connection connection)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      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.

    • addOpenMetadataArchive

      @PostMapping(path="/servers/{serverName}/instance/open-metadata-archives/archive-content") public VoidResponse addOpenMetadataArchive(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody OpenMetadataArchive openMetadataArchive)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      openMetadataArchive - openMetadataArchive 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 openMetadataArchive parameter.