Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.server

Class IntegrationDaemonInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.GovernanceServerServiceInstanceHandler

org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.IntegrationDaemonInstanceHandler

public class IntegrationDaemonInstanceHandler
extends GovernanceServerServiceInstanceHandler

IntegrationDaemonInstanceHandler retrieves information from the instance map for the integration daemon instances. The instance map is thread-safe. Instances are added and removed by the IntegrationDaemonOperationalServices class.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.GovernanceServerServiceInstanceHandler

invalidParameterHandler

Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor	Description
IntegrationDaemonInstanceHandler()	Default constructor registers the access service

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfigurationProperties(String userId, String serverName, String serviceOperationName, String connectorName)	Retrieve the configuration properties of the named connector.
IntegrationContextManager	getIntegrationServiceContextManager(String userId, String serverName, String serviceURLMarker, String serviceOperationName)	Retrieve the specific context manager for the requested integration service.
IntegrationServiceHandler	getIntegrationServiceHandler(String userId, String serverName, String serviceURLMarker, String serviceOperationName)	Retrieve the specific handler for the requested integration service.
void	refreshConnector(String userId, String serverName, String serviceOperationName, String connectorName)	Refresh the named connector.
void	restartConnector(String userId, String serverName, String serviceOperationName, String connectorName)	Restart the named connector.
void	updateConfigurationProperties(String userId, String serverName, String serviceOperationName, String connectorName, boolean isMergeUpdate, Map<String,Object> configurationProperties)	Update the configuration properties of the named connector.
void	updateConnectorConnection(String userId, String serverName, String serviceOperationName, String connectorName, Connection connection)	Update the connection for a specific integration connector.
void	updateEndpointNetworkAddress(String userId, String serverName, String serviceOperationName, String connectorName, String networkAddress)	Update the endpoint network address for a specific integration connector.

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.GovernanceServerServiceInstanceHandler

validateConnector

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

getAuditLog

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

getServerSecurityVerifier, getServerServiceInstance, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Constructor Details

IntegrationDaemonInstanceHandler

public IntegrationDaemonInstanceHandler()

Default constructor registers the access service

Method Details

getIntegrationServiceHandler

public IntegrationServiceHandler getIntegrationServiceHandler(String userId,
 String serverName,
 String serviceURLMarker,
 String serviceOperationName)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the specific handler for the requested integration service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceURLMarker - marker that identifies the called service in the URL

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

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

getIntegrationServiceContextManager

public IntegrationContextManager getIntegrationServiceContextManager(String userId,
 String serverName,
 String serviceURLMarker,
 String serviceOperationName)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the specific context manager for the requested integration service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceURLMarker - marker that identifies the called service in the URL

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

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

getConfigurationProperties

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

Retrieve the configuration properties of the named connector.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

connectorName - name of a specific connector

Returns:

property map

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException - user does not have access to the requested server

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

updateConfigurationProperties

public void updateConfigurationProperties(String userId,
 String serverName,
 String serviceOperationName,
 String connectorName,
 boolean isMergeUpdate,
 Map<String,Object> configurationProperties)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the configuration properties of the named connector.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

connectorName - name of a specific connector

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 does not have access to the requested server

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

updateEndpointNetworkAddress

public void updateEndpointNetworkAddress(String userId,
 String serverName,
 String serviceOperationName,
 String connectorName,
 String networkAddress)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the endpoint network address for a specific integration connector.

Parameters:

serverName - integration daemon server name

userId - calling user

serviceOperationName - calling method

connectorName - name of a specific connector

networkAddress - name of a specific connector or null for all connectors and the properties to change

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException - user does not have access to the requested server

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

updateConnectorConnection

public void updateConnectorConnection(String userId,
 String serverName,
 String serviceOperationName,
 String connectorName,
 Connection connection)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the connection for a specific integration connector.

Parameters:

serverName - integration daemon server name

userId - calling user

serviceOperationName - calling method

connectorName - name of a specific connector

connection - new connection object

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException - user does not have access to the requested server

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

refreshConnector

public void refreshConnector(String userId,
 String serverName,
 String serviceOperationName,
 String connectorName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Refresh the named connector.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

connectorName - name of a specific connector

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException - user does not have access to the requested server

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

restartConnector

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

Restart the named connector.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

connectorName - name of a specific connector

Throws:

InvalidParameterException - the connector name is not recognized

UserNotAuthorizedException - user does not have access to the requested server

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