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

Class OpenIntegrationServiceBase

java.lang.Object

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

org.odpi.openmetadata.frameworkservices.oif.client.OpenIntegrationServiceBase

public class OpenIntegrationServiceBase
extends org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

OpenIntegrationServiceBase supports the open integration interface.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName)	Create a new metadata element to represent a software capability.
List<org.odpi.openmetadata.frameworks.integration.properties.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.
org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport	getIntegrationReport(String userId, String reportGUID)	Retrieve a specific integration report by unique identifier.
List<org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport>	getIntegrationReports(String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the published integration reports.
List<org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport>	getIntegrationReportsForElement(String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the integration reports attached to an element.
String	getMetadataSourceGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the metadata element that represents the metadata source.
void	publishIntegrationReport(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.integration.properties.IntegrationReportProperties properties)	Create a new integration report for an element (identified by anchorGUID).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

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

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 String serverUserId,
 String serverPassword)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

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

serverUserId - caller's userId embedded in all HTTP requests

serverPassword - caller's password embedded in all HTTP requests

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 OpenIntegrationRESTClient restClient,
 int maxPageSize)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

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

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

getMetadataSourceGUID

public String getMetadataSourceGUID(String userId,
 String qualifiedName)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Specified by:

getMetadataSourceGUID in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

Parameters:

userId - calling user

qualifiedName - unique name of the metadata source

Returns:

unique identifier of the metadata source

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

createMetadataSource

public String createMetadataSource(String userId,
 String softwareCapabilityTypeName,
 String classificationName,
 String qualifiedName)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Specified by:

createMetadataSource in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getCatalogTargets

public List<org.odpi.openmetadata.frameworks.integration.properties.CatalogTarget> getCatalogTargets(String userId,
 String integrationConnectorGUID,
 int startingFrom,
 int maximumResults)
                                                                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.

Specified by:

getCatalogTargets in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definition.

publishIntegrationReport

public void publishIntegrationReport(String userId,
 String anchorGUID,
 org.odpi.openmetadata.frameworks.integration.properties.IntegrationReportProperties properties)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Specified by:

publishIntegrationReport in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

Parameters:

userId - calling user

anchorGUID - element to attach the integration report to

properties - properties of the report

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem with the metadata server.

getIntegrationReport

public org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport getIntegrationReport(String userId,
 String reportGUID)
                                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve a specific integration report by unique identifier.

Specified by:

getIntegrationReport in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

Parameters:

userId - calling user

reportGUID - unique identifier of the integration report

Returns:

report or null

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem with the metadata server.

getIntegrationReportsForElement

public List<org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport> getIntegrationReportsForElement(String userId,
 String elementGUID,
 Date afterCompletionDate,
 Date beforeStartDate,
 int startingFrom,
 int maximumResults)
                                                                                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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.

Specified by:

getIntegrationReportsForElement in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem with the metadata server.

getIntegrationReports

public List<org.odpi.openmetadata.frameworks.integration.properties.IntegrationReport> getIntegrationReports(String userId,
 Date afterCompletionDate,
 Date beforeStartDate,
 int startingFrom,
 int maximumResults)
                                                                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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.

Specified by:

getIntegrationReports in class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem with the metadata server.