org.odpi.openmetadata.adminservices

Class OMAGServerConfigDiscoveryEngineServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryEngineServices

public class OMAGServerConfigDiscoveryEngineServices
extends Object

OMAGServerConfigDiscoveryEngineServices supports the configuration requests for a discovery server and the discovery engines that run inside of it.

Constructor Summary

Constructors

Constructor and Description
OMAGServerConfigDiscoveryEngineServices()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearDiscoveryEngineServicesConfig(String userId, String serverName) Remove this service from the server configuration.
DiscoveryEngineServicesConfigResponse	getDiscoveryEngineServicesConfig(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 discovery server.
VoidResponse	setDiscoveryEngines(String userId, String serverName, List<String> discoveryEngineNames) Set up the list of discovery engines that will run in this discovery server.
VoidResponse	setDiscoveryEngineServicesConfig(String userId, String serverName, DiscoveryEngineServicesConfig 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

OMAGServerConfigDiscoveryEngineServices

public OMAGServerConfigDiscoveryEngineServices()

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 discovery 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.

setDiscoveryEngines

public VoidResponse setDiscoveryEngines(String userId,
                                        String serverName,
                                        List<String> discoveryEngineNames)

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

Parameters:

userId - user that is issuing the request.

serverName - local server name.

discoveryEngineNames - list of discovery engine qualified names describing which discovery 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.

setDiscoveryEngineServicesConfig

public VoidResponse setDiscoveryEngineServicesConfig(String userId,
                                                     String serverName,
                                                     DiscoveryEngineServicesConfig 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.

getDiscoveryEngineServicesConfig

public DiscoveryEngineServicesConfigResponse getDiscoveryEngineServicesConfig(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.

clearDiscoveryEngineServicesConfig

public VoidResponse clearDiscoveryEngineServicesConfig(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