org.odpi.openmetadata.adminservices.client

Class DiscoveryServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.DiscoveryServerConfigurationClient

public class DiscoveryServerConfigurationClient
extends OMAGServerConfigurationClient

DiscoveryServerConfigurationClient provides configuration services for a discovery server. The discovery server hosts one or more discovery engines as defined in the Open Discovery Services (ODF).

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor and Description
DiscoveryServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL) Create a new client with no authentication embedded in the HTTP request.
DiscoveryServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword) Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
void	clearDiscoveryEngineServicesConfig() Remove this service from the server configuration.
DiscoveryEngineServicesConfig	getDiscoveryEngineServicesConfig() Get the configuration for the discovery engine services for this server.
void	setClientConfig(OMAGServerClientConfig clientConfig) Set up the name and platform URL root for the metadata server supporting this discovery server.
void	setDiscoveryEngines(List<String> discoveryEngines) Set up the list of discovery engines that are to run in the discovery service.
void	setDiscoveryEngineServicesConfig(DiscoveryEngineServicesConfig servicesConfig) Add this service to the server configuration in one call.

Methods inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestinations, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getServerClassification, getServerSecurityConnection, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryServerConfigurationClient

public DiscoveryServerConfigurationClient(String adminUserId,
                                          String serverName,
                                          String serverPlatformRootURL)
                                   throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DiscoveryServerConfigurationClient

public DiscoveryServerConfigurationClient(String adminUserId,
                                          String serverName,
                                          String serverPlatformRootURL,
                                          String connectionUserId,
                                          String connectionPassword)
                                   throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

setClientConfig

public void setClientConfig(OMAGServerClientConfig clientConfig)
                     throws OMAGNotAuthorizedException,
                            OMAGInvalidParameterException,
                            OMAGConfigurationErrorException

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

Parameters:

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

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setDiscoveryEngines

public void setDiscoveryEngines(List<String> discoveryEngines)
                         throws OMAGNotAuthorizedException,
                                OMAGInvalidParameterException,
                                OMAGConfigurationErrorException

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

Parameters:

discoveryEngines - discoveryEngines for server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setDiscoveryEngineServicesConfig

public void setDiscoveryEngineServicesConfig(DiscoveryEngineServicesConfig servicesConfig)
                                      throws OMAGNotAuthorizedException,
                                             OMAGInvalidParameterException,
                                             OMAGConfigurationErrorException

Add this service to the server configuration in one call.

Parameters:

servicesConfig - full configuration for the service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getDiscoveryEngineServicesConfig

public DiscoveryEngineServicesConfig getDiscoveryEngineServicesConfig()
                                                               throws OMAGNotAuthorizedException,
                                                                      OMAGInvalidParameterException,
                                                                      OMAGConfigurationErrorException

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

Returns:

full configuration for the service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearDiscoveryEngineServicesConfig

public void clearDiscoveryEngineServicesConfig()
                                        throws OMAGNotAuthorizedException,
                                               OMAGInvalidParameterException,
                                               OMAGConfigurationErrorException

Remove this service from the server configuration.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.