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

Class IntegrationDaemon

java.lang.Object

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

All Implemented Interfaces:

IntegrationDaemonAPI

public class IntegrationDaemon
extends Object
implements IntegrationDaemonAPI

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)	Create a new client with no authentication embedded in the HTTP request.
IntegrationDaemon(String serverName, String serverPlatformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
IntegrationDaemon(String serverName, String serverPlatformRootURL, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
IntegrationDaemon(String serverName, String serverPlatformRootURL, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfigurationProperties(String userId, String connectorName)	Retrieve the configuration properties of the named connector.
IntegrationDaemonStatus	getIntegrationDaemonStatus(String userId)	Return a summary of each of the integration services' and integration groups' status.
List<IntegrationGroupSummary>	getIntegrationGroupSummaries(String userId)	Retrieve the description and status of each integration group assigned to the Integration Daemon.
IntegrationGroupSummary	getIntegrationGroupSummary(String userId, String integrationGroupName)	Retrieve the description and status of the requested integration group.
List<IntegrationServiceSummary>	getIntegrationServicesSummaries(String userId)	Return a summary of each of the integration services' status.
void	refreshConfig(String userId, String integrationGroupName)	Request that the integration group refresh its configuration by calling the metadata server.
void	refreshConnector(String userId, String connectorName)	Issue a refresh() request on a specific connector
void	refreshConnectors(String userId)	Issue a refresh() request on a connector running in the integration daemon.
void	refreshService(String userId, String serviceURLMarker, String connectorName)	Refresh the requested connectors running in the requested integration service.
void	restartConnector(String userId, String connectorName)	Issue a restart() request on a specific connector
void	restartConnectors(String userId)	Issue a restart() request on a connector running in the integration daemon.
void	restartService(String userId, String serviceURLMarker, String connectorName)	Request that the integration service shutdown and recreate its integration connectors.
void	updateConfigurationProperties(String userId, 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 userId, String connectorName, Connection connection)	Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
void	updateEndpointNetworkAddress(String userId, String connectorName, String networkAddress)	Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

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,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with no 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)
                  throws InvalidParameterException

Create a new client with no 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.

IntegrationDaemon

public IntegrationDaemon(String serverName,
 String serverPlatformRootURL,
 String userId,
 String password,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - 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

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,
 String userId,
 String password)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - 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

Throws:

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

Method Details

getConfigurationProperties

public Map<String,Object> getConfigurationProperties(String userId,
 String connectorName)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the configuration properties of the named connector.

Specified by:

getConfigurationProperties in interface IntegrationDaemonAPI

Parameters:

userId - calling user

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 userId,
 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.

Specified by:

updateConfigurationProperties in interface IntegrationDaemonAPI

Parameters:

userId - calling user

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 - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration daemon

updateEndpointNetworkAddress

public void updateEndpointNetworkAddress(String userId,
 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:

userId - calling user

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 userId,
 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:

userId - calling user

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 userId,
 String connectorName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a refresh() request on a specific connector

Parameters:

userId - calling user

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(String userId)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

userId - calling user

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 userId,
 String connectorName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a restart() request on a specific connector

Parameters:

userId - calling user

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(String userId)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

userId - calling user

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

refreshService

public void refreshService(String userId,
 String serviceURLMarker,
 String connectorName)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Refresh the requested connectors running in the requested integration service.

Specified by:

refreshService in interface IntegrationDaemonAPI

Parameters:

userId - calling user

serviceURLMarker - integration service identifier

connectorName - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.

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

restartService

public void restartService(String userId,
 String serviceURLMarker,
 String connectorName)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that the integration service shutdown and recreate its integration connectors. If a connector name is provided, only that connector is restarted.

Specified by:

restartService in interface IntegrationDaemonAPI

Parameters:

userId - calling user

serviceURLMarker - integration service identifier

connectorName - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are restarted.

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(String userId)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getIntegrationDaemonStatus in interface IntegrationDaemonAPI

Parameters:

userId - calling user

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

getIntegrationServicesSummaries

public List<IntegrationServiceSummary> getIntegrationServicesSummaries(String userId)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getIntegrationServicesSummaries in interface IntegrationDaemonAPI

Parameters:

userId - calling user

Returns:

list of statuses - one for each assigned integration services or

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 userId,
 String integrationGroupName)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of the requested integration group.

Specified by:

getIntegrationGroupSummary in interface IntegrationDaemonAPI

Parameters:

userId - calling user

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(String userId)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getIntegrationGroupSummaries in interface IntegrationDaemonAPI

Parameters:

userId - calling user

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 userId,
 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.

Specified by:

refreshConfig in interface IntegrationDaemonAPI

Parameters:

userId - identifier of calling user

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.