Package org.odpi.openmetadata.adminservices.spring

Class ConfigResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigResource
@RestController @RequestMapping("/open-metadata/admin-services/servers/{serverName}") public class ConfigResource extends Object
OMAGServerConfigResource returns the current configuration document for the server. If the configuration document is not found, a new one is created.

  • Constructor Details

    • ConfigResource

      public ConfigResource()

  • Method Details

    • getStoredConfiguration

      @GetMapping(path="/configuration") public OMAGServerConfigResponse getStoredConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the stored configuration document for the server.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      OMAGServerConfig properties or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • getResolvedConfiguration

      @GetMapping(path="/configuration/resolved") public OMAGServerConfigResponse getResolvedConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the stored configuration document for the server.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      OMAGServerConfig properties or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • setOMAGServerConfig

      @PostMapping(path="/configuration") public VoidResponse setOMAGServerConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody OMAGServerConfig omagServerConfig)
      Set up the configuration properties for an OMAG Server in a single command.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      omagServerConfig - configuration for the server
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or OMAGServerConfig parameter.

    • clearOMAGServerConfig

      @DeleteMapping(path="/configuration") public VoidResponse clearOMAGServerConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Clear the configuration properties for an OMAG Server in a single command.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or OMAGServerConfig parameter.

    • deployOMAGServerConfig

      @PostMapping(path="/configuration/deploy") public VoidResponse deployOMAGServerConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody URLRequestBody destinationPlatform)
      Push the configuration for the server to another OMAG Server Platform.
      Parameters:
      serverName - local server name
      delegatingUserId - external userId making request
      destinationPlatform - location of the platform where the config is to be deployed to
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException there is a problem using the supplied configuration or InvalidParameterException invalid serverName or destinationPlatform parameter.