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 -
Method Summary
Modifier and TypeMethodDescriptiondeployOMAGServerConfig
(String userId, String serverName, String serverBeingDeployedName, String destinationPlatformName) Push the configuration for the server to another OMAG Server Platform.getKnownPlatforms
(String userId, String serverName) Return the known platformsgetStoredConfiguration
(String userId, String serverName, String serverBeingRetrievedName) Return the stored configuration document for the server.setOMAGServerConfig
(String userId, String serverName, String serverBeingConfiguredName, OMAGServerConfig omagServerConfig) Set up the configuration properties for an OMAG Server in a single command.
-
Constructor Details
-
ConfigViewResource
public ConfigViewResource()
-
-
Method Details
-
getKnownPlatforms
@GetMapping(path="/platforms") public ServerAuthorPlatformsResponse getKnownPlatforms(@PathVariable String userId, @PathVariable String serverName) Return the known platforms- Parameters:
userId
- user that is issuing the requestserverName
- 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 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 requestserverName
- local server nameserverBeingRetrievedName
- 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 ServerAuthorConfigurationResponse setOMAGServerConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverBeingConfiguredName, @RequestBody OMAGServerConfig omagServerConfig) Set up the configuration properties for an OMAG Server in a single command.- Parameters:
userId
- user that is issuing the requestserverName
- local server nameserverBeingConfiguredName
- name of the server to be configuredomagServerConfig
- 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 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 requestserverName
- local server nameserverBeingDeployedName
- 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.
-