Package org.odpi.openmetadata.viewservices.serverauthor.server.spring

Class ConfigViewResource

java.lang.Object
org.odpi.openmetadata.viewservices.serverauthor.server.spring.ConfigViewResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/view-services/server-author/users/{userId}") public class ConfigViewResource 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
    ConfigViewResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse
    deployOMAGServerConfig(String userId, String serverName, String serverBeingDeployedName, String destinationPlatformName)
    Push the configuration for the server to another OMAG Server Platform.
    org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse
    getKnownPlatforms(String userId, String serverName)
    Return the known platforms
    org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse
    getStoredConfiguration(String userId, String serverName, String serverBeingRetrievedName)
    Return the stored configuration document for the server.
    org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse
    setOMAGServerConfig(String userId, String serverName, String serverBeingConfiguredName, 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

    • ConfigViewResource

      public ConfigViewResource()

  • Method Details

    • getKnownPlatforms

      @GetMapping(path="/platforms") public org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse getKnownPlatforms(@PathVariable String userId, @PathVariable String serverName)
      Return the known platforms
      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.

    • getStoredConfiguration

      @GetMapping(path="/servers/{serverBeingRetrievedName}/configuration") public org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse getStoredConfiguration(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverBeingRetrievedName)
      Return the stored configuration document for the server.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      serverBeingRetrievedName - name of the server to be retrieved for configuration.
      Returns:
      OMAGServerConfig properties or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

    • setOMAGServerConfig

      @PostMapping(path="/servers/{serverBeingConfiguredName}/configuration") public org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse setOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverBeingConfiguredName, @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
      serverBeingConfiguredName - name of the server to be configured
      omagServerConfig - configuration for the server
      Returns:
      the current stored configuration or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or OMAGServerConfig parameter.

    • deployOMAGServerConfig

      @PostMapping(path="/servers/{serverBeingDeployedName}/configuration/deploy") public org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse deployOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverBeingDeployedName, @RequestParam("destinationPlatformName") String destinationPlatformName)
      Push the configuration for the server to another OMAG Server Platform.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      serverBeingDeployedName - name of the server to be configured.
      destinationPlatformName - name 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.