Package org.odpi.openmetadata.frameworkservices.gaf.client

Class GovernanceConfigurationClientBase

java.lang.Object

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

org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceConfigurationClientBase

Direct Known Subclasses:

GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient, GovernanceConfigurationClient

public class GovernanceConfigurationClientBase
extends GovernanceConfiguration

GovernanceEngineConfigurationClient supports the configuration of governance engine and governance services.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration

serverName, serverPlatformURLRoot, serviceURLMarker

Constructor Summary

Constructors

Constructor	Description
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, GAFRESTClient 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
String	addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties)	Add a catalog target to an integration connector.
String	createGovernanceEngine(String userId, String governanceEngineType, String qualifiedName, String displayName, String description)	Create a new governance engine definition.
String	createGovernanceService(String userId, String governanceServiceType, String qualifiedName, String displayName, String description, Connection connection)	Create a governance service definition.
String	createIntegrationConnector(String userId, IntegrationConnectorProperties properties)	Create an integration connector definition.
String	createIntegrationGroup(String userId, IntegrationGroupProperties properties)	Create a new integration group definition.
void	deleteGovernanceEngine(String userId, String guid, String qualifiedName)	Remove the properties of the governance engine.
void	deleteGovernanceService(String userId, String guid, String qualifiedName)	Remove the properties of the governance service.
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<GovernanceEngineElement>	getAllGovernanceEngines(String userId, String governanceEngineType, int startingFrom, int maximumResults)	Return the list of governance engine definitions that are stored.
List<GovernanceServiceElement>	getAllGovernanceServices(String userId, int startingFrom, int maximumResults)	Return the list of governance services definitions that are stored.
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 relationshipGUID)	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.
GovernanceEngineElement	getGovernanceEngineByGUID(String userId, String guid)	Return the properties from a governance engine definition.
GovernanceEngineElement	getGovernanceEngineByName(String userId, String name)	Return the properties from a governance engine definition.
GovernanceServiceElement	getGovernanceServiceByGUID(String userId, String guid)	Return the properties from a governance service definition.
GovernanceServiceElement	getGovernanceServiceByName(String userId, String name)	Return the properties from a governance service definition.
List<String>	getGovernanceServiceRegistrations(String userId, String governanceServiceGUID)	Return the list of governance engines that a specific governance service is registered with.
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.
RegisteredGovernanceServiceElement	getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID)	Retrieve a specific governance service registered with a governance engine.
List<RegisteredGovernanceServiceElement>	getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the governance services registered with a governance engine.
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	registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> requestParameters)	Register a governance service with a specific governance engine.
void	registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, Map<String,String> requestParameters)	Deprecated.
void	registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties properties)	Register an integration connector with a specific integration group.
void	removeCatalogTarget(String userId, String relationshipGUID)	Unregister a catalog target from the integration connector.
void	unregisterGovernanceServiceFromEngine(String userId, String governanceEngineGUID, String governanceServiceGUID)	Unregister a governance service from the governance engine.
void	unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Unregister an integration connector from the integration group.
void	updateCatalogTarget(String userId, String relationshipGUID, CatalogTargetProperties properties)	Update a catalog target relationship for an integration connector.
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.
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.
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

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 int maxPageSize)
                                  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)

maxPageSize - pre-initialized parameter limit

Throws:

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

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 String userId,
 String password,
 int maxPageSize)
                                  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

maxPageSize - pre-initialized parameter limit

Throws:

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

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 GAFRESTClient 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

createGovernanceEngine

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

Create a new governance engine definition.

Specified by:

createGovernanceEngine in class GovernanceConfiguration

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

Return the properties from a governance engine definition.

Specified by:

getGovernanceEngineByGUID in class GovernanceConfiguration

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

Return the properties from a governance engine definition.

Specified by:

getGovernanceEngineByName in class GovernanceConfiguration

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

Specified by:

getAllGovernanceEngines in class GovernanceConfiguration

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

Specified by:

updateGovernanceEngine in class GovernanceConfiguration

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

Specified by:

deleteGovernanceEngine in class GovernanceConfiguration

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

Specified by:

createGovernanceService in class GovernanceConfiguration

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

Return the properties from a governance service definition.

Specified by:

getGovernanceServiceByGUID in class GovernanceConfiguration

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

Return the properties from a governance service definition.

Specified by:

getGovernanceServiceByName in class GovernanceConfiguration

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

Return the list of governance services definitions that are stored.

Specified by:

getAllGovernanceServices in class GovernanceConfiguration

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

Specified by:

getGovernanceServiceRegistrations in class GovernanceConfiguration

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

Specified by:

updateGovernanceService in class GovernanceConfiguration

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

Specified by:

deleteGovernanceService in class GovernanceConfiguration

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

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

Deprecated.

Register a governance service with a specific governance engine.

Specified by:

registerGovernanceServiceWithEngine in class GovernanceConfiguration

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 and supported by the governance server.

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.

registerGovernanceServiceWithEngine

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

Specified by:

registerGovernanceServiceWithEngine in class GovernanceConfiguration

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 RegisteredGovernanceServiceElement getRegisteredGovernanceService(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific governance service registered with a governance engine.

Specified by:

getRegisteredGovernanceService in class GovernanceConfiguration

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

Specified by:

getRegisteredGovernanceServices in class GovernanceConfiguration

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

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 void unregisterGovernanceServiceFromEngine(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a governance service from the governance engine.

Specified by:

unregisterGovernanceServiceFromEngine in class GovernanceConfiguration

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 String createIntegrationGroup(String userId,
 IntegrationGroupProperties properties)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new integration group definition.

Specified by:

createIntegrationGroup in class GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 GovernanceConfiguration

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 String 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 GovernanceConfiguration

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

Update a catalog target relationship for an integration connector.

Specified by:

updateCatalogTarget in class GovernanceConfiguration

Parameters:

userId - identifier of calling user.

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

Retrieve a specific catalog target associated with an integration connector.

Specified by:

getCatalogTarget in class GovernanceConfiguration

Parameters:

userId - identifier of calling user.

relationshipGUID - unique identifier of the relationship.

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 GovernanceConfiguration

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 named elements

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 relationshipGUID)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Unregister a catalog target from the integration connector.

Specified by:

removeCatalogTarget in class GovernanceConfiguration

Parameters:

userId - identifier of calling user.

relationshipGUID - 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 accessing/updating the integration connector definition.