org.springframework.integration.file.remote.aop

Class RotatingServerAdvice

java.lang.Object

org.springframework.integration.file.remote.aop.RotatingServerAdvice

All Implemented Interfaces:

Advice, Interceptor, MethodInterceptor, MessageSourceMutator, ReceiveMessageAdvice

public class RotatingServerAdvice
extends Object
implements MessageSourceMutator

A smart poller advice that rotates across multiple remote servers/directories.

Since:

5.0.7

Author:

Gary Russell, Michael Forstner, Artem Bilan, David Turanski

Constructor Summary

Constructors

Constructor and Description
RotatingServerAdvice(DelegatingSessionFactory<?> factory, List<RotationPolicy.KeyDirectory> keyDirectories) Create an instance that rotates to the next server/directory if no message is received.
RotatingServerAdvice(DelegatingSessionFactory<?> factory, List<RotationPolicy.KeyDirectory> keyDirectories, boolean fair) Create an instance that rotates to the next server/directory depending on the fair argument.
RotatingServerAdvice(RotationPolicy rotationPolicy) Construct an instance that rotates according to the supplied RotationPolicy.

Method Summary

Modifier and Type	Method and Description
Message<?>	afterReceive(Message<?> result, MessageSource<?> source) Subclasses can take actions based on the result of the poll; e.g.
boolean	beforeReceive(MessageSource<?> source) Subclasses can decide whether to proceed with this poll.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.aop.MessageSourceMutator

afterReceive, beforeReceive

Methods inherited from interface org.springframework.integration.aop.ReceiveMessageAdvice

invoke

Constructor Detail

RotatingServerAdvice

public RotatingServerAdvice(DelegatingSessionFactory<?> factory,
                            List<RotationPolicy.KeyDirectory> keyDirectories)

Create an instance that rotates to the next server/directory if no message is received.

Parameters:

factory - the DelegatingSessionFactory.

keyDirectories - a list of RotationPolicy.KeyDirectory.

RotatingServerAdvice

public RotatingServerAdvice(DelegatingSessionFactory<?> factory,
                            List<RotationPolicy.KeyDirectory> keyDirectories,
                            boolean fair)

Create an instance that rotates to the next server/directory depending on the fair argument.

Parameters:

factory - the DelegatingSessionFactory.

keyDirectories - a list of RotationPolicy.KeyDirectory.

fair - true to rotate on every poll, false to rotate when no message is received.

RotatingServerAdvice

public RotatingServerAdvice(RotationPolicy rotationPolicy)

Construct an instance that rotates according to the supplied RotationPolicy.

Parameters:

rotationPolicy - the policy.

Method Detail

beforeReceive

public boolean beforeReceive(MessageSource<?> source)

Description copied from interface: MessageSourceMutator

Subclasses can decide whether to proceed with this poll.

Specified by:

beforeReceive in interface MessageSourceMutator

Parameters:

source - the message source.

Returns:

true to proceed (default).

afterReceive

@Nullable
public Message<?> afterReceive(@Nullable
                                         Message<?> result,
                                         MessageSource<?> source)

Description copied from interface: MessageSourceMutator

Subclasses can take actions based on the result of the poll; e.g. adjust the trigger. The message can also be replaced with a new one.

Specified by:

afterReceive in interface MessageSourceMutator

Parameters:

result - the received message.

source - the message source.

Returns:

a message to continue to process the result, null to discard whatever the poll returned.