org.springframework.integration.aop

Class SimpleActiveIdleMessageSourceAdvice

java.lang.Object

org.springframework.integration.aop.AbstractMessageSourceAdvice

org.springframework.integration.aop.SimpleActiveIdleMessageSourceAdvice

All Implemented Interfaces:

Advice, Interceptor, MethodInterceptor

public class SimpleActiveIdleMessageSourceAdvice
extends AbstractMessageSourceAdvice

A simple advice that polls at one rate when messages exist and another when there are no messages.

Since:

4.2

Author:

Gary Russell

See Also:

DynamicPeriodicTrigger

Constructor Summary

Constructors

Constructor and Description
SimpleActiveIdleMessageSourceAdvice(DynamicPeriodicTrigger trigger)

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.
void	setActivePollPeriod(long activePollPeriod) Set the poll period when messages are returned.
void	setIdlePollPeriod(long idlePollPeriod) Set the poll period when messages are not returned.

Methods inherited from class org.springframework.integration.aop.AbstractMessageSourceAdvice

invoke

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleActiveIdleMessageSourceAdvice

public SimpleActiveIdleMessageSourceAdvice(DynamicPeriodicTrigger trigger)

Method Detail

setIdlePollPeriod

public void setIdlePollPeriod(long idlePollPeriod)

Set the poll period when messages are not returned. Defaults to the trigger's period.

Parameters:

idlePollPeriod - the period in milliseconds.

setActivePollPeriod

public void setActivePollPeriod(long activePollPeriod)

Set the poll period when messages are returned. Defaults to the trigger's period.

Parameters:

activePollPeriod - the period in milliseconds.

beforeReceive

public boolean beforeReceive(MessageSource<?> source)

Description copied from class: AbstractMessageSourceAdvice

Subclasses can decide whether to proceed with this poll.

Specified by:

beforeReceive in class AbstractMessageSourceAdvice

Parameters:

source - the message source.

Returns:

true to proceed.

afterReceive

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

Description copied from class: AbstractMessageSourceAdvice

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 class AbstractMessageSourceAdvice

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.