org.adroitlogic.x.base.connector

Class EgressConnectorElement<S extends SenderConfig,C extends EgressContext>

java.lang.Object

org.adroitlogic.x.base.processor.AbstractProcessingElement

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractBiDirectionalEgressConnectorElement, OneWayEgressConnectorElement, UniDirectionalResponseEgressConnectorElement

@MetricsReporter
public abstract class EgressConnectorElement<S extends SenderConfig,C extends EgressContext>
extends AbstractProcessingElement
implements XEgressConnectorElement<S,C>, MetricsReportable

The base class that defines an EgressConnector. All egress connectors must inherit this class

Since:

17.01

Author:

Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
protected org.adroitlogic.x.logging.Logger	logger

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

beanName, context, flowId, project, status

Constructor Summary

Constructors

Constructor and Description
EgressConnectorElement()

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.
Map<String,String>	getAdditionalProperties() Returns a map of additional properties to be set in the metrics records
XIntegrationFlow	getIntegrationFlow()
protected XConnectorOperationElement	getOperation()
protected TransportSender<S,C>	getSender()
ExchangePattern	getSenderExchangePattern()
protected int	getSendingFailedStream()
protected int	getSendingSuccessStream()
int	getWeight()
protected void	initEgressConnector(org.springframework.context.ApplicationContext context)
protected void	initElement(org.springframework.context.ApplicationContext context)
protected abstract TransportSender<S,C>	newSender(org.springframework.context.ApplicationContext context) Connector implementation should create the sender and return without initialization or starting of the sender
ExecutionResult	process(XMessageContext messageContext)
ExecutionResult	receiveResponse(XMessageContext messageContext)
ExecutionResult	sendMessage(XMessageContext messageContext)
protected void	setEgressFuture(XMessageContext messageContext, XPlatform platform)
void	setIntegrationFlow(XIntegrationFlow integrationFlow)
void	setOperation(XConnectorOperationElement operation)
void	setWeight(int weight)

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

Field Detail

logger

protected final org.adroitlogic.x.logging.Logger logger

Constructor Detail

EgressConnectorElement

public EgressConnectorElement()

Method Detail

initElement

protected final void initElement(org.springframework.context.ApplicationContext context)

Overrides:

initElement in class AbstractProcessingElement

initEgressConnector

protected void initEgressConnector(org.springframework.context.ApplicationContext context)

newSender

protected abstract TransportSender<S,C> newSender(org.springframework.context.ApplicationContext context)

Connector implementation should create the sender and return without initialization or starting of the sender

Parameters:

context - the application context used for the sender creation

Returns:

the newly created sender instance

process

public final ExecutionResult process(XMessageContext messageContext)

Specified by:

process in class AbstractProcessingElement

sendMessage

public final ExecutionResult sendMessage(XMessageContext messageContext)

Specified by:

sendMessage in interface XEgressConnectorElement<S extends SenderConfig,C extends EgressContext>

setEgressFuture

protected void setEgressFuture(XMessageContext messageContext,
                               XPlatform platform)

continueFlow

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. 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

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

receiveResponse

public ExecutionResult receiveResponse(XMessageContext messageContext)

Specified by:

receiveResponse in interface XEgressConnectorElement<S extends SenderConfig,C extends EgressContext>

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Description copied from interface: MetricsReportable

Returns a map of additional properties to be set in the metrics records

Specified by:

getAdditionalProperties in interface MetricsReportable

Overrides:

getAdditionalProperties in class AbstractProcessingElement

Returns:

additional properties

setOperation

public void setOperation(XConnectorOperationElement operation)

getWeight

public int getWeight()

setWeight

public void setWeight(int weight)

getSenderExchangePattern

public ExchangePattern getSenderExchangePattern()

getSendingSuccessStream

protected int getSendingSuccessStream()

getSendingFailedStream

protected int getSendingFailedStream()

getIntegrationFlow

public XIntegrationFlow getIntegrationFlow()

Specified by:

getIntegrationFlow in interface XEgressConnectorElement<S extends SenderConfig,C extends EgressContext>

setIntegrationFlow

public void setIntegrationFlow(XIntegrationFlow integrationFlow)

Specified by:

setIntegrationFlow in interface XEgressConnectorElement<S extends SenderConfig,C extends EgressContext>

getSender

protected TransportSender<S,C> getSender()

getOperation

protected XConnectorOperationElement getOperation()