Package org.odpi.openmetadata.adminservices.spring

Class ConfigPropertiesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigPropertiesResource

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

ConfigPropertiesResource provides part of the server-side implementation of the administrative interface for an Open Metadata and Governance (OMAG) Server. In particular, this resource supports the configuration of the server name, server type and organization name.

Constructor Summary

Constructors

Constructor	Description
ConfigPropertiesResource()

Method Summary

Modifier and Type	Method	Description
BasicServerPropertiesResponse	getBasicServerProperties(String userId, String serverName)	Get the basic server properties in a single request.
ServerTypeClassificationResponse	getServerTypeClassification(String userId, String serverName)	Return the derived server type that is created from the classification of the server configuration.
VoidResponse	setBasicServerProperties(String userId, String serverName, ServerPropertiesRequestBody requestBody)	Set up the basic server properties in a single request.
VoidResponse	setMaxPageSize(String userId, String serverName, int limit)	Set an upper limit in the page size that can be requested on a REST call to the server.
VoidResponse	setOrganizationName(String userId, String serverName, String name)	Set up the name of the organization that is running this server.
VoidResponse	setServerDescription(String userId, String serverName, String description)	Set up the description of this server.
VoidResponse	setServerPassword(String userId, String serverName, String password)	Set up the password to use when the server is issuing REST calls.
VoidResponse	setServerType(String userId, String serverName, String typeName)	Deprecated.
VoidResponse	setServerUserId(String userId, String serverName, String id)	Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigPropertiesResource

public ConfigPropertiesResource()

Method Details

getServerTypeClassification

@GetMapping(path="/server-type-classification")
public ServerTypeClassificationResponse getServerTypeClassification(@PathVariable
 String userId,
 @PathVariable
 String serverName)

Return the derived server type that is created from the classification of the server configuration.

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 serverType parameter.

setServerType

@PostMapping(path="/server-type")
@Deprecated
public VoidResponse setServerType(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestParam
 String typeName)

Deprecated.

Set up the descriptive type of the server. This value is added to distributed events to make it easier to understand the source of events. The default value is null which means the server classification is used.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

typeName - short description for the type of server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverType parameter.

setOrganizationName

@PostMapping(path="/organization-name")
public VoidResponse setOrganizationName(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestParam
 String name)

Set up the name of the organization that is running this server. This value is added to distributed events to make it easier to understand the source of events. The default value is null.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

name - String name of the organization.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or organizationName parameter.

setServerDescription

@PostMapping(path="/server-description")
public VoidResponse setServerDescription(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestBody
 String description)

Set up the description of this server. The default value is null.

Parameters:

userId - user that is issuing the request.

serverName - local server description.

description - String description of the server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or organizationName parameter.

setServerUserId

@PostMapping(path="/server-user-id")
public VoidResponse setServerUserId(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestParam
 String id)

Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Parameters:

userId - - user that is issuing the request.

serverName - - local server name.

id - - String user is for the server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverURLRoot parameter.

setServerPassword

@PostMapping(path="/server-user-password")
public VoidResponse setServerPassword(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestParam
 String password)

Set up the password to use when the server is issuing REST calls. If this value is set then the serverUserId and this password are both embedded in the HTTP header.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

password - String password for the server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverURLRoot parameter.

setMaxPageSize

@PostMapping(path="/max-page-size")
public VoidResponse setMaxPageSize(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestParam
 int limit)

Set an upper limit in the page size that can be requested on a REST call to the server. The default value is 1000.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

limit - max number of elements that can be returned on a request.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or maxPageSize parameter.

setBasicServerProperties

@PostMapping(path="/server-properties")
public VoidResponse setBasicServerProperties(@PathVariable
 String userId,
 @PathVariable
 String serverName,
 @RequestBody
 ServerPropertiesRequestBody requestBody)

Set up the basic server properties in a single request.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

requestBody - property details

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or maxPageSize parameter.

getBasicServerProperties

@GetMapping(path="/server-properties")
public BasicServerPropertiesResponse getBasicServerProperties(@PathVariable
 String userId,
 @PathVariable
 String serverName)

Get the basic server properties in a single request.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

properties response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or maxPageSize parameter.