Package org.odpi.openmetadata.frameworkservices.oif.client

Class IntegrationGroupConfigurationClientBase

java.lang.Object

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

org.odpi.openmetadata.frameworkservices.oif.client.IntegrationGroupConfigurationClientBase

Direct Known Subclasses:

IntegrationGroupConfigurationClient

public abstract class IntegrationGroupConfigurationClientBase
extends IntegrationGroupConfiguration

IntegrationGroupConfigurationClient supports the configuration of integration group and integration connectors.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.client.IntegrationGroupConfiguration

serverName, serverPlatformURLRoot, serviceURLMarker

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties)	Add a catalog target to an integration connector.
String	createIntegrationConnector(String userId, IntegrationConnectorProperties properties)	Create an integration connector definition.
String	createIntegrationGroup(String userId, IntegrationGroupProperties properties)	Create a new integration group definition.
void	deleteIntegrationConnector(String userId, String guid, String qualifiedName)	Remove the properties of the integration connector.
void	deleteIntegrationGroup(String userId, String guid, String qualifiedName)	Remove the properties of the integration group.
List<IntegrationConnectorElement>	getAllIntegrationConnectors(String userId, int startingFrom, int maximumResults)	Return the list of integration connectors definitions that are stored.
List<IntegrationGroupElement>	getAllIntegrationGroups(String userId, int startingFrom, int maximumResults)	Return the list of integration group definitions that are stored.
CatalogTarget	getCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)	Retrieve a specific catalog target associated with an integration connector.
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.
String	getConfigurationServerName()	Return the name of the server where configuration is supposed to be stored.
IntegrationConnectorElement	getIntegrationConnectorByGUID(String userId, String guid)	Return the properties from an integration connector definition.
IntegrationConnectorElement	getIntegrationConnectorByName(String userId, String name)	Return the properties from an integration connector definition.
List<String>	getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID)	Return the list of integration groups that a specific integration connector is registered with.
IntegrationGroupElement	getIntegrationGroupByGUID(String userId, String guid)	Return the properties from an integration group definition.
IntegrationGroupElement	getIntegrationGroupByName(String userId, String name)	Return the properties from an integration group definition.
RegisteredIntegrationConnectorElement	getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Retrieve a specific integration connector registered with an integration group.
List<RegisteredIntegrationConnectorElement>	getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the integration connectors registered with an integration group.
void	registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties properties)	Register an integration connector with a specific integration group.
void	removeCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)	Unregister a catalog target from the integration connector.
void	unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Unregister an integration connector from the integration group.
void	updateIntegrationConnector(String userId, String guid, boolean isMergeUpdate, IntegrationConnectorProperties properties)	Update the properties of an existing integration connector definition.
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

Constructor Details

IntegrationGroupConfigurationClientBase

public IntegrationGroupConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker)
                                        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 services

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

Throws:

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

IntegrationGroupConfigurationClientBase

public IntegrationGroupConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 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 services

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

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.

IntegrationGroupConfigurationClientBase

public IntegrationGroupConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 OpenIntegrationRESTClient 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 services

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

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 Details

getConfigurationServerName

public String getConfigurationServerName()

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

Returns:

server name

createIntegrationGroup

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

Create a new integration group definition.

Specified by:

createIntegrationGroup in class IntegrationGroupConfiguration

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 IntegrationGroupElement getIntegrationGroupByGUID(String userId,
 String guid)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition.

Specified by:

getIntegrationGroupByGUID in class IntegrationGroupConfiguration

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 IntegrationGroupElement getIntegrationGroupByName(String userId,
 String name)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition.

Specified by:

getIntegrationGroupByName in class IntegrationGroupConfiguration

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

Return the list of integration group definitions that are stored.

Specified by:

getAllIntegrationGroups in class IntegrationGroupConfiguration

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

Specified by:

updateIntegrationGroup in class IntegrationGroupConfiguration

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 - new values for 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 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.

Specified by:

deleteIntegrationGroup in class IntegrationGroupConfiguration

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

Specified by:

createIntegrationConnector in class IntegrationGroupConfiguration

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 IntegrationConnectorElement getIntegrationConnectorByGUID(String userId,
 String guid)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration connector definition.

Specified by:

getIntegrationConnectorByGUID in class IntegrationGroupConfiguration

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 IntegrationConnectorElement getIntegrationConnectorByName(String userId,
 String name)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration connector definition.

Specified by:

getIntegrationConnectorByName in class IntegrationGroupConfiguration

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

Return the list of integration connectors definitions that are stored.

Specified by:

getAllIntegrationConnectors in class IntegrationGroupConfiguration

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

Specified by:

getIntegrationConnectorRegistrations in class IntegrationGroupConfiguration

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

Specified by:

updateIntegrationConnector in class IntegrationGroupConfiguration

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

Specified by:

deleteIntegrationConnector in class IntegrationGroupConfiguration

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 void registerIntegrationConnectorWithGroup(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID,
 RegisteredIntegrationConnectorProperties properties)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Register an integration connector with a specific integration group.

Specified by:

registerIntegrationConnectorWithGroup in class IntegrationGroupConfiguration

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 RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific integration connector registered with an integration group.

Specified by:

getRegisteredIntegrationConnector in class IntegrationGroupConfiguration

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

Specified by:

getRegisteredIntegrationConnectors in class IntegrationGroupConfiguration

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 registered services

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 void unregisterIntegrationConnectorFromGroup(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister an integration connector from the integration group.

Specified by:

unregisterIntegrationConnectorFromGroup in class IntegrationGroupConfiguration

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 void addCatalogTarget(String userId,
 String integrationConnectorGUID,
 String metadataElementGUID,
 CatalogTargetProperties properties)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a catalog target to an integration connector.

Specified by:

addCatalogTarget in class IntegrationGroupConfiguration

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

Retrieve a specific catalog target associated with an integration connector.

Specified by:

getCatalogTarget in class IntegrationGroupConfiguration

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

Specified by:

getCatalogTargets in class IntegrationGroupConfiguration

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

Unregister a catalog target from the integration connector.

Specified by:

removeCatalogTarget in class IntegrationGroupConfiguration

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.