Package org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers

Class IntegrationDaemonConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.IntegrationDaemonConnector

All Implemented Interfaces:

org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

public class IntegrationDaemonConnector
extends OMAGServerConnectorBase

IntegrationDaemonConnector provides access to an Integration Daemon server.

Constructor Summary

Constructors

Constructor	Description
IntegrationDaemonConnector()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfigurationProperties(String connectorName)	Retrieve the configuration properties of the named connector.
List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>	getIntegrationServices()	Retrieve a list of the integration services registered on the platform
void	publishOpenLineageEvent(String event)	Pass an open lineage event to the integration service.
void	refreshConnector(String connectorName)	Issue a refresh() request on a specific connector
void	refreshConnectors()	Issue a refresh() request on a connector running in the integration daemon.
void	refreshIntegrationGroupConfig(String integrationGroupName)	Request that the integration group refresh its configuration by calling the metadata server.
void	restartConnector(String connectorName)	Issue a restart() request on a specific connector
void	restartConnectors()	Issue a restart() request on a connector running in the integration daemon.
void	updateConfigurationProperties(String connectorName, boolean isMergeUpdate, Map<String,Object> configurationProperties)	Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
void	updateConnectorConnection(String connectorName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)	Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
void	updateEndpointNetworkAddress(String connectorName, String networkAddress)	Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

activateServer, connectToCohort, disconnectFromCohort, getActiveConfiguration, getActiveServerStatus, getActiveServices, getConnectorComponentDescription, getOMAGServerConfig, getServerReport, getServerStatus, setAuditLog, setClientUserId, shutdownAndUnregisterServer, shutdownServer, start, unregisterFromCohort

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Constructor Details

IntegrationDaemonConnector

public IntegrationDaemonConnector()

Method Details

getIntegrationServices

public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getIntegrationServices()
                                                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve a list of the integration services registered on the platform

Returns:

List of integration services

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)

getConfigurationProperties

public Map<String,Object> getConfigurationProperties(String connectorName)
                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the configuration properties of the named connector.

Parameters:

connectorName - name of a specific connector or null for all connectors

Returns:

property map

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized

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

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

updateConfigurationProperties

public void updateConfigurationProperties(String connectorName,
 boolean isMergeUpdate,
 Map<String,Object> configurationProperties)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

Parameters:

connectorName - name of a specific connector or null for all connectors

isMergeUpdate - should the properties be merged into the existing properties or replace them

configurationProperties - new configuration properties

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

updateEndpointNetworkAddress

public void updateEndpointNetworkAddress(String connectorName,
 String networkAddress)
                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

Parameters:

connectorName - name of a specific connector or null for all connectors

networkAddress - new address

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

updateConnectorConnection

public void updateConnectorConnection(String connectorName,
 org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

Parameters:

connectorName - name of a specific connector or null for all connectors

connection - new address

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

refreshConnector

public void refreshConnector(String connectorName)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Issue a refresh() request on a specific connector

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 - there was a problem detected by the integration daemon

refreshConnectors

public void refreshConnectors()
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Issue a refresh() request on a connector running in the integration daemon.

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 - there was a problem detected by the integration daemon

restartConnector

public void restartConnector(String connectorName)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Issue a restart() request on a specific connector

Parameters:

connectorName - connector

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 - there was a problem detected by the integration daemon

restartConnectors

public void restartConnectors()
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Issue a restart() request on a connector running in the integration daemon.

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 - there was a problem detected by the integration daemon

refreshIntegrationGroupConfig

public void refreshIntegrationGroupConfig(String integrationGroupName)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Request that the integration group refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the integration daemon is initializing. This request just ensures that the latest configuration is in use.

Parameters:

integrationGroupName - qualifiedName of the integration group to target

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 - there was a problem detected by the integration group.

publishOpenLineageEvent

public void publishOpenLineageEvent(String event)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Pass an open lineage event to the integration service. It will pass it on to the integration connectors that have registered a listener for open lineage events.

Parameters:

event - open lineage event to publish.

Throws:

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

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to call the service

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem processing the request