Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.handlers

Class IntegrationGroupHandler

java.lang.Object

org.odpi.openmetadata.governanceservers.integrationdaemonservices.handlers.IntegrationGroupHandler

public class IntegrationGroupHandler
extends Object

The IntegrationGroupHandler is responsible for maintaining information about the integration connectors in an integration group.

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected String	integrationGroupGUID
protected String	integrationGroupName
protected IntegrationGroupProperties	integrationGroupProperties
protected int	maxPageSize
protected String	serverName
protected String	serverUserId

Constructor Summary

Constructors

Constructor	Description
IntegrationGroupHandler(String integrationGroupName, IntegrationContextManager integrationContextManager, IntegrationConnectorCacheMap integrationConnectorCacheMap, String serverName, String serverUserId, GovernanceConfigurationClient configurationClient, AuditLog auditLog, int maxPageSize)	Create a client-side object for managing an integration connector.

Method Summary

Modifier and Type	Method	Description
IntegrationContextManager	getContextManager()	Return the context manager.
String	getIntegrationGroupGUID()	Return the unique identifier for the integration group's entity stored in the metadata server (if known).
String	getIntegrationGroupName()	Return the integration group name - used for error logging.
IntegrationGroupSummary	getSummary()	Return a summary of the integration group
void	refreshConfig()	Request that the integration group refresh its configuration by calling the metadata server.
void	refreshConnectorConfig(String integrationConnectorGUID)	Request that the integration group refreshes its configuration for a single integration connector by calling the metadata server.

Methods inherited from class java.lang.Object

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

Field Details

serverName

protected String serverName

serverUserId

protected String serverUserId

auditLog

protected AuditLog auditLog

maxPageSize

protected int maxPageSize

integrationGroupName

protected String integrationGroupName

integrationGroupGUID

protected String integrationGroupGUID

integrationGroupProperties

protected IntegrationGroupProperties integrationGroupProperties

Constructor Details

IntegrationGroupHandler

public IntegrationGroupHandler(String integrationGroupName,
 IntegrationContextManager integrationContextManager,
 IntegrationConnectorCacheMap integrationConnectorCacheMap,
 String serverName,
 String serverUserId,
 GovernanceConfigurationClient configurationClient,
 AuditLog auditLog,
 int maxPageSize)

Create a client-side object for managing an integration connector.

Parameters:

integrationGroupName - the properties of the integration group.

integrationConnectorCacheMap - manages the dynamic map of connectors.

integrationContextManager - details of the context manager that creates new integration contexts for the integration connectors.

serverName - the name of the integration daemon server where the integration group is running

serverUserId - user id for the server to use

configurationClient - client to retrieve the configuration

auditLog - logging destination

maxPageSize - maximum number of results that can be returned in a single request

Method Details

getIntegrationGroupName

public String getIntegrationGroupName()

Return the integration group name - used for error logging.

Returns:

integration group name

getSummary

public IntegrationGroupSummary getSummary()

Return a summary of the integration group

Returns:

integration group summary

getIntegrationGroupGUID

public String getIntegrationGroupGUID()

Return the unique identifier for the integration group's entity stored in the metadata server (if known).

Returns:

string or null

getContextManager

public IntegrationContextManager getContextManager()

Return the context manager.

Returns:

context manager or null

refreshConfig

public void refreshConfig()
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that the integration group refresh its configuration by calling the metadata server. This request ensures that the latest configuration is in use.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user id is not allowed to access configuration

PropertyServerException - problem in configuration server

refreshConnectorConfig

public void refreshConnectorConfig(String integrationConnectorGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that the integration group refreshes its configuration for a single integration connector by calling the metadata server. This request just ensures that the latest configuration is in use.

Parameters:

integrationConnectorGUID - unique identifier of the integration connector entity

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user id is not allowed to access configuration

PropertyServerException - problem in configuration server