org.springframework.integration.channel
Class NullChannel

java.lang.Object
  org.springframework.integration.channel.NullChannel

All Implemented Interfaces:

org.springframework.beans.factory.BeanNameAware, PollableChannel, MessageChannel

public class NullChannel
extends java.lang.Object
implements PollableChannel, org.springframework.beans.factory.BeanNameAware

A channel implementation that essentially behaves like "/dev/null". All receive() calls will return null, and all send() calls will return true although no action is performed. Note however that the invocations are logged at debug-level.

Author:

Mark Fisher

Constructor Summary

NullChannel()

Method Summary

java.util.List<Message<?>>	clear() Remove all Messages from this channel.
java.lang.String	getName() Return the name of this channel.
java.util.List<Message<?>>	purge(MessageSelector selector) Remove any Messages that are not accepted by the provided selector.
Message<?>	receive() Receive a message from this channel, blocking indefinitely if necessary.
Message<?>	receive(long timeout) Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.
boolean	send(Message<?> message) Send a Message to this channel.
boolean	send(Message<?> message, long timeout) Send a message, blocking until either the message is accepted or the specified timeout period elapses.
void	setBeanName(java.lang.String beanName)

Methods inherited from class java.lang.Object

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

Constructor Detail

NullChannel

public NullChannel()

Method Detail

setBeanName

public void setBeanName(java.lang.String beanName)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getName

public java.lang.String getName()

Description copied from interface: MessageChannel

Return the name of this channel.

Specified by:

getName in interface MessageChannel

clear

public java.util.List<Message<?>> clear()

Description copied from interface: PollableChannel

Remove all Messages from this channel.

Specified by:

clear in interface PollableChannel

purge

public java.util.List<Message<?>> purge(MessageSelector selector)

Description copied from interface: PollableChannel

Remove any Messages that are not accepted by the provided selector.

Specified by:

purge in interface PollableChannel

receive

public Message<?> receive()

Description copied from interface: PollableChannel

Receive a message from this channel, blocking indefinitely if necessary.

Specified by:

receive in interface PollableChannel

Returns:

the next available Message or null if interrupted

receive

public Message<?> receive(long timeout)

Description copied from interface: PollableChannel

Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.

Specified by:

receive in interface PollableChannel

Parameters:

timeout - the timeout in milliseconds

Returns:

the next available Message or null if the specified timeout period elapses or the message reception is interrupted

send

public boolean send(Message<?> message)

Description copied from interface: MessageChannel

Send a Message to this channel. May throw a RuntimeException for non-recoverable errors. Otherwise, if the Message cannot be sent for a non-fatal reason this method will return 'false', and if the Message is sent successfully, it will return 'true'.

Depending on the implementation, this method may block indefinitely. To provide a maximum wait time, use MessageChannel.send(Message, long).

Specified by:

send in interface MessageChannel

Parameters:

message - the Message to send

Returns:

whether the Message has been sent successfully

send

public boolean send(Message<?> message,
                    long timeout)

Description copied from interface: MessageChannel

Send a message, blocking until either the message is accepted or the specified timeout period elapses.

Specified by:

send in interface MessageChannel

Parameters:

message - the Message to send

timeout - the timeout in milliseconds

Returns:

true if the message is sent successfully, false if the specified timeout period elapses or the send is interrupted