Package org.odpi.openmetadata.frameworkservices.oif.handlers

Class OpenIntegrationHandler

java.lang.Object

org.odpi.openmetadata.frameworkservices.oif.handlers.OpenIntegrationHandler

public class OpenIntegrationHandler
extends Object

OpenIntegrationHandler provides the open metadata server side implementation of OpenIntegrationServer which is part of the Open Integration Framework (OIF).

Constructor Summary

Constructors

Constructor	Description
OpenIntegrationHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)	Construct the governance engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method	Description
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.
IntegrationReport	getIntegrationReport(String userId, String reportGUID)	Retrieve a specific integration report by unique identifier.
List<IntegrationReport>	getIntegrationReports(String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the published integration reports.
List<IntegrationReport>	getIntegrationReportsForElement(String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)	Retrieve the integration reports attached to an element.
void	publishIntegrationReport(String userId, String anchorGUID, String anchorTypeName, 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

Constructor Details

OpenIntegrationHandler

public OpenIntegrationHandler(String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 RepositoryHandler repositoryHandler,
 OMRSRepositoryHelper repositoryHelper,
 String localServerUserId,
 OpenMetadataServerSecurityVerifier securityVerifier,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 AuditLog auditLog)

Construct the governance engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve B instances from.

defaultZones - list of zones that the access service should set in all new B instances.

publishZones - list of zones that the access service sets up in published B instances.

auditLog - logging destination

Method Details

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.

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.

publishIntegrationReport

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