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

Class IntegrationDaemonInstance

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstance

org.odpi.openmetadata.commonservices.multitenant.GovernanceServerServiceInstance

org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.IntegrationDaemonInstance

public class IntegrationDaemonInstance
extends GovernanceServerServiceInstance

IntegrationDaemonInstance maintains the instance information needed to execute requests on behalf of an integration daemon. The integration daemon is running

Field Summary

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

accessServiceInTopicName, accessServiceOutTopicName, accessServiceRootURL, accessServiceServerName, invalidParameterHandler

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

auditLog, localServerUserId

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

maxPageSize, securityVerifier, serverName, serviceName

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfigurationProperties(String connectorName)	Retrieve the configuration properties of the named connector.
List<IntegrationConnectorReport>	getConnectorReports()	Retrieve all the connectors.
void	refreshConnector(String connectorName)	Refresh all the connectors, or a specific connector if a connector name is supplied.
void	restartConnector(String connectorName)	Restart all the connectors, or a specific connector if a connector name is supplied.
void	shutdown()	Shutdown the integration daemon
void	updateConfigurationProperties(String userId, String connectorName, boolean isMergeUpdate, Map<String,Object> configurationProperties)	Update the configuration properties of a specific named connector.
void	updateConnectorConnection(String userId, String connectorName, Connection connection)	Update the connection for a specific integration connector.
void	updateEndpointNetworkAddress(String userId, String connectorName, String networkAddress)	Update the endpoint network address for a specific integration connector.

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

getAuditLog

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

getInvalidParameterHandler, getServerName, getServiceInstanceStatus, getServiceName, setMaxPageSize, setSecurityVerifier, setServerName, setServiceInstanceStatus

Methods inherited from class java.lang.Object

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

Method Details

getConfigurationProperties

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

Retrieve the configuration properties of the named connector.

Parameters:

connectorName - name of a specific connector

Returns:

property map

Throws:

InvalidParameterException - the connector name is not recognized

updateConfigurationProperties

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

Update the configuration properties of a specific named connector.

Parameters:

userId - calling user

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

updateEndpointNetworkAddress

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

Update the endpoint network address for a specific integration connector.

Parameters:

userId - calling user

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 connectorName,
 Connection connection)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the connection for a specific integration connector.

Parameters:

userId - calling user

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

getConnectorReports

public List<IntegrationConnectorReport> getConnectorReports()

Retrieve all the connectors.

refreshConnector

public void refreshConnector(String connectorName)
                      throws InvalidParameterException

Refresh all the connectors, or a specific connector if a connector name is supplied.

Parameters:

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

Throws:

InvalidParameterException - the connector name is not recognized

restartConnector

public void restartConnector(String connectorName)
                      throws InvalidParameterException

Restart all the connectors, or a specific connector if a connector name is supplied.

Parameters:

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

Throws:

InvalidParameterException - the connector name is not recognized

shutdown

public void shutdown()

Shutdown the integration daemon

Overrides:

shutdown in class OMAGServerServiceInstance