org.odpi.openmetadata.adminservices.spring

Class ConfigStewardshipEngineServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigStewardshipEngineServicesResource

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

ConfigStewardshipServicesResource provides the API for configuring the stewardship services in an OMAG server called the stewardship server. The stewardship engine services are a client to the Stewardship Action Open Metadata Access Services (OMAS). The configuration needs to provide the server name and platform URL root where the metadata server running this service is located. They also need a list of the stewardship engines to run. The definitions of these stewardship engines are stored in the metadata server and are retrieved when the stewardship server starts.

Constructor Summary

Constructors

Constructor and Description
ConfigStewardshipEngineServicesResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearStewardshipEngineServicesConfig(String userId, String serverName) Remove this service from the server configuration.
StewardshipEngineServicesConfigResponse	getStewardshipEngineServicesConfig(String userId, String serverName) Get the configuration for the stewardship engine services for this server.
VoidResponse	setClientConfig(String userId, String serverName, OMAGServerClientConfig clientConfig) Set up the name and platform URL root for the metadata server supporting this stewardship server.
VoidResponse	setStewardshipEngines(String userId, String serverName, List<String> stewardshipEngines) Set up the list of stewardship engines that are to run in the stewardship service.
VoidResponse	setStewardshipEngineServicesConfig(String userId, String serverName, StewardshipEngineServicesConfig servicesConfig) Add this service to the server configuration in one call.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigStewardshipEngineServicesResource

public ConfigStewardshipEngineServicesResource()

Method Detail

setClientConfig

@PostMapping(path="/client-config")
public VoidResponse setClientConfig(@PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String serverName,
                                                                        @RequestBody
                                                                        OMAGServerClientConfig clientConfig)

Set up the name and platform URL root for the metadata server supporting this stewardship server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

clientConfig - URL root and server name for the metadata server.

Returns:

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

setStewardshipEngines

@PostMapping(path="/stewardship-engines")
public VoidResponse setStewardshipEngines(@PathVariable
                                                                                    String userId,
                                                                                    @PathVariable
                                                                                    String serverName,
                                                                                    @RequestBody
                                                                                    List<String> stewardshipEngines)

Set up the list of stewardship engines that are to run in the stewardship service. The definition of these stewardship engines

Parameters:

userId - user that is issuing the request.

serverName - local server name.

stewardshipEngines - stewardshipEngines for server.

Returns:

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

setStewardshipEngineServicesConfig

@PostMapping(path="")
public VoidResponse setStewardshipEngineServicesConfig(@PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String serverName,
                                                                             @RequestBody
                                                                             StewardshipEngineServicesConfig servicesConfig)

Add this service to the server configuration in one call.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

servicesConfig - full configuration for the service.

Returns:

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

getStewardshipEngineServicesConfig

@GetMapping(path="")
public StewardshipEngineServicesConfigResponse getStewardshipEngineServicesConfig(@PathVariable
                                                                                                       String userId,
                                                                                                       @PathVariable
                                                                                                       String serverName)

Get the configuration for the stewardship engine services for this server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

full configuration for the service. OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

clearStewardshipEngineServicesConfig

@DeleteMapping(path="")
public VoidResponse clearStewardshipEngineServicesConfig(@PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String serverName)

Remove this service from the server configuration.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

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