org.odpi.openmetadata.adminservices

Class OMAGServerConfigDiscoveryServer

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer

public class OMAGServerConfigDiscoveryServer
extends Object

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

Constructor Summary

Constructors

Constructor and Description
OMAGServerConfigDiscoveryServer()

Method Summary

Modifier and Type	Method and Description
VoidResponse	deleteService(String userId, String serverName) Remove this service from the server configuration.
VoidResponse	setAccessServiceRootURL(String userId, String serverName, String accessServiceRootURL) Set up the root URL of the access service.
VoidResponse	setAccessServiceServerName(String userId, String serverName, String accessServiceServerName) Set up the server name of the access service.
VoidResponse	setDiscoveryEngines(String userId, String serverName, List<String> discoveryEngineNames) Set up the list of discovery engines that will run in this discovery server.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerConfigDiscoveryServer

public OMAGServerConfigDiscoveryServer()

Method Detail

setAccessServiceRootURL

public VoidResponse setAccessServiceRootURL(String userId,
                                            String serverName,
                                            String accessServiceRootURL)

Set up the root URL of the access service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceRootURL - URL root for the access service.

Returns:

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

setAccessServiceServerName

public VoidResponse setAccessServiceServerName(String userId,
                                               String serverName,
                                               String accessServiceServerName)

Set up the server name of the access service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceServerName - server name for the access service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverType 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 OMAGInvalidParameterException invalid serverName or serverType parameter.

deleteService

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