org.adroitlogic.x.base.connector

Class UniDirectionalResponseEgressConnectorElement<S extends SenderConfig,C extends EgressContext>

java.lang.Object

org.adroitlogic.x.base.processor.AbstractProcessingElement

org.adroitlogic.x.base.connector.EgressConnectorElement<S,C>

org.adroitlogic.x.base.connector.UniDirectionalResponseEgressConnectorElement<S,C>

All Implemented Interfaces:

XEgressConnectorElement<S,C>, Initializable, MetricsReportable, XProcessingElement, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public abstract class UniDirectionalResponseEgressConnectorElement<S extends SenderConfig,C extends EgressContext>
extends EgressConnectorElement<S,C>

This class should be extended by out-only EgressConnectors (E.g: JMSEgressConnectors) which provides the facility for the developers to continue the flow after sending the message to an external system which does not return a response.

As an example, an out-only EgressConnector such as a JMSEgressConnector will send the message to an external JMS endpoint and the external endpoint will not return a response and the integration flow will be completed. In that case if the JMSEgressConnector is extended by UniDirectionalResponseEgressConnectorElement, developer will be able to continue the integration flow with the original message which has been sent to the external system, if the message was successfully delivered to the external endpoint.

NOTE: For any EgressConnector which extends UniDirectionalResponseEgressConnectorElement, it is a MUST for the corresponding TransportSender to specify its exchange pattern to be ExchangePattern.OUT_IN

Since:

17.07

Author:

Sajith Dilshan

Field Summary

Fields inherited from class org.adroitlogic.x.base.connector.EgressConnectorElement

logger

Fields inherited from class org.adroitlogic.x.base.processor.AbstractProcessingElement

beanName, context, flowId, project, status

Constructor Summary

Constructors

Constructor and Description
UniDirectionalResponseEgressConnectorElement()

Method Summary

Modifier and Type	Method and Description
protected ExecutionResult	continueFlow(ExecutionResult sendingStatus, XMessageContext messageContext) The implementation of this method is responsible for continuing the execution of the message flow after the message has been sent out to an external system which does not return a response.
XProcessingElement	getResponseProcessor()
boolean	isCompleteFlow()
void	setCompleteFlow(boolean completeFlow)
void	setResponseProcessor(XProcessingElement responseProcessor)

Methods inherited from class org.adroitlogic.x.base.connector.EgressConnectorElement

getAdditionalProperties, getIntegrationFlow, getOperation, getSender, getSenderExchangePattern, getSendingFailedStream, getSendingSuccessStream, getWeight, initEgressConnector, initElement, newSender, process, receiveResponse, sendMessage, setEgressFuture, setIntegrationFlow, setOperation, setWeight

Methods inherited from class org.adroitlogic.x.base.processor.AbstractProcessingElement

destroy, destroyElement, getBeanName, getEntityId, getErrorHandler, getFlowId, getMetricsEngine, getProject, getProjectId, getProjectVersion, getResource, getServerConfig, getStatus, init, processMessage, setBeanName, setErrorHandler, setFlowId, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.x.api.connector.XEgressConnectorElement

getEgressContext, getSenderConfig

Methods inherited from interface org.adroitlogic.x.api.processor.XProcessingElement

cast, getBeanName, getFlowId, getProject, getStatus, processMessage, setFlowId, setProject

Methods inherited from interface org.adroitlogic.x.api.dec.Initializable

destroy, init

Methods inherited from interface org.springframework.beans.factory.BeanNameAware

setBeanName

Methods inherited from interface org.adroitlogic.x.api.metrics.MetricsReportable

getEntityId, getFlowId, getMetricsEngine, getProjectId, getProjectVersion

Constructor Detail

UniDirectionalResponseEgressConnectorElement

public UniDirectionalResponseEgressConnectorElement()

Method Detail

continueFlow

protected final ExecutionResult continueFlow(ExecutionResult sendingStatus,
                                             XMessageContext messageContext)

Description copied from class: EgressConnectorElement

The implementation of this method is responsible for continuing the execution of the message flow after the message has been sent out to an external system which does not return a response. For a sample implementation refer UniDirectionalResponseEgressConnectorElement. The default implementation will return the execution result returned by the TransportSender.

NOTE: For any EgressConnector which implements this method, it is a MUST for the corresponding TransportSender to specify its exchange pattern to be ExchangePattern.OUT_IN

Overrides:

continueFlow in class EgressConnectorElement<S extends SenderConfig,C extends EgressContext>

Parameters:

sendingStatus - The ExecutionResult result returned by the TransportSender

messageContext - The XMessageContext sent to the external system

Returns:

the ExecutionResult from the rest of the flow

getResponseProcessor

public XProcessingElement getResponseProcessor()

setResponseProcessor

public void setResponseProcessor(XProcessingElement responseProcessor)

isCompleteFlow

public boolean isCompleteFlow()

setCompleteFlow

public void setCompleteFlow(boolean completeFlow)