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:
AuditLoggingComponent
,SecureConnectorExtension
IntegrationDaemonConnector provides access to an Integration Daemon server.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
ConnectorBase.ProtectedConnection
-
Field Summary
Fields inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase
extractor
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetConfigurationProperties
(String connectorName) Retrieve the configuration properties of the named connector.Retrieve a list of the integration services registered on the platformvoid
publishOpenLineageEvent
(String event) Pass an open lineage event to the integration service.void
refreshConnector
(String connectorName) Issue a refresh() request on a specific connectorvoid
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 connectorvoid
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, 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, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector
clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp
-
Constructor Details
-
IntegrationDaemonConnector
public IntegrationDaemonConnector()
-
-
Method Details
-
getIntegrationServices
public List<RegisteredOMAGService> getIntegrationServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the integration services registered on the platform- Returns:
- List of integration services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getConfigurationProperties
public Map<String,Object> getConfigurationProperties(String connectorName) throws InvalidParameterException, UserNotAuthorizedException, 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:
InvalidParameterException
- the connector name is not recognizedUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- there was a problem detected by the integration daemon
-
updateConfigurationProperties
public void updateConfigurationProperties(String connectorName, boolean isMergeUpdate, Map<String, Object> configurationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionUpdate 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 connectorsisMergeUpdate
- should the properties be merged into the existing properties or replace themconfigurationProperties
- new configuration properties- Throws:
InvalidParameterException
- the connector name is not recognizedUserNotAuthorizedException
PropertyServerException
-
updateEndpointNetworkAddress
public void updateEndpointNetworkAddress(String connectorName, String networkAddress) throws InvalidParameterException, UserNotAuthorizedException, 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 connectorsnetworkAddress
- new address- Throws:
InvalidParameterException
- the connector name is not recognizedUserNotAuthorizedException
PropertyServerException
-
updateConnectorConnection
public void updateConnectorConnection(String connectorName, Connection connection) throws InvalidParameterException, UserNotAuthorizedException, 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 connectorsconnection
- new address- Throws:
InvalidParameterException
- the connector name is not recognizedUserNotAuthorizedException
PropertyServerException
-
refreshConnector
public void refreshConnector(String connectorName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a refresh() request on a specific connector- Throws:
InvalidParameterException
- one of the parameters is null or invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- there was a problem detected by the integration daemon
-
refreshConnectors
public void refreshConnectors() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionIssue a refresh() request on a connector running in the integration daemon.- Throws:
InvalidParameterException
- one of the parameters is null or invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- there was a problem detected by the integration daemon
-
restartConnector
public void restartConnector(String connectorName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a restart() request on a specific connector- Parameters:
connectorName
- connector- Throws:
InvalidParameterException
- one of the parameters is null or invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- there was a problem detected by the integration daemon
-
restartConnectors
public void restartConnectors() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionIssue a restart() request on a connector running in the integration daemon.- Throws:
InvalidParameterException
- one of the parameters is null or invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- there was a problem detected by the integration daemon
-
refreshIntegrationGroupConfig
public void refreshIntegrationGroupConfig(String integrationGroupName) throws InvalidParameterException, UserNotAuthorizedException, 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:
InvalidParameterException
- one of the parameters is null or invalid.UserNotAuthorizedException
- user not authorized to issue this request.PropertyServerException
- there was a problem detected by the integration group.
-
publishOpenLineageEvent
public void publishOpenLineageEvent(String event) throws InvalidParameterException, UserNotAuthorizedException, 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:
InvalidParameterException
- one of the parameters is null or invalidUserNotAuthorizedException
- the caller is not authorized to call the servicePropertyServerException
- there is a problem processing the request
-