Package org.odpi.openmetadata.adminservices.spring

Class ConfigPropertiesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigPropertiesResource

@RestController
@RequestMapping("/open-metadata/admin-services/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 serverName, String delegatingUserId)	Get the basic server properties in a single request.
ServerTypeClassificationResponse	getServerTypeClassification(String serverName, String delegatingUserId)	Return the derived server type that is created from the classification of the server configuration.
VoidResponse	setBasicServerProperties(String serverName, String delegatingUserId, ServerPropertiesRequestBody requestBody)	Set up the basic server properties in a single request.
VoidResponse	setMaxPageSize(String serverName, String delegatingUserId, int limit)	Set an upper limit in the page size that can be requested on a REST call to the server.
VoidResponse	setOrganizationName(String serverName, String delegatingUserId, String name)	Set up the name of the organization that is running this server.
VoidResponse	setServerDescription(String serverName, String delegatingUserId, String description)	Set up the description of this server.
VoidResponse	setServerUserId(String serverName, String delegatingUserId, 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 serverName,
 @RequestParam(required=false)
 String delegatingUserId)

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

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

Returns:

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

setOrganizationName

@PostMapping(path="/organization-name")
public VoidResponse setOrganizationName(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId,
 @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:

serverName - local server name.

delegatingUserId - external userId making request

name - String name of the organization.

Returns:

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

setServerDescription

@PostMapping(path="/server-description")
public VoidResponse setServerDescription(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId,
 @RequestBody
 String description)

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

Parameters:

serverName - local server description.

delegatingUserId - external userId making request

description - String description of the server.

Returns:

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

setServerUserId

@PostMapping(path="/server-user-id")
public VoidResponse setServerUserId(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId,
 @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:

serverName - - local server name.

delegatingUserId - external userId making request

id - - String user is for the server.

Returns:

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

setMaxPageSize

@PostMapping(path="/max-page-size")
public VoidResponse setMaxPageSize(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId,
 @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:

serverName - local server name.

delegatingUserId - external userId making request

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

Returns:

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

setBasicServerProperties

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

Set up the basic server properties in a single request.

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

requestBody - property details

Returns:

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

getBasicServerProperties

@GetMapping(path="/server-properties")
public BasicServerPropertiesResponse getBasicServerProperties(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId)

Get the basic server properties in a single request.

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

Returns:

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