org.springframework.integration.channel

Class NullChannel

java.lang.Object

org.springframework.integration.channel.NullChannel

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, IntegrationPattern, NamedComponent, IntegrationManagement, MessageChannel, PollableChannel

@IntegrationManagedResource
public class NullChannel
extends Object
implements PollableChannel, BeanNameAware, IntegrationManagement, IntegrationPattern

A channel implementation that essentially behaves like "/dev/null". All receive() calls will return null, and all send(org.springframework.messaging.Message<?>, long) calls will return true although no action is performed. Unless the payload of a sent message is a Publisher implementation, in which case the Publisher.subscribe(Subscriber) is called to initiate the reactive stream, although the data is discarded by this channel. An error thrown from a reactive stream processing (see Subscriber.onError(Throwable)) is logged under the warn level. Note however that the invocations are logged at debug-level.

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
NullChannel()

Method Summary

Modifier and Type	Method and Description
void	destroy()
String	getBeanName()
String	getComponentName()
String	getComponentType()
IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
IntegrationManagement.ManagementOverrides	getOverrides() Return the overrides.
boolean	isLoggingEnabled() Return whether logging is enabled.
Message<?>	receive()
Message<?>	receive(long timeout)
void	registerMetricsCaptor(MetricsCaptor registry) Inject a MetricsCaptor
boolean	send(Message<?> message)
boolean	send(Message<?> message, long timeout)
void	setBeanName(String beanName)
void	setLoggingEnabled(boolean loggingEnabled) Enable logging or not.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

Constructor Detail

NullChannel

public NullChannel()

Method Detail

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface BeanNameAware

isLoggingEnabled

public boolean isLoggingEnabled()

Description copied from interface: IntegrationManagement

Return whether logging is enabled.

Specified by:

isLoggingEnabled in interface IntegrationManagement

Returns:

true if enabled.

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Description copied from interface: IntegrationManagement

Enable logging or not.

Specified by:

setLoggingEnabled in interface IntegrationManagement

Parameters:

loggingEnabled - dalse to disable.

getBeanName

@Nullable
public String getBeanName()

Specified by:

getBeanName in interface NamedComponent

getComponentName

@Nullable
public String getComponentName()

Specified by:

getComponentName in interface NamedComponent

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor registry)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

registry - the captor.

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

send

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

Specified by:

send in interface MessageChannel

send

public boolean send(Message<?> message)

Specified by:

send in interface MessageChannel

receive

public Message<?> receive()

Specified by:

receive in interface PollableChannel

receive

public Message<?> receive(long timeout)

Specified by:

receive in interface PollableChannel

toString

public String toString()

Overrides:

toString in class Object

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement