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 String	createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName)	Create a new metadata element to represent a software capability.
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 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, IntegrationReportProperties properties)	Create a new integration report for an element (identified by anchorGUID).

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

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)

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

Throws:

InvalidParameterException - one of the parameters is null or invalid,

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem with the metadata server.

publishIntegrationReport

public abstract void publishIntegrationReport(String userId,
 String anchorGUID,
 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

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.