org.springframework.integration.channel

Class DefaultHeaderChannelRegistry

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.DefaultHeaderChannelRegistry

All Implemented Interfaces:

Runnable, Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, HeaderChannelRegistry, NamedComponent

public class DefaultHeaderChannelRegistry
extends IntegrationObjectSupport
implements HeaderChannelRegistry, SmartLifecycle, Runnable

Converts a channel to a name, retaining a reference to the channel keyed by the name. Allows a downstream BeanFactoryChannelResolver to find the channel by name in the event that the flow serialized the message at some point. Channels are expired after a configurable delay (60 seconds by default). The actual average expiry time will be 1.5x the delay.

Since:

3.0

Author:

Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
DefaultHeaderChannelRegistry() Constructs a registry with the default delay for channel expiry.
DefaultHeaderChannelRegistry(long reaperDelay) Constructs a registry with the provided delay (milliseconds) for channel expiry.

Method Summary

Methods

Modifier and Type	Method and Description
MessageChannel	channelNameToChannel(String name) Converts the channel name back to a MessageChannel (if it is registered).
Object	channelToChannelName(Object channel) Converts the channel to a name (String).
int	getPhase()
long	getReaperDelay()
boolean	isAutoStartup()
boolean	isRunning()
protected void	onInit() Subclasses may implement this for initialization logic.
void	run()
void	runReaper() Cancel the scheduled reap task and run immediately; then reschedule.
void	setAutoStartup(boolean autoStartup)
void	setPhase(int phase)
void	setReaperDelay(long reaperDelay) Set the reaper delay.
void	setTaskScheduler(TaskScheduler taskScheduler)
int	size()
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getComponentType, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHeaderChannelRegistry

public DefaultHeaderChannelRegistry()

Constructs a registry with the default delay for channel expiry.

DefaultHeaderChannelRegistry

public DefaultHeaderChannelRegistry(long reaperDelay)

Constructs a registry with the provided delay (milliseconds) for channel expiry.

Parameters:

reaperDelay - the delay in milliseconds.

Method Detail

setReaperDelay

public final void setReaperDelay(long reaperDelay)

Set the reaper delay.

Parameters:

reaperDelay - the delay in milliseconds.

getReaperDelay

public final long getReaperDelay()

setTaskScheduler

public void setTaskScheduler(TaskScheduler taskScheduler)

Overrides:

setTaskScheduler in class IntegrationObjectSupport

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

setPhase

public final void setPhase(int phase)

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

setAutoStartup

public final void setAutoStartup(boolean autoStartup)

size

public final int size()

Specified by:

size in interface HeaderChannelRegistry

Returns:

the current size of the registry

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

Exception - Any exception.

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

channelToChannelName

public Object channelToChannelName(Object channel)

Description copied from interface: HeaderChannelRegistry

Converts the channel to a name (String). If the channel is not a MessageChannel, it is returned unchanged.

Specified by:

channelToChannelName in interface HeaderChannelRegistry

Parameters:

channel - The channel.

Returns:

The channel name, or the channel if it is not a MessageChannel.

channelNameToChannel

public MessageChannel channelNameToChannel(String name)

Description copied from interface: HeaderChannelRegistry

Converts the channel name back to a MessageChannel (if it is registered).

Specified by:

channelNameToChannel in interface HeaderChannelRegistry

Parameters:

name - The name of the channel.

Returns:

The channel, or null if there is no channel registered with the name.

runReaper

public void runReaper()

Cancel the scheduled reap task and run immediately; then reschedule.

Specified by:

runReaper in interface HeaderChannelRegistry

run

public void run()

Specified by:

run in interface Runnable