org.adroitlogic.x.management.rest.service

Class IntegrationFlowManagementService

java.lang.Object

org.adroitlogic.x.management.rest.service.IntegrationFlowManagementService

public class IntegrationFlowManagementService
extends Object

Service class to obtain Integration flow related resources

Since:

17.07

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
IntegrationFlowManagementService()

Method Summary

Modifier and Type	Method and Description
List<ConnectorResource>	getEgressConnectors(String projectId, String version, String flowId) Returns a list of ConnectorResources representing the egress connectors of the integration flow
FlowResource	getFlow(String projectId, String version, String flowId) Returns FlowResource representing the integration flow that has the given flowId and belongs to a project with the given projectId and version.
String	getFlowXPos(String projectId, String version, String flowId) Returns String containing the XPos JSON content of the integration flow that has the given flowId and belongs to a project with the given projectId and version.
List<ConnectorResource>	getIngressConnectors(String projectId, String version, String flowId) Returns a list of ConnectorResources representing the ingress connectors of the integration flow
(package private) List<ConnectorResource>	getIngressConnectors(XIntegrationFlow integrationFlow) Returns a list of ConnectorResources representing the ingress connectors of the integration flow

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrationFlowManagementService

public IntegrationFlowManagementService()

Method Detail

getFlow

public FlowResource getFlow(String projectId,
                            String version,
                            String flowId)
                     throws ManagementServiceException

Returns FlowResource representing the integration flow that has the given flowId and belongs to a project with the given projectId and version. This FlowResource object will not contain information on the connectors.

Parameters:

projectId - Id of the integration project

version - version of the integration project

flowId - Id of the integration flow within the project

Returns:

the details of the integration flow

Throws:

ManagementServiceException - if fails to obtain the integration flow details or when a project is not found with the given ID

getFlowXPos

public String getFlowXPos(String projectId,
                          String version,
                          String flowId)
                   throws ManagementServiceException

Returns String containing the XPos JSON content of the integration flow that has the given flowId and belongs to a project with the given projectId and version.

Parameters:

projectId - Id of the integration project

version - version of the integration project

flowId - Id of the integration flow within the project

Returns:

String containing the XPos JSON content of the integration flow or null if xpos file not found

Throws:

ManagementServiceException - if fails to obtain the integration flow xpos details or when a project is not found with the given ID

getIngressConnectors

public List<ConnectorResource> getIngressConnectors(String projectId,
                                                    String version,
                                                    String flowId)
                                             throws ManagementServiceException

Returns a list of ConnectorResources representing the ingress connectors of the integration flow

Parameters:

projectId - Id of the integration project

version - version of the integration project

flowId - Id of the integration flow within the project

Returns:

the details of the integration flow ingress connectors

Throws:

ManagementServiceException - if fails to obtain the integration flow ingress connector details or when a project is not found with the given ID

getIngressConnectors

List<ConnectorResource> getIngressConnectors(XIntegrationFlow integrationFlow)
                                      throws ManagementServiceException

Returns a list of ConnectorResources representing the ingress connectors of the integration flow

Parameters:

integrationFlow - XIntegrationFlow instance to get ingress connector information

Returns:

the details of the integration flow ingress connectors

Throws:

ManagementServiceException - if failed to retrieve ingress connector information

getEgressConnectors

public List<ConnectorResource> getEgressConnectors(String projectId,
                                                   String version,
                                                   String flowId)
                                            throws ManagementServiceException

Returns a list of ConnectorResources representing the egress connectors of the integration flow

Parameters:

projectId - Id of the integration project

version - version of the integration project

flowId - Id of the integration flow within the project

Returns:

the details of the integration flow egress connectors

Throws:

ManagementServiceException - if fails to obtain the integration flow egress connector details or when a project is not found with the given ID