Package org.springframework.integration.channel

Interface QueueChannelOperations

All Known Implementing Classes:
PriorityChannel, QueueChannel, RendezvousChannel
public interface QueueChannelOperations
Operations available on a channel that has queuing semantics.
Since:
3.0
Author:
Gary Russell, Artem Bilan

  • Method Details

    • clear

      List<Message<?>> clear()
      Remove all Messages from this channel.
      Returns:
      The messages that were removed.

    • purge

      List<Message<?>> purge(@Nullable MessageSelector selector)
      Remove any Messages that are not accepted by the provided selector.
      Parameters:
      selector - The message selector.
      Returns:
      The list of messages that were purged.

    • getQueueSize

      @ManagedAttribute(description="Queue size") int getQueueSize()
      Obtain the current number of queued Messages in this channel.
      Returns:
      The current number of queued Messages in this channel.

    • getRemainingCapacity

      @ManagedAttribute(description="Queue remaining capacity") int getRemainingCapacity()
      Obtain the remaining capacity of this channel.
      Returns:
      The remaining capacity of this channel.