Package org.odpi.openmetadata.integrationservices.display.contextmanager

Class DisplayIntegratorContextManager

java.lang.Object

org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager

org.odpi.openmetadata.integrationservices.display.contextmanager.DisplayIntegratorContextManager

public class DisplayIntegratorContextManager
extends IntegrationContextManager

DisplayIntegratorContextManager provides the bridge between the integration daemon services and the specific implementation of the DataManagerIntegrator integration service

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager

auditLog, connectedAssetContext, localServerPassword, localServerUserId, maxPageSize, openIntegrationClient, openMetadataStoreClient, partnerOMASPlatformRootURL, partnerOMASServerName, serviceOptions

Constructor Summary

Constructors

Constructor	Description
DisplayIntegratorContextManager()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	createClients(int maxPageSize)	Suggestion for subclass to create client(s) to partner OMAS.
void	initializeContextManager(String partnerOMASServerName, String partnerOMASPlatformRootURL, String userId, String password, Map<String,Object> serviceOptions, int maxPageSize, AuditLog auditLog)	Initialize server properties for the context manager.
IntegrationContext	setContext(String connectorId, String connectorName, String connectorUserId, IntegrationConnector integrationConnector, String integrationConnectorGUID, PermittedSynchronization permittedSynchronization, boolean generateIntegrationReport, String metadataSourceQualifiedName)	Set up the context in the supplied connector.
protected String	setUpMetadataSource(String metadataSourceQualifiedName)	Retrieve the metadata source's unique identifier (GUID) or if it is not defined, create the software server capability for this application.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager

setUpMetadataSource

Methods inherited from class java.lang.Object

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

Constructor Details

DisplayIntegratorContextManager

public DisplayIntegratorContextManager()

Default constructor

Method Details

initializeContextManager

public void initializeContextManager(String partnerOMASServerName,
 String partnerOMASPlatformRootURL,
 String userId,
 String password,
 Map<String,Object> serviceOptions,
 int maxPageSize,
 AuditLog auditLog)

Initialize server properties for the context manager.

Overrides:

initializeContextManager in class IntegrationContextManager

Parameters:

partnerOMASServerName - name of the server to connect to

partnerOMASPlatformRootURL - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

serviceOptions - options from the integration service's configuration

maxPageSize - maximum number of results that can be returned on a single REST call

auditLog - logging destination

createClients

public void createClients(int maxPageSize)
                   throws InvalidParameterException

Suggestion for subclass to create client(s) to partner OMAS.

Overrides:

createClients in class IntegrationContextManager

Parameters:

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - the subclass is not able to create one of its clients

setUpMetadataSource

protected String setUpMetadataSource(String metadataSourceQualifiedName)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the metadata source's unique identifier (GUID) or if it is not defined, create the software server capability for this application.

Parameters:

metadataSourceQualifiedName - unique name of the software server capability that represents this integration service

Returns:

unique identifier of the metadata source

Throws:

InvalidParameterException - one of the parameters passed (probably on initialize) is invalid

UserNotAuthorizedException - the integration daemon's userId does not have access to the partner OMAS

PropertyServerException - there is a problem in the remote server running the partner OMAS

setContext

public IntegrationContext setContext(String connectorId,
 String connectorName,
 String connectorUserId,
 IntegrationConnector integrationConnector,
 String integrationConnectorGUID,
 PermittedSynchronization permittedSynchronization,
 boolean generateIntegrationReport,
 String metadataSourceQualifiedName)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Set up the context in the supplied connector. This is called between initialize() and start() on the connector.

Overrides:

setContext in class IntegrationContextManager

Parameters:

connectorId - unique identifier of the connector (used to configure the event listener)

connectorName - name of connector from config

connectorUserId - userId for the connector

integrationConnector - connector created from connection integration service configuration

integrationConnectorGUID - unique identifier of the integration connector entity (only set if working with integration groups)

permittedSynchronization - controls the direction(s) that metadata is allowed to flow

generateIntegrationReport - should the connector generate an integration reports?

metadataSourceQualifiedName - unique name of the software server capability that represents the metadata source.

Returns:

the new integration context

Throws:

InvalidParameterException - the connector is not of the correct type

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server