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/users/{userId}") 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 Summary

    Constructors
    Constructor
    Description
    OMAGServerResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.serveroperations.rest.ServerServicesListResponse
    getActiveServices(String userId, String serverName)
    Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OMAGServerResource

      public OMAGServerResource()

  • Method Details

    • 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.

    • getActiveServices

      @GetMapping(path="/servers/{serverName}/services") public org.odpi.openmetadata.serveroperations.rest.ServerServicesListResponse getActiveServices(@PathVariable String userId, @PathVariable String serverName)
      Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.
      Parameters:
      userId - name of the user making the request
      serverName - name of the server of interest
      Returns:
      server name and list od services running within

    • 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.