Class IntegrationDaemonRESTServices
java.lang.Object
org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.IntegrationDaemonRESTServices
IntegrationDaemonRESTServices provides the external service implementation for an integration service
and integration group.
The IntegrationDaemonRESTServices locates the correct integration service/group instance within the correct
integration daemon instance and delegates the request.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetConfigurationProperties
(String serverName, String userId, String connectorName) Retrieve the configuration properties of the named connector.getIntegrationDaemonStatus
(String serverName, String userId) Return a summary of each of the integration services' and integration groups' status.getIntegrationGroupSummaries
(String serverName, String userId) Return a summary of each of the integration groups' status for all running engine services.getIntegrationGroupSummary
(String serverName, String userId, String integrationGroupName) Return a summary of the requested engine's status.getIntegrationServicesSummaries
(String serverName, String userId) Return a summary of each of the integration services' status.refreshConnectors
(String serverName, String userId, NameRequestBody requestBody) Request that the integration daemon refresh all the connectors in all the integration services and groupsrefreshIntegrationGroupConfig
(String serverName, String userId, String integrationGroupName) Request that the integration group refresh its configuration by calling the metadata server.refreshService
(String serverName, String userId, String serviceURLMarker, NameRequestBody requestBody) Process a refresh request.restartConnectors
(String serverName, String userId, NameRequestBody requestBody) Request that the integration daemon restart all the connectors in all the integration services and groupsrestartService
(String serverName, String userId, String serviceURLMarker, NameRequestBody requestBody) Request that the integration service shutdown and recreate its integration connectors.updateConfigurationProperties
(String serverName, String userId, ConnectorConfigPropertiesRequestBody requestBody) Update the configuration properties of the connectors, or specific connector if a connector name is supplied.updateConnectorConnection
(String serverName, String userId, String connectorName, Connection requestBody) Update the connection for a specific integration connector.updateEndpointNetworkAddress
(String serverName, String userId, String connectorName, StringRequestBody requestBody) Update the endpoint network address for a specific integration connector.
-
Constructor Details
-
IntegrationDaemonRESTServices
public IntegrationDaemonRESTServices()
-
-
Method Details
-
getConfigurationProperties
public PropertiesResponse getConfigurationProperties(String serverName, String userId, String connectorName) Retrieve the configuration properties of the named connector.- Parameters:
serverName
- integration daemon server nameuserId
- calling userconnectorName
- name of a specific connector- Returns:
- properties map or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
updateConfigurationProperties
public VoidResponse updateConfigurationProperties(String serverName, String userId, ConnectorConfigPropertiesRequestBody requestBody) Update the configuration properties of the connectors, or specific connector if a connector name is supplied.- Parameters:
serverName
- integration daemon server nameuserId
- calling userrequestBody
- name of a specific connector or null for all connectors and the properties to change- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
updateEndpointNetworkAddress
public VoidResponse updateEndpointNetworkAddress(String serverName, String userId, String connectorName, StringRequestBody requestBody) Update the endpoint network address for a specific integration connector.- Parameters:
serverName
- integration daemon server nameuserId
- calling userconnectorName
- name of a specific connectorrequestBody
- name of a specific connector or null for all connectors and the properties to change- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
updateConnectorConnection
public VoidResponse updateConnectorConnection(String serverName, String userId, String connectorName, Connection requestBody) Update the connection for a specific integration connector.- Parameters:
serverName
- integration daemon server nameuserId
- calling userconnectorName
- name of a specific connectorrequestBody
- new connection object- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
refreshConnectors
public VoidResponse refreshConnectors(String serverName, String userId, NameRequestBody requestBody) Request that the integration daemon refresh all the connectors in all the integration services and groups- Parameters:
serverName
- name of the integration daemonuserId
- identifier of calling userrequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
restartConnectors
public VoidResponse restartConnectors(String serverName, String userId, NameRequestBody requestBody) Request that the integration daemon restart all the connectors in all the integration services and groups- Parameters:
serverName
- name of the integration daemonuserId
- identifier of calling userrequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
refreshService
public VoidResponse refreshService(String serverName, String userId, String serviceURLMarker, NameRequestBody requestBody) Process a refresh request. This calls refresh on all connectors within the integration service.- Parameters:
serverName
- name of the integration daemonuserId
- identifier of calling userserviceURLMarker
- unique name of the integration servicerequestBody
- name of a specific connector to refresh - if null all connectors are refreshed- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
restartService
public VoidResponse restartService(String serverName, String userId, String serviceURLMarker, NameRequestBody requestBody) Request that the integration service shutdown and recreate its integration connectors.- Parameters:
serverName
- name of the integration daemonuserId
- identifier of calling userserviceURLMarker
- unique name of the integration servicerequestBody
- name of a specific connector to refresh - if null all connectors are restarted.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.
-
getIntegrationDaemonStatus
Return a summary of each of the integration services' and integration groups' status.- Parameters:
serverName
- integration daemon nameuserId
- calling user- Returns:
- list of statuses - on for each assigned integration services or group InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.
-
getIntegrationServicesSummaries
public IntegrationServiceSummaryResponse getIntegrationServicesSummaries(String serverName, String userId) Return a summary of each of the integration services' status.- Parameters:
serverName
- integration daemon nameuserId
- calling user- Returns:
- list of statuses - on for each assigned integration services InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.
-
refreshIntegrationGroupConfig
public VoidResponse refreshIntegrationGroupConfig(String serverName, String userId, String integrationGroupName) 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 governance server is initializing. This request just ensures that the latest configuration is in use.- Parameters:
serverName
- name of the governance server.integrationGroupName
- unique name of the integration group.userId
- identifier of calling user- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or IntegrationGroupException there was a problem detected by the integration group.
-
getIntegrationGroupSummary
public IntegrationGroupSummaryResponse getIntegrationGroupSummary(String serverName, String userId, String integrationGroupName) Return a summary of the requested engine's status.- Parameters:
userId
- calling userserverName
- name of the server tied to the requestintegrationGroupName
- qualifiedName of the requested integration group- Returns:
- list of integration group summaries or 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 IntegrationGroupSummariesResponse getIntegrationGroupSummaries(String serverName, String userId) Return a summary of each of the integration groups' status for all running engine services.- Parameters:
serverName
- integration daemon server nameuserId
- calling user- Returns:
- list of statuses - on for each assigned integration groups or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or
-