org.adroitlogic.x.base.connector.call

Class CallOutEgressConnectorElement

java.lang.Object

org.adroitlogic.x.base.processor.AbstractProcessingElement

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

org.adroitlogic.x.base.connector.AbstractBiDirectionalEgressConnectorElement<SelfSenderConfig,BareEgressContext>

org.adroitlogic.x.base.connector.call.CallOutEgressConnectorElement

All Implemented Interfaces:

XEgressConnectorElement<SelfSenderConfig,BareEgressContext>, Initializable, MetricsReportable, XProcessingElement, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

CallOutTypedEgressConnectorElement

public abstract class CallOutEgressConnectorElement
extends AbstractBiDirectionalEgressConnectorElement<SelfSenderConfig,BareEgressContext>

A call-out egress connector element that can be used as the base class for a blocking call-out using a Java client library such as Facebook of Amazon SDK to call out get a response and re-inject the response to the engine

Since:

17.07.1

Author:

Ruwan Linton

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
CallOutEgressConnectorElement()

Method Summary

Modifier and Type	Method and Description
BareEgressContext	getEgressContext(XMessageContext messageContext) Gives the bare egress context without any information on the connector context as the connector is supposed to be keeping all its context information
SelfSenderConfig	getSenderConfig() Gives the sender configuration without any connector or transport specific information, as the call-out and the one-way egress connectors are supposed to be using the configuration within the connector without passing anything to the transport layer
protected TransportSender<SelfSenderConfig,BareEgressContext>	newSender(org.springframework.context.ApplicationContext context) Gives the wrapped transport sender for the call-out operation
protected void	prepareResponse(XMessageContext messageContext) A blank method implementation for the prepare response as the response is anyway been provided by the sendReceiveMessage(XMessageContext) method of this same class
(package private) ExecutionResult	sendReceive(XMessageContext messageContext) CallOut transport sender uses this method to invoke the actual send receive operation and injects the response back to the caller
protected abstract XMessage	sendReceiveMessage(XMessageContext messageContext) Uses the message context passed into this method to invoke the client library call of the SDK and returns the composed response message to be injected back into the engine as the resulting response of the invocation.

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

getResponseProcessor, initBiEgressConnector, initEgressConnector, receiveResponse, setResponseProcessor

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

continueFlow, getAdditionalProperties, getIntegrationFlow, getOperation, getSender, getSenderExchangePattern, getSendingFailedStream, getSendingSuccessStream, getWeight, initElement, process, 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.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

CallOutEgressConnectorElement

public CallOutEgressConnectorElement()

Method Detail

sendReceiveMessage

protected abstract XMessage sendReceiveMessage(XMessageContext messageContext)

Uses the message context passed into this method to invoke the client library call of the SDK and returns the composed response message to be injected back into the engine as the resulting response of the invocation. This method has to be implemented by any egress connector that emulates an existing client library

Parameters:

messageContext - the message context to be used for the invocation

Returns:

the resulting response message of the invocation

sendReceive

ExecutionResult sendReceive(XMessageContext messageContext)

CallOut transport sender uses this method to invoke the actual send receive operation and injects the response back to the caller

Parameters:

messageContext - the message to be sent

Returns:

the execution result of the send/receive operation

getSenderConfig

public SelfSenderConfig getSenderConfig()

Gives the sender configuration without any connector or transport specific information, as the call-out and the one-way egress connectors are supposed to be using the configuration within the connector without passing anything to the transport layer

Returns:

a self sender configuration without connector nor transport specific information

getEgressContext

public BareEgressContext getEgressContext(XMessageContext messageContext)

Gives the bare egress context without any information on the connector context as the connector is supposed to be keeping all its context information

Parameters:

messageContext - message context to create the bare egress context

Returns:

the bare egress context singleton instance

newSender

protected TransportSender<SelfSenderConfig,BareEgressContext> newSender(org.springframework.context.ApplicationContext context)

Gives the wrapped transport sender for the call-out operation

Specified by:

newSender in class EgressConnectorElement<SelfSenderConfig,BareEgressContext>

Parameters:

context - the application context used for the sender creation

Returns:

the call-out transport sender that calls back to the connector for the send receive operation

prepareResponse

protected final void prepareResponse(XMessageContext messageContext)

A blank method implementation for the prepare response as the response is anyway been provided by the sendReceiveMessage(XMessageContext) method of this same class

Specified by:

prepareResponse in class AbstractBiDirectionalEgressConnectorElement<SelfSenderConfig,BareEgressContext>

Parameters:

messageContext - XMessageContext object containing the response message