Package org.odpi.openmetadata.frameworks.governanceaction.client

Class GovernanceConfiguration

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration

Direct Known Subclasses:

GovernanceConfigurationClientBase

public abstract class GovernanceConfiguration
extends Object

GovernanceConfiguration supports the configuration of governance engine and governance services.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	serverName
protected final String	serverPlatformURLRoot
protected final String	serviceURLMarker

Constructor Summary

Constructors

Constructor	Description
GovernanceConfiguration(String serverName, String serverPlatformURLRoot, String serviceURLMarker)	Constructor called by the subclasses.

Method Summary

Modifier and Type	Method	Description
abstract String	addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties)	Add a catalog target to an integration connector.
abstract String	createGovernanceEngine(String userId, String governanceEngineType, String qualifiedName, String displayName, String description)	Create a new governance engine definition.
abstract String	createGovernanceService(String userId, String governanceServiceType, String qualifiedName, String displayName, String description, Connection connection)	Create a governance service definition.
abstract String	createIntegrationConnector(String userId, IntegrationConnectorProperties properties)	Create an integration connector definition.
abstract String	createIntegrationGroup(String userId, IntegrationGroupProperties properties)	Create a new integration group definition.
abstract void	deleteGovernanceEngine(String userId, String guid, String qualifiedName)	Remove the properties of the governance engine.
abstract void	deleteGovernanceService(String userId, String guid, String qualifiedName)	Remove the properties of the governance service.
abstract void	deleteIntegrationConnector(String userId, String guid, String qualifiedName)	Remove the properties of the integration connector.
abstract void	deleteIntegrationGroup(String userId, String guid, String qualifiedName)	Remove the properties of the integration group.
abstract List<GovernanceEngineElement>	getAllGovernanceEngines(String userId, String governanceEngineType, int startingFrom, int maximumResults)	Return the list of governance engine definitions that are stored.
abstract List<GovernanceServiceElement>	getAllGovernanceServices(String userId, int startingFrom, int maximumResults)	Return the list of governance services definitions that are stored.
abstract List<IntegrationConnectorElement>	getAllIntegrationConnectors(String userId, int startingFrom, int maximumResults)	Return the list of integration connectors definitions that are stored.
abstract List<IntegrationGroupElement>	getAllIntegrationGroups(String userId, int startingFrom, int maximumResults)	Return the list of integration group definitions that are stored.
abstract CatalogTarget	getCatalogTarget(String userId, String relationshipGUID)	Retrieve a specific catalog target associated with an integration connector.
abstract List<CatalogTarget>	getCatalogTargets(String userId, String integrationConnectorGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
abstract GovernanceEngineElement	getGovernanceEngineByGUID(String userId, String guid)	Return the properties from a governance engine definition.
abstract GovernanceEngineElement	getGovernanceEngineByName(String userId, String name)	Return the properties from a governance engine definition.
abstract GovernanceServiceElement	getGovernanceServiceByGUID(String userId, String guid)	Return the properties from a governance service definition.
abstract GovernanceServiceElement	getGovernanceServiceByName(String userId, String name)	Return the properties from a governance service definition.
abstract List<String>	getGovernanceServiceRegistrations(String userId, String governanceServiceGUID)	Return the list of governance engines that a specific governance service is registered with.
abstract IntegrationConnectorElement	getIntegrationConnectorByGUID(String userId, String guid)	Return the properties from an integration connector definition.
abstract IntegrationConnectorElement	getIntegrationConnectorByName(String userId, String name)	Return the properties from an integration connector definition.
abstract List<String>	getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID)	Return the list of integration groups that a specific integration connector is registered with.
abstract IntegrationGroupElement	getIntegrationGroupByGUID(String userId, String guid)	Return the properties from an integration group definition.
abstract IntegrationGroupElement	getIntegrationGroupByName(String userId, String name)	Return the properties from an integration group definition.
abstract RegisteredGovernanceServiceElement	getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID)	Retrieve a specific governance service registered with a governance engine.
abstract List<RegisteredGovernanceServiceElement>	getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the governance services registered with a governance engine.
abstract RegisteredIntegrationConnectorElement	getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Retrieve a specific integration connector registered with an integration group.
abstract List<RegisteredIntegrationConnectorElement>	getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the integration connectors registered with an integration group.
abstract void	registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> requestParameters)	Register a governance service with a specific governance engine.
abstract void	registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String requestType, Map<String,String> requestParameters)	Register a governance service with a specific governance engine.
abstract void	registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties properties)	Register an integration connector with a specific integration group.
abstract void	removeCatalogTarget(String userId, String relationshipGUID)	Unregister a catalog target from the integration connector.
abstract void	unregisterGovernanceServiceFromEngine(String userId, String governanceEngineGUID, String governanceServiceGUID)	Unregister a governance service from the governance engine.
abstract void	unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Unregister an integration connector from the integration group.
abstract void	updateCatalogTarget(String userId, String catalogTargetGUID, CatalogTargetProperties properties)	Update a catalog target for an integration connector.
abstract void	updateGovernanceEngine(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 governance engine definition.
abstract void	updateGovernanceService(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 governance service definition.
abstract void	updateIntegrationConnector(String userId, String guid, boolean isMergeUpdate, IntegrationConnectorProperties properties)	Update the properties of an existing integration connector definition.
abstract void	updateIntegrationGroup(String userId, String guid, boolean isMergeUpdate, IntegrationGroupProperties properties)	Update the properties of an existing integration group definition.

Methods inherited from class java.lang.Object

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

Field Details

serverName

protected final String serverName

serverPlatformURLRoot

protected final String serverPlatformURLRoot

serviceURLMarker

protected final String serviceURLMarker

Constructor Details

GovernanceConfiguration

public GovernanceConfiguration(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker)

Constructor called by the subclasses.

Parameters:

serverName - remote server to call

serverPlatformURLRoot - platform hosting remote server

serviceURLMarker - service that his request is being made to

Method Details

createGovernanceEngine

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

Create a new governance engine definition.

Parameters:

userId - identifier of calling user

governanceEngineType - type of governance engine to create

qualifiedName - unique name for the governance engine.

displayName - display name for messages and user interfaces.

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

Returns:

unique identifier (guid) of the governance 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 governance engine definition.

getGovernanceEngineByGUID

public abstract GovernanceEngineElement getGovernanceEngineByGUID(String userId,
 String guid)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a governance engine definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties from the governance engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definition.

getGovernanceEngineByName

public abstract GovernanceEngineElement getGovernanceEngineByName(String userId,
 String name)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a governance engine definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties from the governance engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definition.

getAllGovernanceEngines

public abstract List<GovernanceEngineElement> getAllGovernanceEngines(String userId,
 String governanceEngineType,
 int startingFrom,
 int maximumResults)
                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance engine definitions that are stored.

Parameters:

userId - identifier of calling user

governanceEngineType - type of governance engine to create

startingFrom - initial position in the stored list.

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

Returns:

list of governance engine definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definitions.

updateGovernanceEngine

public abstract void updateGovernanceEngine(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 governance 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 governance engine - used to locate the definition.

qualifiedName - new value for unique name of governance engine.

displayName - new value for the display name.

description - new description for the governance engine.

typeDescription - new description of the type ofg governance engine.

version - new version number for the governance engine implementation.

patchLevel - new patch level for the governance engine implementation.

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

additionalProperties - additional properties for the governance engine.

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance engine definition.

deleteGovernanceEngine

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

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

Parameters:

userId - identifier of calling user

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

qualifiedName - unique name for the governance engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definition.

createGovernanceService

public abstract String createGovernanceService(String userId,
 String governanceServiceType,
 String qualifiedName,
 String displayName,
 String description,
 Connection connection)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

userId - identifier of calling user

governanceServiceType - type of the governance service to create

qualifiedName - unique name for the governance service.

displayName - display name for the governance service.

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

connection - connection to instantiate the governance service implementation.

Returns:

unique identifier of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance service definition.

getGovernanceServiceByGUID

public abstract GovernanceServiceElement getGovernanceServiceByGUID(String userId,
 String guid)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a governance service definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definition.

getGovernanceServiceByName

public abstract GovernanceServiceElement getGovernanceServiceByName(String userId,
 String name)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a governance service definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties from the governance engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definition.

getAllGovernanceServices

public abstract List<GovernanceServiceElement> getAllGovernanceServices(String userId,
 int startingFrom,
 int maximumResults)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance 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 governance service definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definitions.

getGovernanceServiceRegistrations

public abstract List<String> getGovernanceServiceRegistrations(String userId,
 String governanceServiceGUID)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

userId - identifier of calling user

governanceServiceGUID - governance service to search for.

Returns:

list of governance 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 governance service and/or governance engine definitions.

updateGovernanceService

public abstract void updateGovernanceService(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 governance 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 governance service - used to locate the definition.

qualifiedName - new value for unique name of governance service.

displayName - new value for the display name.

description - new value for the description.

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

additionalProperties - additional properties for the governance engine.

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance service definition.

deleteGovernanceService

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

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

Parameters:

userId - identifier of calling user

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

qualifiedName - unique name for the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definition.

registerGovernanceServiceWithEngine

public abstract void registerGovernanceServiceWithEngine(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID,
 String requestType,
 Map<String,String> requestParameters)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Register a governance service with a specific governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

requestType - request type that this governance service is able to process.

requestParameters - list of parameters that are passed to the governance service (via the context). These values can be overridden on the actual governance service request.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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

registerGovernanceServiceWithEngine

public abstract void registerGovernanceServiceWithEngine(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID,
 String governanceRequestType,
 String serviceRequestType,
 Map<String,String> requestParameters)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Register a governance service with a specific governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

governanceRequestType - governance request type used by caller.

serviceRequestType - mapped governance request type that this governance service is able to process.

requestParameters - list of parameters that are passed to the governance service (via the governance context). These values can be overridden on the actual governance request.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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

getRegisteredGovernanceService

public abstract RegisteredGovernanceServiceElement getRegisteredGovernanceService(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID)
                                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific governance service registered with a governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

Returns:

details of the governance 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 governance service and/or governance engine definitions.

getRegisteredGovernanceServices

public abstract List<RegisteredGovernanceServiceElement> getRegisteredGovernanceServices(String userId,
 String governanceEngineGUID,
 int startingFrom,
 int maximumResults)
                                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance 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 governance service and/or governance engine definitions.

unregisterGovernanceServiceFromEngine

public abstract void unregisterGovernanceServiceFromEngine(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a governance service from the governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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

createIntegrationGroup

public abstract String createIntegrationGroup(String userId,
 IntegrationGroupProperties properties)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new integration group definition.

Parameters:

userId - identifier of calling user

properties - values that will be associated with this integration group.

Returns:

unique identifier (guid) of the integration group 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 integration group definition.

getIntegrationGroupByGUID

public abstract IntegrationGroupElement getIntegrationGroupByGUID(String userId,
 String guid)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition.

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the integration group definition.

Returns:

properties from the integration group definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

getIntegrationGroupByName

public abstract IntegrationGroupElement getIntegrationGroupByName(String userId,
 String name)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties from the integration group definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

getAllIntegrationGroups

public abstract List<IntegrationGroupElement> getAllIntegrationGroups(String userId,
 int startingFrom,
 int maximumResults)
                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of integration group 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 integration group definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definitions.

updateIntegrationGroup

public abstract void updateIntegrationGroup(String userId,
 String guid,
 boolean isMergeUpdate,
 IntegrationGroupProperties properties)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of an existing integration group 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 integration group - used to locate the definition.

isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?

properties - values that will be associated with this integration group.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the integration group definition.

deleteIntegrationGroup

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

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

Parameters:

userId - identifier of calling user

guid - unique identifier of the integration group - used to locate the definition.

qualifiedName - unique name for the integration group.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

createIntegrationConnector

public abstract String createIntegrationConnector(String userId,
 IntegrationConnectorProperties properties)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create an integration connector definition. The same integration connector can be associated with multiple integration groups.

Parameters:

userId - identifier of calling user

properties - values that will be associated with this integration connector - including the connection.

Returns:

unique identifier of the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the integration connector definition.

getIntegrationConnectorByGUID

public abstract IntegrationConnectorElement getIntegrationConnectorByGUID(String userId,
 String guid)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration connector definition.

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the integration connector definition.

Returns:

properties of the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definition.

getIntegrationConnectorByName

public abstract IntegrationConnectorElement getIntegrationConnectorByName(String userId,
 String name)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration connector definition.

Parameters:

userId - identifier of calling user

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

Returns:

properties from the integration group definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

getAllIntegrationConnectors

public abstract List<IntegrationConnectorElement> getAllIntegrationConnectors(String userId,
 int startingFrom,
 int maximumResults)
                                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of integration connectors 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 integration connector definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definitions.

getIntegrationConnectorRegistrations

public abstract List<String> getIntegrationConnectorRegistrations(String userId,
 String integrationConnectorGUID)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of integration groups that a specific integration connector is registered with.

Parameters:

userId - identifier of calling user

integrationConnectorGUID - integration connector to search for.

Returns:

list of integration group 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 integration connector and/or integration group definitions.

updateIntegrationConnector

public abstract void updateIntegrationConnector(String userId,
 String guid,
 boolean isMergeUpdate,
 IntegrationConnectorProperties properties)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of an existing integration connector 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 integration connector - used to locate the definition.

isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?

properties - values that will be associated with this integration connector - including the connection.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definition.

deleteIntegrationConnector

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

Remove the properties of the integration connector. Both the guid and the qualified name is supplied to validate that the correct integration connector is being deleted. The integration connector is also unregistered from its integration groups.

Parameters:

userId - identifier of calling user

guid - unique identifier of the integration connector - used to locate the definition.

qualifiedName - unique name for the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definition.

registerIntegrationConnectorWithGroup

public abstract void registerIntegrationConnectorWithGroup(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID,
 RegisteredIntegrationConnectorProperties properties)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Register an integration connector with a specific integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

integrationConnectorGUID - unique identifier of the integration connector.

properties - list of parameters that are used to control to the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

getRegisteredIntegrationConnector

public abstract RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID)
                                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific integration connector registered with an integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

integrationConnectorGUID - unique identifier of the integration connector.

Returns:

details of the integration connector 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 integration connector and/or integration group definitions.

getRegisteredIntegrationConnectors

public abstract List<RegisteredIntegrationConnectorElement> getRegisteredIntegrationConnectors(String userId,
 String integrationGroupGUID,
 int startingFrom,
 int maximumResults)
                                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the identifiers of the integration connectors registered with an integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

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 integration connector and/or integration group definitions.

unregisterIntegrationConnectorFromGroup

public abstract void unregisterIntegrationConnectorFromGroup(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister an integration connector from the integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

integrationConnectorGUID - unique identifier of the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

addCatalogTarget

public abstract String addCatalogTarget(String userId,
 String integrationConnectorGUID,
 String metadataElementGUID,
 CatalogTargetProperties properties)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a catalog target to an integration connector.

Parameters:

userId - identifier of calling user.

integrationConnectorGUID - unique identifier of the integration service.

metadataElementGUID - unique identifier of the metadata element that is a catalog target.

properties - properties for the relationship.

Returns:

catalog target GUID

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the catalog target definition.

updateCatalogTarget

public abstract void updateCatalogTarget(String userId,
 String catalogTargetGUID,
 CatalogTargetProperties properties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update a catalog target for an integration connector.

Parameters:

userId - identifier of calling user.

catalogTargetGUID - unique identifier of the relationship.

properties - properties for the relationship.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the catalog target definition.

getCatalogTarget

public abstract CatalogTarget getCatalogTarget(String userId,
 String relationshipGUID)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific catalog target associated with an integration connector.

Parameters:

userId - identifier of calling user.

relationshipGUID - unique identifier of the catalog target.

Returns:

details of the integration connector and the elements it is to catalog

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definition.

getCatalogTargets

public abstract List<CatalogTarget> getCatalogTargets(String userId,
 String integrationConnectorGUID,
 int startingFrom,
 int maximumResults)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.

Parameters:

userId - identifier of calling user.

integrationConnectorGUID - unique identifier of the integration connector.

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 integration connector definition.

removeCatalogTarget

public abstract void removeCatalogTarget(String userId,
 String relationshipGUID)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a catalog target from the integration connector.

Parameters:

userId - identifier of calling user.

relationshipGUID - unique identifier of the catalog target relationship.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem accessing/updating the integration connector definition.