org.adroitlogic.x.core

Class IntegrationPlatform

java.lang.Object

org.adroitlogic.x.core.IntegrationPlatform

All Implemented Interfaces:

Initializable, Startable, XPlatform

@AutoStart(startOrder=1)
 @AutoInitialize(initOrder=1)
public class IntegrationPlatform
extends Object
implements XPlatform

The base implementation of the Project-X platform

Since:

17.01

Author:

Ruwan Linton

Constructor Summary

Constructors

Constructor and Description
IntegrationPlatform()

Method Summary

Modifier and Type	Method and Description
void	addFlowEventListener(XFlowEventListener flowEventListener)
void	destroy()
<T> CompletableFuture<T>	executeCompletionAsync(CompletableFuture<T> completableFuture, BiConsumer<T,Throwable> action)
<T> CompletableFuture<T>	executeCompletionAsync(CompletableFuture<T> completableFuture, BiConsumer<T,Throwable> action, XProcessingElement processingElement)
<T> ScheduledFuture	expireCompletableFutureAfter(CompletableFuture<T> completableFuture, long delayInMillis) Alter the provided CompletableFuture to be completed with a TimeoutException after the given delay
<T> ScheduledFuture	expireCompletableFutureAfter(CompletableFuture<T> completableFuture, long delayInMillis, String timeoutMessage) Alter the provided CompletableFuture to be completed with a TimeoutException after the given delay
long	getGlobalEgressTimeout() Returns the globally set value for egress timeout.
long	getGlobalResponseTimeout() Returns the globally set value for response timeout.
Optional<XIntegrationFlowTracer>	getIntegrationFlowTracer()
XServerConfig	getServerConfig()
void	init(org.springframework.context.ApplicationContext context)
boolean	isMessageTracingEnabled()
void	notifyEndOfMessageFlow(XMessageContext messageContext) Can be used to notify the completion of a message flow, so the platform can perform clean-up tasks such as releasing resources and updating message counters.
void	notifyFlowEvent(XFlowEventNotificationContext notificationContext, XFlowEventNotificationContext.XFlowEventType flowEventType, ExecutionResult executionResult)
CompletableFuture<ExecutionResult>	processAsync(XMessageContext messageContext, XProcessingElement processingElement)
ExecutionResult	processSync(XMessageContext messageContext, XProcessingElement processingElement)
Future<ExecutionResult>	receive(XIngressConnectorElement connector, XMessageContext messageContext, CompletableFuture<XMessageContext> flowCompletionFuture, ExchangePattern exchangePattern)
Future<ExecutionResult>	receiveResponse(XEgressConnectorElement connector, XMessageContext messageContext)
ExecutionResult	receiveResponseSync(XEgressConnectorElement connector, XMessageContext messageContext)
ScheduledFuture	scheduleTimeoutForMessageContext(XMessageContext xMessageContext, long delayInMillis) Schedules a task that will flag the given XMessageContext as timed-out after the given time delay
void	setExecutorService(ExecutorService executorService)
void	setFlowEventListeners(List<XFlowEventListener> flowEventListeners)
void	setGlobalEgressTimeout(long globalEgressTimeout)
void	setGlobalResponseTimeout(long globalResponseTimeout)
void	setIntegrationFlowTracer(XIntegrationFlowTracer integrationFlowTracer)
void	setScheduledThreadPool(ScheduledThreadPoolExecutor scheduledThreadPool)
void	start()
void	stop()
void	subscribeForMessageCount(XMessageCountSubscriber subscriber) Registers a subscriber for message count change notifications

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrationPlatform

public IntegrationPlatform()

Method Detail

init

public void init(org.springframework.context.ApplicationContext context)

Specified by:

init in interface Initializable

destroy

public void destroy()

Specified by:

destroy in interface Initializable

receive

public Future<ExecutionResult> receive(XIngressConnectorElement connector,
                                       XMessageContext messageContext,
                                       CompletableFuture<XMessageContext> flowCompletionFuture,
                                       ExchangePattern exchangePattern)

Specified by:

receive in interface XPlatform

receiveResponse

public Future<ExecutionResult> receiveResponse(XEgressConnectorElement connector,
                                               XMessageContext messageContext)

Specified by:

receiveResponse in interface XPlatform

receiveResponseSync

public ExecutionResult receiveResponseSync(XEgressConnectorElement connector,
                                           XMessageContext messageContext)

Specified by:

receiveResponseSync in interface XPlatform

processAsync

public CompletableFuture<ExecutionResult> processAsync(XMessageContext messageContext,
                                                       XProcessingElement processingElement)

Specified by:

processAsync in interface XPlatform

processSync

public ExecutionResult processSync(XMessageContext messageContext,
                                   XProcessingElement processingElement)

Specified by:

processSync in interface XPlatform

executeCompletionAsync

public <T> CompletableFuture<T> executeCompletionAsync(CompletableFuture<T> completableFuture,
                                                       BiConsumer<T,Throwable> action)

Specified by:

executeCompletionAsync in interface XPlatform

executeCompletionAsync

