Package org.odpi.openmetadata.frameworks.discovery

Class DiscoveryConfigurationServer

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryConfigurationServer

public abstract class DiscoveryConfigurationServer
extends Object

DiscoveryConfigurationServer defines the external interface used to define information about a discovery engine. Discovery engines are hosted by the discovery server.

Constructor Summary

Constructors

Constructor	Description
DiscoveryConfigurationServer()

Method Summary

Modifier and Type	Method	Description
abstract String	createDiscoveryEngine(String userId, String qualifiedName, String displayName, String description)	Create a new discovery engine definition.
abstract String	createDiscoveryService(String userId, String qualifiedName, String displayName, String description, Connection connection)	Create a discovery service definition.
abstract void	deleteDiscoveryEngine(String userId, String guid, String qualifiedName)	Remove the properties of the discovery engine.
abstract void	deleteDiscoveryService(String userId, String guid, String qualifiedName)	Remove the properties of the discovery service.
abstract List<DiscoveryEngineProperties>	getAllDiscoveryEngines(String userId, int startingFrom, int maximumResults)	Return the list of discovery engine definitions that are stored.
abstract List<DiscoveryServiceProperties>	getAllDiscoveryServices(String userId, int startingFrom, int maximumResults)	Return the list of discovery services definitions that are stored.
abstract DiscoveryEngineProperties	getDiscoveryEngineByGUID(String userId, String guid)	Return the properties from a discovery engine definition.
abstract DiscoveryEngineProperties	getDiscoveryEngineByName(String userId, String name)	Return the properties from a discovery engine definition.
abstract DiscoveryServiceProperties	getDiscoveryServiceByGUID(String userId, String guid)	Return the properties from a discovery service definition.
abstract DiscoveryServiceProperties	getDiscoveryServiceByName(String userId, String name)	Return the properties from a discovery service definition.
abstract List<String>	getDiscoveryServiceRegistrations(String userId, String discoveryServiceGUID)	Return the list of discovery engines that a specific discovery service is registered with.
abstract RegisteredDiscoveryService	getRegisteredDiscoveryService(String userId, String discoveryEngineGUID, String discoveryServiceGUID)	Retrieve a specific discovery service registered with a discovery engine.
abstract List<String>	getRegisteredDiscoveryServices(String userId, String discoveryEngineGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the discovery services registered with a discovery engine.
abstract void	registerDiscoveryServiceWithEngine(String userId, String discoveryEngineGUID, String discoveryServiceGUID, String discoveryRequestType, Map<String,String> defaultAnalysisParameters)	Register a discovery service with a specific discovery engine.
abstract void	unregisterDiscoveryServiceFromEngine(String userId, String discoveryEngineGUID, String discoveryServiceGUID)	Unregister a discovery service from the discovery engine.
abstract 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.
abstract void	updateDiscoveryService(String userId, String guid, String qualifiedName, String displayName, String description, 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 Details

DiscoveryConfigurationServer

public DiscoveryConfigurationServer()

Method Details

createDiscoveryEngine

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

Create a new discovery engine definition.

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 abstract DiscoveryEngineProperties getDiscoveryEngineByGUID(String userId,
 String guid)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a discovery engine definition.

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 abstract DiscoveryEngineProperties getDiscoveryEngineByName(String userId,
 String name)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a discovery engine definition.

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 abstract List<DiscoveryEngineProperties> getAllDiscoveryEngines(String userId,
 int startingFrom,
 int maximumResults)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of discovery engine definitions that are stored.

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

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

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

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 abstract DiscoveryServiceProperties getDiscoveryServiceByGUID(String userId,
 String guid)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a discovery service definition.

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 abstract DiscoveryServiceProperties getDiscoveryServiceByName(String userId,
 String name)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a discovery service definition.

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 abstract List<DiscoveryServiceProperties> getAllDiscoveryServices(String userId,
 int startingFrom,
 int maximumResults)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of discovery services definitions that are stored.

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

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 abstract void updateDiscoveryService(String userId,
 String guid,
 String qualifiedName,
 String displayName,
 String description,
 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.

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.

description - new value for the description.

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

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 abstract void registerDiscoveryServiceWithEngine(String userId,
 String discoveryEngineGUID,
 String discoveryServiceGUID,
 String discoveryRequestType,
 Map<String,String> defaultAnalysisParameters)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Register a discovery service with a specific discovery engine.

Parameters:

userId - identifier of calling user

discoveryEngineGUID - unique identifier of the discovery engine.

discoveryServiceGUID - unique identifier of the discovery service.

discoveryRequestType - discovery request type that this discovery service is able to process.

defaultAnalysisParameters - list of analysis parameters that are passed to 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 abstract RegisteredDiscoveryService getRegisteredDiscoveryService(String userId,
 String discoveryEngineGUID,
 String discoveryServiceGUID)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific discovery service registered with a discovery engine.

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

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 abstract void unregisterDiscoveryServiceFromEngine(String userId,
 String discoveryEngineGUID,
 String discoveryServiceGUID)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a discovery service from the discovery engine.

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.