Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.client

Class IntegrationDaemon

java.lang.Object

org.odpi.openmetadata.governanceservers.integrationdaemonservices.client.IntegrationDaemon

public class IntegrationDaemon
extends Object

IntegrationDaemon is the client library for the Integration Daemon's REST API. The integration daemon is an OMAG Server. It runs one-to-many integration services that in turn manage one-to-many integration connectors. Each integration service focuses on a particular type of third party technology and is paired with an appropriate OMAS. The refresh commands are used to instruct the connectors running in the integration daemon to verify the consistency of the metadata in the third party technology against the values in open metadata. All connectors are requested to refresh when the integration daemon first starts. Then refresh is called on the schedule defined in the configuration and lastly as a result of calls to this API.

Constructor Summary

Constructors

Constructor	Description
IntegrationDaemon(String serverName, String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, AuditLog auditLog)	Create a new client with bearer token authentication embedded in the HTTP request.
IntegrationDaemon(String serverName, String serverPlatformRootURL, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, AuditLog auditLog)	Create a new client with bearer token authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfigurationProperties(String connectorName)	Retrieve the configuration properties of the named connector.
IntegrationDaemonStatus	getIntegrationDaemonStatus()	Return a summary of each of the integration services' and integration groups' status.
List<IntegrationGroupSummary>	getIntegrationGroupSummaries()	Retrieve the description and status of each integration group assigned to the Integration Daemon.
IntegrationGroupSummary	getIntegrationGroupSummary(String integrationGroupName)	Retrieve the description and status of the requested integration group.
void	publishOpenLineageEvent(io.openlineage.client.OpenLineage.RunEvent event)	Pass an open lineage event to the integration service.
void	publishOpenLineageEvent(String event)	Pass an open lineage event to the integration service.
void	refreshConfig(String integrationGroupName)	Request that the integration group refresh its configuration by calling the metadata server.
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	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, 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.
ConnectorReport	validateConnector(String connectorProviderClassName)	Validate the connector and return its connector type.

Methods inherited from class java.lang.Object

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

Constructor Details

IntegrationDaemon

public IntegrationDaemon(String serverName,
 String serverPlatformRootURL,
 String secretStoreProvider,
 String secretStoreLocation,
 String secretStoreCollection,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with bearer token authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

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

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

IntegrationDaemon

public IntegrationDaemon(String serverName,
 String serverPlatformRootURL,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with bearer token authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

validateConnector

public ConnectorReport validateConnector(String connectorProviderClassName)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Validate the connector and return its connector type.

Parameters:

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

Returns:

connector type and other capabilities for this connector

Throws:

InvalidParameterException - the connector provider class name is not a valid connector fo this service

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration service

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 recognized

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration daemon

updateConfigurationProperties

public void updateConfigurationProperties(String connectorName,
 boolean isMergeUpdate,
 Map<String,Object> configurationProperties)
                                   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 connectors

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

configurationProperties - new configuration properties

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException

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 connectors

networkAddress - new address

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException

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 connectors

connection - new address

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException

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 invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration daemon

refreshConnectors

public void refreshConnectors()
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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 daemon

restartConnector

public void restartConnector(String connectorName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a restart() request on a specific connector

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 daemon

restartConnectors

public void restartConnectors()
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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 daemon

getIntegrationDaemonStatus

public IntegrationDaemonStatus getIntegrationDaemonStatus()
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return a summary of each of the integration services' and integration groups' status.

Returns:

list of statuses - one for each assigned integration service or integration group

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 daemon

getIntegrationGroupSummary

public IntegrationGroupSummary getIntegrationGroupSummary(String integrationGroupName)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of the requested integration group.

Parameters:

integrationGroupName - qualifiedName of the integration group to target

Returns:

integration group summary

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

getIntegrationGroupSummaries

public List<IntegrationGroupSummary> getIntegrationGroupSummaries()
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of each integration group assigned to the Integration Daemon.

Returns:

list of integration group summaries

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

refreshConfig

public void refreshConfig(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(io.openlineage.client.OpenLineage.RunEvent 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 invalid

UserNotAuthorizedException - the caller is not authorized to call the service

PropertyServerException - there is a problem processing the request

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 invalid

UserNotAuthorizedException - the caller is not authorized to call the service

PropertyServerException - there is a problem processing the request