Package org.odpi.openmetadata.frameworks.integration.client

Class IntegrationGroupConfiguration

java.lang.Object

org.odpi.openmetadata.frameworks.integration.client.IntegrationGroupConfiguration

Direct Known Subclasses:

IntegrationGroupConfigurationClientBase

public abstract class IntegrationGroupConfiguration
extends Object

IntegrationGroupConfiguration supports the configuration of integration group and integration connectors.

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
IntegrationGroupConfiguration(String serverName, String serverPlatformURLRoot, String serviceURLMarker)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
abstract void	addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties)	Add a catalog target to an integration connector.
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	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<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 integrationConnectorGUID, String metadataElementGUID)	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 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 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	registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties properties)	Register an integration connector with a specific integration group.
abstract void	removeCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)	Unregister a catalog target from the integration connector.
abstract void	unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Unregister an integration connector from the integration group.
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

IntegrationGroupConfiguration

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

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

Parameters:

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

serverName - name of the server to connect to

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

Method Details

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

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 integrationConnectorGUID,
 String metadataElementGUID)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific catalog target associated with 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.

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 integrationConnectorGUID,
 String metadataElementGUID)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a catalog target from the integration connector.

Parameters:

userId - identifier of calling user.

integrationConnectorGUID - unique identifier of the integration connector.

metadataElementGUID - unique identifier of the metadata element.

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.