org.springframework.integration.file.remote.aop

Class StandardRotationPolicy

java.lang.Object

org.springframework.integration.file.remote.aop.StandardRotationPolicy

All Implemented Interfaces:

RotationPolicy

public class StandardRotationPolicy
extends Object
implements RotationPolicy

Standard rotation policy; iterates over key/directory pairs; when the end is reached, starts again at the beginning. If the fair option is true the rotation occurs on every poll, regardless of result. Otherwise rotation occurs when the current pair returns no message. Subclasses implement onRotation(MessageSource<?> source) to configure the MessageSource on each rotation.

Since:

5.2

Author:

Gary Russell, Michael Forstner, Artem Bilan, David Turanski

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.file.remote.aop.RotationPolicy

RotationPolicy.KeyDirectory

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger

Constructor Summary

Constructors

Constructor and Description
StandardRotationPolicy(DelegatingSessionFactory<?> factory, List<RotationPolicy.KeyDirectory> keyDirectories, boolean fair)

Method Summary

Modifier and Type	Method and Description
void	afterReceive(boolean messageReceived, MessageSource<?> source) Invoked after the message source receive() method.
void	beforeReceive(MessageSource<?> source) Invoked before the message source receive() method.
protected void	configureSource(MessageSource<?> source)
RotationPolicy.KeyDirectory	getCurrent() Return the current RotationPolicy.KeyDirectory.
protected DelegatingSessionFactory<?>	getFactory()
protected Iterator<RotationPolicy.KeyDirectory>	getIterator()
protected List<RotationPolicy.KeyDirectory>	getKeyDirectories()
protected boolean	isFair()
protected boolean	isInitialized()
protected void	onRotation(MessageSource<?> source) Update the state of the MessageSource after the server is rotated, if necessary.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

Constructor Detail

StandardRotationPolicy

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

Method Detail

beforeReceive

public void beforeReceive(MessageSource<?> source)

Description copied from interface: RotationPolicy

Invoked before the message source receive() method.

Specified by:

beforeReceive in interface RotationPolicy

Parameters:

source - the message source.

afterReceive

public void afterReceive(boolean messageReceived,
                         MessageSource<?> source)

Description copied from interface: RotationPolicy

Invoked after the message source receive() method.

Specified by:

afterReceive in interface RotationPolicy

Parameters:

messageReceived - true if a message was received.

source - the message source.

getCurrent

public RotationPolicy.KeyDirectory getCurrent()

Description copied from interface: RotationPolicy

Return the current RotationPolicy.KeyDirectory.

Specified by:

getCurrent in interface RotationPolicy

Returns:

the current RotationPolicy.KeyDirectory

getFactory

protected DelegatingSessionFactory<?> getFactory()

getKeyDirectories

protected List<RotationPolicy.KeyDirectory> getKeyDirectories()

isFair

protected boolean isFair()

getIterator

protected Iterator<RotationPolicy.KeyDirectory> getIterator()

isInitialized

protected boolean isInitialized()

configureSource

protected void configureSource(MessageSource<?> source)

onRotation

protected void onRotation(MessageSource<?> source)

Update the state of the MessageSource after the server is rotated, if necessary. The default implementation updates the remote directory for known MessageSource implementations that require it, specifically, instances of AbstractRemoteFileStreamingMessageSource, and AbstractInboundFileSynchronizingMessageSource, and does nothing otherwise. Subclasses may override this method to support other MessageSource types.

Parameters:

source - the MessageSource.