org.odpi.openmetadata.userinterfaces.adminservices.spring

Class UIConfigResource

java.lang.Object

org.odpi.openmetadata.userinterfaces.adminservices.spring.UIConfigResource

@RestController
 @RequestMapping(value="/open-metadata/ui-admin-services/users/{userId}/servers/{serverName}")
public class UIConfigResource
extends Object

UIServerConfigResource returns the current configuration document for the server. If the configuration document is not found, a new one is created.

Constructor Summary

Constructors

Constructor and Description
UIConfigResource()

Method Summary

Modifier and Type	Method and Description
UIServerConfigResponse	getCurrentConfiguration(String userId, String serverName) Return the stored configuration document for the server.
VoidResponse	setUIServerConfig(String userId, String serverName, UIServerConfig uiServerConfig) Set up the configuration properties for an UI Server in a single command.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIConfigResource

public UIConfigResource()

Method Detail

getCurrentConfiguration

@RequestMapping(method=GET,
                path="/configuration")
public UIServerConfigResponse getCurrentConfiguration(@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:

UIServerConfig properties or UINotAuthorizedException the supplied userId is not authorized to issue this command or UIInvalidParameterException invalid serverName parameter.

setUIServerConfig

@RequestMapping(method=POST,
                path="/configuration")
public VoidResponse setUIServerConfig(@PathVariable
                                                                                                          String userId,
                                                                                                          @PathVariable
                                                                                                          String serverName,
                                                                                                          @RequestBody
                                                                                                          UIServerConfig uiServerConfig)

Set up the configuration properties for an UI Server in a single command.

Parameters:

userId - user that is issuing the request

serverName - local server name

uiServerConfig - configuration for the server

Returns:

void response or UINotAuthorizedException the supplied userId is not authorized to issue this command or UIInvalidParameterException invalid serverName or UIServerConfig parameter.