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

Class OpenIntegrationClient

java.lang.Object

org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

Direct Known Subclasses:

OpenIntegrationServiceBase

public abstract class OpenIntegrationClient
extends Object

OpenIntegrationClient defines the interface of the client that implements calls to the metadata server.

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
OpenIntegrationClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot)	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	createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName, String deployedImplementationType)	Create a new metadata element to represent a software capability.
abstract AssetUniverse	getAssetProperties(String userId, String assetGUID)	Returns a comprehensive collection of properties about the requested asset.
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 Connector	getConnectorToAsset(String userId, String assetGUID)	Return the connector to the requested asset.
abstract IntegrationReport	getIntegrationReport(String userId, String reportGUID)	Retrieve a specific integration report by unique identifier.
abstract List<IntegrationReport>	getIntegrationReports(String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the published integration reports.
abstract List<IntegrationReport>	getIntegrationReportsForElement(String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the integration reports attached to an element.
abstract String	getMetadataSourceGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the metadata element that represents the metadata source.
abstract void	publishIntegrationReport(String userId, String anchorGUID, String anchorTypeName, IntegrationReportProperties properties)	Create a new integration report for an element (identified by anchorGUID).
abstract void	removeCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)	Unregister a catalog target from the integration connector.
abstract String	saveConnection(String userId, String assetGUID, Connection connection)	Returns the unique identifier corresponding to the supplied connection.
abstract String	saveConnection(String userId, Connection connection)	Returns the unique identifier corresponding to the supplied connection.

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

OpenIntegrationClient

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

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

getMetadataSourceGUID

public abstract String getMetadataSourceGUID(String userId,
 String qualifiedName)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the unique identifier of the metadata element that represents the metadata source.

Parameters:

userId - calling user

qualifiedName - unique name of the metadata source

Returns:

unique identifier of the metadata source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createMetadataSource

public abstract String createMetadataSource(String userId,
 String softwareCapabilityTypeName,
 String classificationName,
 String qualifiedName,
 String deployedImplementationType)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software capability. This describes the metadata source.

Parameters:

userId - calling user

softwareCapabilityTypeName - name of software capability type to describe the metadata source

classificationName - optional classification name that refines the type of the software capability.

qualifiedName - unique name for the external source

deployedImplementationType - type of technology

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

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.

publishIntegrationReport

public abstract void publishIntegrationReport(String userId,
 String anchorGUID,
 String anchorTypeName,
 IntegrationReportProperties properties)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new integration report for an element (identified by anchorGUID).

Parameters:

userId - calling user

anchorGUID - element to attach the integration report to

anchorTypeName - typeName of the anchor for the integration report

properties - properties of the report

Throws:

InvalidParameterException - one of the parameters is null or invalid,

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem with the metadata server.

getIntegrationReport

public abstract IntegrationReport getIntegrationReport(String userId,
 String reportGUID)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific integration report by unique identifier.

Parameters:

userId - calling user

reportGUID - unique identifier of the integration report

Returns:

report or null

Throws:

InvalidParameterException - one of the parameters is null or invalid,

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem with the metadata server.

getIntegrationReportsForElement

public abstract List<IntegrationReport> getIntegrationReportsForElement(String userId,
 String elementGUID,
 Date afterCompletionDate,
 Date beforeStartDate,
 int startingFrom,
 int maximumResults)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the integration reports attached to an element. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.

Parameters:

userId - calling user

elementGUID - calling user

afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).

beforeStartDate - restrict reports to those that started before the requested time (null for any start time).

startingFrom - initial position in the stored list.

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

Returns:

list of qualifying reports

Throws:

InvalidParameterException - one of the parameters is null or invalid,

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem with the metadata server.

getIntegrationReports

public abstract List<IntegrationReport> getIntegrationReports(String userId,
 Date afterCompletionDate,
 Date beforeStartDate,
 int startingFrom,
 int maximumResults)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the published integration reports. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.

Parameters:

userId - calling user

afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).

beforeStartDate - restrict reports to those that started before the requested time (null for any start time).

startingFrom - initial position in the stored list.

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

Returns:

list of qualifying reports

Throws:

InvalidParameterException - one of the parameters is null or invalid,

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem with the metadata server.

saveConnection

public abstract String saveConnection(String userId,
 Connection connection)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectionCheckedException,
ConnectorCheckedException

Returns the unique identifier corresponding to the supplied connection.

Parameters:

connection - the connection object that contains the properties needed to create the connection.

Returns:

guid

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

saveConnection

public abstract String saveConnection(String userId,
 String assetGUID,
 Connection connection)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectionCheckedException,
ConnectorCheckedException

Returns the unique identifier corresponding to the supplied connection.

Parameters:

assetGUID - the unique identifier of an asset to attach the connection to

connection - the connection object that contains the properties needed to create the connection.

Returns:

guid

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

getAssetProperties

public abstract AssetUniverse getAssetProperties(String userId,
 String assetGUID)
                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Parameters:

assetGUID - the unique identifier of an asset to attach the connection to

Returns:

a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorToAsset

public abstract Connector getConnectorToAsset(String userId,
 String assetGUID)
                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectionCheckedException,
ConnectorCheckedException

Return the connector to the requested asset.

Parameters:

assetGUID - the unique identifier of an asset to attach the connection to

Returns:

Open Connector Framework (OCF) connector

Throws:

InvalidParameterException - the asset guid is not recognized or the userId is null

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.