org.springframework.integration.store

Class MessageGroupQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<org.springframework.messaging.Message<?>>

org.springframework.integration.store.MessageGroupQueue

All Implemented Interfaces:

java.lang.Iterable<org.springframework.messaging.Message<?>>, java.util.Collection<org.springframework.messaging.Message<?>>, java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>, java.util.Queue<org.springframework.messaging.Message<?>>

public class MessageGroupQueue
extends java.util.AbstractQueue<org.springframework.messaging.Message<?>>
implements java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

A BlockingQueue that is backed by a MessageGroupStore. Can be used to ensure guaranteed delivery in the face of transaction rollback (assuming the store is transactional) and also to ensure messages are not lost if the process dies (assuming the store is durable). To use the queue across process re-starts, the same group id must be provided, so it needs to be unique but identifiable with a single logical instance of the queue.

Since:

2.0

Author:

Dave Syer, Oleg Zhurakousky, Gunnar Hillert, Gary Russell

Constructor Summary

Constructors

Constructor and Description
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, java.lang.Object groupId)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, java.lang.Object groupId, int capacity)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, java.lang.Object groupId, int capacity, java.util.concurrent.locks.Lock storeLock)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, java.lang.Object groupId, java.util.concurrent.locks.Lock storeLock)

Method Summary

Modifier and Type	Method and Description
int	drainTo(java.util.Collection<? super org.springframework.messaging.Message<?>> c)
int	drainTo(java.util.Collection<? super org.springframework.messaging.Message<?>> collection, int maxElements)
java.util.Iterator<org.springframework.messaging.Message<?>>	iterator()
boolean	offer(org.springframework.messaging.Message<?> message)
boolean	offer(org.springframework.messaging.Message<?> message, long timeout, java.util.concurrent.TimeUnit unit)
org.springframework.messaging.Message<?>	peek()
org.springframework.messaging.Message<?>	poll()
org.springframework.messaging.Message<?>	poll(long timeout, java.util.concurrent.TimeUnit unit)
void	put(org.springframework.messaging.Message<?> message)
int	remainingCapacity()
void	setPriority(boolean priority) If true, ensures that the message store supports priority.
int	size()
org.springframework.messaging.Message<?>	take()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, remove

Methods inherited from interface java.util.Queue

element, remove

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         java.lang.Object groupId)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         java.lang.Object groupId,
                         int capacity)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         java.lang.Object groupId,
                         java.util.concurrent.locks.Lock storeLock)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
                         java.lang.Object groupId,
                         int capacity,
                         java.util.concurrent.locks.Lock storeLock)

Method Detail

setPriority

public void setPriority(boolean priority)

If true, ensures that the message store supports priority. If false WARNs if the message store uses priority to determine the message order when receiving.

Parameters:

priority - true if priority is expected to be used.

iterator

public java.util.Iterator<org.springframework.messaging.Message<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.springframework.messaging.Message<?>>

Specified by:

iterator in interface java.util.Collection<org.springframework.messaging.Message<?>>

Specified by:

iterator in class java.util.AbstractCollection<org.springframework.messaging.Message<?>>

size

public int size()

Specified by:

size in interface java.util.Collection<org.springframework.messaging.Message<?>>

Specified by:

size in class java.util.AbstractCollection<org.springframework.messaging.Message<?>>

peek

public org.springframework.messaging.Message<?> peek()

Specified by:

peek in interface java.util.Queue<org.springframework.messaging.Message<?>>

poll

public org.springframework.messaging.Message<?> poll(long timeout,
                                                     java.util.concurrent.TimeUnit unit)
                                              throws java.lang.InterruptedException

Specified by:

poll in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

Throws:

java.lang.InterruptedException

poll

public org.springframework.messaging.Message<?> poll()

Specified by:

poll in interface java.util.Queue<org.springframework.messaging.Message<?>>

drainTo

public int drainTo(java.util.Collection<? super org.springframework.messaging.Message<?>> c)

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

drainTo

public int drainTo(java.util.Collection<? super org.springframework.messaging.Message<?>> collection,
                   int maxElements)

Specified by:

drainTo in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

offer

public boolean offer(org.springframework.messaging.Message<?> message)

Specified by:

offer in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

Specified by:

offer in interface java.util.Queue<org.springframework.messaging.Message<?>>

offer

public boolean offer(org.springframework.messaging.Message<?> message,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Specified by:

offer in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

Throws:

java.lang.InterruptedException

put

public void put(org.springframework.messaging.Message<?> message)
         throws java.lang.InterruptedException

Specified by:

put in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

Throws:

java.lang.InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

take

public org.springframework.messaging.Message<?> take()
                                              throws java.lang.InterruptedException

Specified by:

take in interface java.util.concurrent.BlockingQueue<org.springframework.messaging.Message<?>>

Throws:

java.lang.InterruptedException