org.springframework.integration.channel

Class PriorityChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.channel.AbstractPollableChannel

org.springframework.integration.channel.QueueChannel

org.springframework.integration.channel.PriorityChannel

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ChannelInterceptorAware, ExecutorChannelInterceptorAware, QueueChannelOperations, ExpressionCapable, NamedComponent, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageChannelMetrics, PollableChannelManagement, QueueChannelManagement, TrackableComponent, org.springframework.messaging.MessageChannel, org.springframework.messaging.PollableChannel

public class PriorityChannel
extends QueueChannel

A message channel that prioritizes messages based on a Comparator. The default comparator is based upon the message header's 'priority'.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.channel.QueueChannel

queueSemaphore

Fields inherited from class org.springframework.integration.channel.AbstractMessageChannel

interceptors

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

EXPRESSION_PARSER, logger

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
PriorityChannel() Create a channel with an unbounded queue.
PriorityChannel(java.util.Comparator<org.springframework.messaging.Message<?>> comparator) Create a channel with an unbounded queue.
PriorityChannel(int capacity) Create a channel with the specified queue capacity.
PriorityChannel(int capacity, java.util.Comparator<org.springframework.messaging.Message<?>> comparator) Create a channel with the specified queue capacity.
PriorityChannel(MessageGroupQueue messageGroupQueue) Create a channel based on the provided MessageGroupQueue.
PriorityChannel(PriorityCapableChannelMessageStore messageGroupStore, java.lang.Object groupId) Create a channel based on the provided PriorityCapableChannelMessageStore and group id for message store operations.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.messaging.Message<?>	doReceive(long timeout) Subclasses must implement this method.
protected boolean	doSend(org.springframework.messaging.Message<?> message, long timeout) Subclasses must implement this method.
int	getRemainingCapacity()

Methods inherited from class org.springframework.integration.channel.QueueChannel

clear, getQueueSize, purge

Methods inherited from class org.springframework.integration.channel.AbstractPollableChannel

addInterceptor, addInterceptor, getReceiveCount, getReceiveCountLong, getReceiveErrorCount, getReceiveErrorCountLong, hasExecutorInterceptors, receive, receive, removeInterceptor, removeInterceptor, setInterceptors

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

configureMetrics, getChannelInterceptors, getComponentType, getErrorRate, getFullChannelName, getInterceptors, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMetrics, getMetricsCaptor, getMinSendDuration, getOverrides, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onInit, registerMetricsCaptor, reset, send, send, setCountsEnabled, setDatatypes, setLoggingEnabled, setMessageConverter, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, 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.PollableChannelManagement

getReceiveCount, getReceiveCountLong, getReceiveErrorCount, getReceiveErrorCountLong

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

getErrorRate, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMinSendDuration, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend

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

isStatsEnabled, setStatsEnabled

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

getOverrides, isCountsEnabled, isLoggingEnabled, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

Methods inherited from interface org.springframework.integration.channel.ChannelInterceptorAware

getChannelInterceptors

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

PriorityChannel

public PriorityChannel()

Create a channel with an unbounded queue. Message priority will be based on the value of IntegrationMessageHeaderAccessor.getPriority().

PriorityChannel

public PriorityChannel(int capacity)

Create a channel with the specified queue capacity. Message priority will be based upon the value of IntegrationMessageHeaderAccessor.getPriority().

Parameters:

capacity - The queue capacity.

PriorityChannel

public PriorityChannel(java.util.Comparator<org.springframework.messaging.Message<?>> comparator)

Create a channel with an unbounded queue. Message priority will be determined by the provided Comparator. If the comparator is null, the priority will be based upon the value of IntegrationMessageHeaderAccessor.getPriority().

Parameters:

comparator - The comparator.

PriorityChannel

public PriorityChannel(int capacity,
                       java.util.Comparator<org.springframework.messaging.Message<?>> comparator)

Create a channel with the specified queue capacity. If the capacity is a non-positive value, the queue will be unbounded. Message priority will be determined by the provided Comparator. If the comparator is null, the priority will be based upon the value of IntegrationMessageHeaderAccessor.getPriority().

Parameters:

capacity - The capacity.

comparator - The comparator.

PriorityChannel

public PriorityChannel(PriorityCapableChannelMessageStore messageGroupStore,
                       java.lang.Object groupId)

Create a channel based on the provided PriorityCapableChannelMessageStore and group id for message store operations.

Parameters:

messageGroupStore - the PriorityCapableChannelMessageStore to use.

groupId - to group message for this channel in the message store.

Since:

5.0

PriorityChannel

public PriorityChannel(MessageGroupQueue messageGroupQueue)

Create a channel based on the provided MessageGroupQueue.

Parameters:

messageGroupQueue - the MessageGroupQueue to use.

Since:

5.0

Method Detail

getRemainingCapacity

public int getRemainingCapacity()

Specified by:

getRemainingCapacity in interface QueueChannelOperations

Specified by:

getRemainingCapacity in interface QueueChannelManagement

Overrides:

getRemainingCapacity in class QueueChannel

Returns:

The remaining capacity of this channel.

doSend

protected boolean doSend(org.springframework.messaging.Message<?> message,
                         long timeout)

Description copied from class: AbstractMessageChannel

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is at capacity (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either the message is accepted or the blocking thread is interrupted.

Overrides:

doSend in class QueueChannel

Parameters:

message - The message.

timeout - The timeout.

Returns:

true if the send was successful.

doReceive

protected org.springframework.messaging.Message<?> doReceive(long timeout)

Description copied from class: AbstractPollableChannel

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is empty (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either a message is available or the blocking thread is interrupted.

Overrides:

doReceive in class QueueChannel

Parameters:

timeout - The timeout.

Returns:

The message, or null.