Package org.odpi.openmetadata.adminservices.spring

Class ConfigResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/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 Summary

    Constructors
    Constructor
    Description
    ConfigResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearOMAGServerConfig(String userId, String serverName)
    Clear the configuration properties for an OMAG Server in a single command.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deployOMAGServerConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.URLRequestBody destinationPlatform)
    Push the configuration for the server to another OMAG Server Platform.
    org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse
    getStoredConfiguration(String userId, String serverName)
    Return the stored configuration document for the server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setOMAGServerConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig omagServerConfig)
    Set up the configuration properties for an OMAG Server in a single command.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigResource

      public ConfigResource()

  • Method Details

    • getStoredConfiguration

      @GetMapping(path="/configuration") public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse getStoredConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the stored configuration document for 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.

    • setOMAGServerConfig

      @PostMapping(path="/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig omagServerConfig)
      Set up the configuration properties for an OMAG Server in a single command.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      omagServerConfig - configuration for the server
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or OMAGServerConfig parameter.

    • clearOMAGServerConfig

      @DeleteMapping(path="/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName)
      Clear the configuration properties for an OMAG Server in a single command.
      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 invalid serverName or OMAGServerConfig parameter.

    • deployOMAGServerConfig

      @PostMapping(path="/configuration/deploy") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deployOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.rest.URLRequestBody destinationPlatform)
      Push the configuration for the server to another OMAG Server Platform.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      destinationPlatform - location of the platform where the config is to be deployed to
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException there is a problem using the supplied configuration or OMAGInvalidParameterException invalid serverName or destinationPlatform parameter.