org.odpi.openmetadata.accessservices.discoveryengine.client

Class DiscoveryConfigurationClient

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryConfigurationServer

org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryConfigurationClient

All Implemented Interfaces:

DiscoveryEngineEventInterface

public class DiscoveryConfigurationClient
extends DiscoveryConfigurationServer
implements DiscoveryEngineEventInterface

Constructor Summary

Constructors

Constructor and Description
DiscoveryConfigurationClient(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
DiscoveryConfigurationClient(String serverName, String serverPlatformURLRoot, ODFRESTClient restClient, int maxPageSize, AuditLog auditLog) Create a new client that passes userId and password in each HTTP request.
DiscoveryConfigurationClient(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
String	createDiscoveryEngine(String userId, String qualifiedName, String displayName, String description) Create a new discovery engine definition.
String	createDiscoveryService(String userId, String qualifiedName, String displayName, String description, Connection connection) Create a discovery service definition.
void	deleteDiscoveryEngine(String userId, String guid, String qualifiedName) Remove the properties of the discovery engine.
void	deleteDiscoveryService(String userId, String guid, String qualifiedName) Remove the properties of the discovery service.
List<DiscoveryEngineProperties>	getAllDiscoveryEngines(String userId, int startingFrom, int maximumResults) Return the list of discovery engine definitions that are stored.
List<DiscoveryServiceProperties>	getAllDiscoveryServices(String userId, int startingFrom, int maximumResults) Return the list of discovery services definitions that are stored.
String	getConfigurationServerName() Return the name of the server where configuration is supposed to be stored.
DiscoveryEngineProperties	getDiscoveryEngineByGUID(String userId, String guid) Return the properties from a discovery engine definition.
DiscoveryEngineProperties	getDiscoveryEngineByName(String userId, String name) Return the properties from a discovery engine definition.
DiscoveryServiceProperties	getDiscoveryServiceByGUID(String userId, String guid) Return the properties from a discovery service definition.
DiscoveryServiceProperties	getDiscoveryServiceByName(String userId, String name) Return the properties from a discovery service definition.
List<String>	getDiscoveryServiceRegistrations(String userId, String discoveryServiceGUID) Return the list of discovery engines that a specific discovery service is registered with.
RegisteredDiscoveryService	getRegisteredDiscoveryService(String userId, String discoveryEngineGUID, String discoveryServiceGUID) Retrieve a specific discovery service registered with a discovery engine.
List<String>	getRegisteredDiscoveryServices(String userId, String discoveryEngineGUID, int startingFrom, int maximumResults) Retrieve the identifiers of the discovery services registered with a discovery engine.
void	registerDiscoveryServiceWithEngine(String userId, String discoveryEngineGUID, String discoveryServiceGUID, List<String> discoveryRequestTypes, Map<String,String> defaultAnalysisParameters) Register a discovery service with a specific discovery engine.
void	registerListener(String userId, DiscoveryEngineEventListener listener) Register a listener object that will be passed each of the events published by the Discovery Engine OMAS.
void	unregisterDiscoveryServiceFromEngine(String userId, String discoveryEngineGUID, String discoveryServiceGUID) Unregister a discovery service from the discovery engine.
void	updateDiscoveryEngine(String userId, String guid, String qualifiedName, String displayName, String description, String typeDescription, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Update the properties of an existing discovery engine definition.
void	updateDiscoveryService(String userId, String guid, String qualifiedName, String displayName, String shortDescription, String description, String owner, OwnerType ownerType, List<String> zoneMembership, String latestChange, Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Update the properties of an existing discovery service definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryConfigurationClient

public DiscoveryConfigurationClient(String serverName,
                                    String serverPlatformURLRoot)
                             throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

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

DiscoveryConfigurationClient

public DiscoveryConfigurationClient(String serverName,
                                    String serverPlatformURLRoot,
                                    String userId,
                                    String password)
                             throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

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

DiscoveryConfigurationClient

public DiscoveryConfigurationClient(String serverName,
                                    String serverPlatformURLRoot,
                                    ODFRESTClient restClient,
                                    int maxPageSize,
                                    AuditLog auditLog)
                             throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Detail

getConfigurationServerName

public String getConfigurationServerName()

Return the name of the server where configuration is supposed to be stored.

Returns:

server name

registerListener

public void registerListener(String userId,
                             DiscoveryEngineEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Discovery Engine OMAS.

Specified by:

registerListener in interface DiscoveryEngineEventInterface

Parameters:

userId - calling user

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createDiscoveryEngine

public String createDiscoveryEngine(String userId,
                                    String qualifiedName,
                                    String displayName,
                                    String description)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a new discovery engine definition.

Specified by:

createDiscoveryEngine in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

qualifiedName - unique name for the discovery engine.

displayName - display name for messages and user interfaces.

description - description of the types of discovery services that will be associated with this discovery engine.

Returns:

unique identifier (guid) of the discovery engine definition. This is for use on other requests.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the discovery engine definition.

getDiscoveryEngineByGUID

public DiscoveryEngineProperties getDiscoveryEngineByGUID(String userId,
                                                          String guid)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Return the properties from a discovery engine definition.

Specified by:

getDiscoveryEngineByGUID in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the discovery engine definition.

Returns:

properties from the discovery engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery engine definition.

getDiscoveryEngineByName

public DiscoveryEngineProperties getDiscoveryEngineByName(String userId,
                                                          String name)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Return the properties from a discovery engine definition.

Specified by:

getDiscoveryEngineByName in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

name - qualified name or display name (if unique).

Returns:

properties from the discovery engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery engine definition.

getAllDiscoveryEngines

public List<DiscoveryEngineProperties> getAllDiscoveryEngines(String userId,
                                                              int startingFrom,
                                                              int maximumResults)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Return the list of discovery engine definitions that are stored.

Specified by:

getAllDiscoveryEngines in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of discovery engine definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery engine definitions.

updateDiscoveryEngine

public void updateDiscoveryEngine(String userId,
                                  String guid,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String typeDescription,
                                  String version,
                                  String patchLevel,
                                  String source,
                                  Map<String,String> additionalProperties,
                                  Map<String,Object> extendedProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the properties of an existing discovery engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.

Specified by:

updateDiscoveryEngine in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier of the discovery engine - used to locate the definition.

qualifiedName - new value for unique name of discovery engine.

displayName - new value for the display name.

description - new description for the discovery engine.

typeDescription - new description of the type ofg discovery engine.

version - new version number for the discovery engine implementation.

patchLevel - new patch level for the discovery engine implementation.

source - new source description for the implementation of the discovery engine.

additionalProperties - additional properties for the discovery engine.

extendedProperties - properties to populate the subtype of the discovery engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the discovery engine definition.

deleteDiscoveryEngine

public void deleteDiscoveryEngine(String userId,
                                  String guid,
                                  String qualifiedName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the properties of the discovery engine. Both the guid and the qualified name is supplied to validate that the correct discovery engine is being deleted.

Specified by:

deleteDiscoveryEngine in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier of the discovery engine - used to locate the definition.

qualifiedName - unique name for the discovery engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery engine definition.

createDiscoveryService

public String createDiscoveryService(String userId,
                                     String qualifiedName,
                                     String displayName,
                                     String description,
                                     Connection connection)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Create a discovery service definition. The same discovery service can be associated with multiple discovery engines.

Specified by:

createDiscoveryService in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

qualifiedName - unique name for the discovery service.

displayName - display name for the discovery service.

description - description of the analysis provided by the discovery service.

connection - connection to instanciate the discovery service implementation.

Returns:

unique identifier of the discovery service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the discovery service definition.

getDiscoveryServiceByGUID

public DiscoveryServiceProperties getDiscoveryServiceByGUID(String userId,
                                                            String guid)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Return the properties from a discovery service definition.

Specified by:

getDiscoveryServiceByGUID in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the discovery service definition.

Returns:

properties of the discovery service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service definition.

getDiscoveryServiceByName

public DiscoveryServiceProperties getDiscoveryServiceByName(String userId,
                                                            String name)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Return the properties from a discovery service definition.

Specified by:

getDiscoveryServiceByName in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

name - qualified name or display name (if unique).

Returns:

properties from the discovery engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery engine definition.

getAllDiscoveryServices

public List<DiscoveryServiceProperties> getAllDiscoveryServices(String userId,
                                                                int startingFrom,
                                                                int maximumResults)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Return the list of discovery services definitions that are stored.

Specified by:

getAllDiscoveryServices in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of discovery service definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service definitions.

getDiscoveryServiceRegistrations

public List<String> getDiscoveryServiceRegistrations(String userId,
                                                     String discoveryServiceGUID)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Return the list of discovery engines that a specific discovery service is registered with.

Specified by:

getDiscoveryServiceRegistrations in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

discoveryServiceGUID - discovery service to search for.

Returns:

list of discovery engine unique identifiers (guids)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service and/or discovery engine definitions.

updateDiscoveryService

public void updateDiscoveryService(String userId,
                                   String guid,
                                   String qualifiedName,
                                   String displayName,
                                   String shortDescription,
                                   String description,
                                   String owner,
                                   OwnerType ownerType,
                                   List<String> zoneMembership,
                                   String latestChange,
                                   Connection connection,
                                   Map<String,String> additionalProperties,
                                   Map<String,Object> extendedProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Update the properties of an existing discovery service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.

Specified by:

updateDiscoveryService in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier of the discovery service - used to locate the definition.

qualifiedName - new value for unique name of discovery service.

displayName - new value for the display name.

shortDescription - new value for the short description.

description - new value for the description.

owner - new owner of the discovery service.

ownerType - new type for the owner of the discovery service.

latestChange - short description of this update.

zoneMembership - new list of zones for this discovery service.

connection - connection used to create an instance of this discovery service.

additionalProperties - additional properties for the discovery engine.

extendedProperties - properties to populate the subtype of the discovery service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the discovery service definition.

deleteDiscoveryService

public void deleteDiscoveryService(String userId,
                                   String guid,
                                   String qualifiedName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the properties of the discovery service. Both the guid and the qualified name is supplied to validate that the correct discovery service is being deleted. The discovery service is also unregistered from its discovery engines.

Specified by:

deleteDiscoveryService in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

guid - unique identifier of the discovery service - used to locate the definition.

qualifiedName - unique name for the discovery service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service definition.

registerDiscoveryServiceWithEngine

public void registerDiscoveryServiceWithEngine(String userId,
                                               String discoveryEngineGUID,
                                               String discoveryServiceGUID,
                                               List<String> discoveryRequestTypes,
                                               Map<String,String> defaultAnalysisParameters)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Register a discovery service with a specific discovery engine.

Specified by:

registerDiscoveryServiceWithEngine in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

discoveryEngineGUID - unique identifier of the discovery engine.

discoveryServiceGUID - unique identifier of the discovery service.

discoveryRequestTypes - list of discovery request types that this discovery service is able to process.

defaultAnalysisParameters - list of analysis parameters that are passed the the discovery service (via the discovery context). These values can be overridden on the actual discovery request.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service and/or discovery engine definitions.

getRegisteredDiscoveryService

public RegisteredDiscoveryService getRegisteredDiscoveryService(String userId,
                                                                String discoveryEngineGUID,
                                                                String discoveryServiceGUID)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Retrieve a specific discovery service registered with a discovery engine.

Specified by:

getRegisteredDiscoveryService in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

discoveryEngineGUID - unique identifier of the discovery engine.

discoveryServiceGUID - unique identifier of the discovery service.

Returns:

details of the discovery service and the asset types it is registered for.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service and/or discovery engine definitions.

getRegisteredDiscoveryServices

public List<String> getRegisteredDiscoveryServices(String userId,
                                                   String discoveryEngineGUID,
                                                   int startingFrom,
                                                   int maximumResults)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the identifiers of the discovery services registered with a discovery engine.

Specified by:

getRegisteredDiscoveryServices in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

discoveryEngineGUID - unique identifier of the discovery engine.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of unique identifiers

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service and/or discovery engine definitions.

unregisterDiscoveryServiceFromEngine

public void unregisterDiscoveryServiceFromEngine(String userId,
                                                 String discoveryEngineGUID,
                                                 String discoveryServiceGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Unregister a discovery service from the discovery engine.

Specified by:

unregisterDiscoveryServiceFromEngine in class DiscoveryConfigurationServer

Parameters:

userId - identifier of calling user

discoveryEngineGUID - unique identifier of the discovery engine.

discoveryServiceGUID - unique identifier of the discovery service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the discovery service and/or discovery engine definitions.