org.odpi.openmetadata.adminservices

Class OMAGServerConfigStewardshipEngineServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipEngineServices

public class OMAGServerConfigStewardshipEngineServices
extends Object

OMAGServerConfigStewardshipServices supports the configuration requests for the stewardship services.

Constructor Summary

Constructors

Constructor and Description
OMAGServerConfigStewardshipEngineServices()

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) Add this service to the server configuration.
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> stewardshipEngineNames) Set up the list of stewardship engines that will run in this stewardship server.
VoidResponse	setStewardshipEngineServicesConfig(String userId, String serverName, StewardshipEngineServicesConfig servicesConfig) Add this service to the server configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerConfigStewardshipEngineServices

public OMAGServerConfigStewardshipEngineServices()

Method Detail

setClientConfig

public VoidResponse setClientConfig(String userId,
                                    String serverName,
                                    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

public VoidResponse setStewardshipEngines(String userId,
                                          String serverName,
                                          List<String> stewardshipEngineNames)

Set up the list of stewardship engines that will run in this stewardship server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

stewardshipEngineNames - list of stewardship engine qualified names describing which stewardship engines run in this 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.

setStewardshipEngineServicesConfig

public VoidResponse setStewardshipEngineServicesConfig(String userId,
                                                       String serverName,
                                                       StewardshipEngineServicesConfig servicesConfig)

Add this service to the server configuration.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

servicesConfig - full configuration for the service.

Returns:

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

getStewardshipEngineServicesConfig

public StewardshipEngineServicesConfigResponse getStewardshipEngineServicesConfig(String userId,
                                                                                  String serverName)

Add this service to the server configuration.

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

public VoidResponse clearStewardshipEngineServicesConfig(String userId,
                                                         String serverName)

Remove this service from the server configuration.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response