public <T> CompletableFuture<T> executeCompletionAsync(CompletableFuture<T> completableFuture,
                                                       BiConsumer<T,Throwable> action,
                                                       XProcessingElement processingElement)

Specified by:

executeCompletionAsync in interface XPlatform

start

public void start()

Specified by:

start in interface Startable

stop

public void stop()

Specified by:

stop in interface Startable

setExecutorService

public void setExecutorService(ExecutorService executorService)

setScheduledThreadPool

public void setScheduledThreadPool(ScheduledThreadPoolExecutor scheduledThreadPool)

expireCompletableFutureAfter

public <T> ScheduledFuture expireCompletableFutureAfter(CompletableFuture<T> completableFuture,
                                                        long delayInMillis)

Description copied from interface: XPlatform

Alter the provided CompletableFuture to be completed with a TimeoutException after the given delay

Specified by:

expireCompletableFutureAfter in interface XPlatform

Type Parameters:

T - return type of the CompletableFuture

Parameters:

completableFuture - instance of CompletableFuture to be altered

delayInMillis - delay in milliseconds before expiring

Returns:

ScheduledFuture for the expiration task

expireCompletableFutureAfter

public <T> ScheduledFuture expireCompletableFutureAfter(CompletableFuture<T> completableFuture,
                                                        long delayInMillis,
                                                        String timeoutMessage)

Description copied from interface: XPlatform

Alter the provided CompletableFuture to be completed with a TimeoutException after the given delay

Specified by:

expireCompletableFutureAfter in interface XPlatform

Type Parameters:

T - return type of the CompletableFuture

Parameters:

completableFuture - instance of CompletableFuture to be altered

delayInMillis - delay in milliseconds before expiring

timeoutMessage - Message to be included for the resulting TimeoutException

Returns:

ScheduledFuture for the expiration task

scheduleTimeoutForMessageContext

public ScheduledFuture scheduleTimeoutForMessageContext(XMessageContext xMessageContext,
                                                        long delayInMillis)

Description copied from interface: XPlatform

Schedules a task that will flag the given XMessageContext as timed-out after the given time delay

Specified by:

scheduleTimeoutForMessageContext in interface XPlatform

Parameters:

xMessageContext - XMessageContext instance to be flagged as timed-out

delayInMillis - time-out delay in milliseconds

Returns:

an instance of ScheduledFuture representing the scheduled task, or will return null if the given delay is negative

getGlobalResponseTimeout

public long getGlobalResponseTimeout()

Description copied from interface: XPlatform

Returns the globally set value for response timeout. If an ingress connector with a response path does not specify a response timeout itself, this global timeout will be used.

Specified by:

getGlobalResponseTimeout in interface XPlatform

Returns:

the global response timeout in milliseconds

getGlobalEgressTimeout

public long getGlobalEgressTimeout()

Description copied from interface: XPlatform

Returns the globally set value for egress timeout. If an egress connector with a response path does not specify an egress timeout itself, this global timeout will be used.

Specified by:

getGlobalEgressTimeout in interface XPlatform

Returns:

the global egress timeout in milliseconds

getIntegrationFlowTracer

public Optional<XIntegrationFlowTracer> getIntegrationFlowTracer()

Specified by:

getIntegrationFlowTracer in interface XPlatform

isMessageTracingEnabled

public boolean isMessageTracingEnabled()

Specified by:

isMessageTracingEnabled in interface XPlatform

setGlobalResponseTimeout

public void setGlobalResponseTimeout(long globalResponseTimeout)

setGlobalEgressTimeout

public void setGlobalEgressTimeout(long globalEgressTimeout)

setIntegrationFlowTracer

public void setIntegrationFlowTracer(XIntegrationFlowTracer integrationFlowTracer)

setFlowEventListeners

public void setFlowEventListeners(List<XFlowEventListener> flowEventListeners)

Specified by:

setFlowEventListeners in interface XPlatform

addFlowEventListener

public void addFlowEventListener(XFlowEventListener flowEventListener)

Specified by:

addFlowEventListener in interface XPlatform

notifyFlowEvent

public void notifyFlowEvent(XFlowEventNotificationContext notificationContext,
                            XFlowEventNotificationContext.XFlowEventType flowEventType,
                            ExecutionResult executionResult)

Specified by:

notifyFlowEvent in interface XPlatform

getServerConfig

public XServerConfig getServerConfig()

Specified by:

getServerConfig in interface XPlatform

notifyEndOfMessageFlow

public void notifyEndOfMessageFlow(XMessageContext messageContext)

Description copied from interface: XPlatform

Can be used to notify the completion of a message flow, so the platform can perform clean-up tasks such as releasing resources and updating message counters.

This method is only intended to be used by the MessageReceiver class and any other use is highly discouraged.

Specified by:

notifyEndOfMessageFlow in interface XPlatform

Parameters:

messageContext - XMessageContext related to the completed message flow

subscribeForMessageCount

public void subscribeForMessageCount(XMessageCountSubscriber subscriber)

Description copied from interface: XPlatform

Registers a subscriber for message count change notifications

Specified by:

subscribeForMessageCount in interface XPlatform

Parameters:

subscriber - XMessageCountSubscriber instance to be registered