Class MessageGroupQueue

java.lang.Object

java.util.AbstractCollection<Message<?>>

java.util.AbstractQueue<Message<?>>

org.springframework.integration.store.MessageGroupQueue

All Implemented Interfaces:

Iterable<Message<?>>, Collection<Message<?>>, BlockingQueue<Message<?>>, Queue<Message<?>>

public class MessageGroupQueue
extends AbstractQueue<Message<?>>
implements BlockingQueue<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, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, Object groupId)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, Object groupId, int capacity)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, Object groupId, int capacity, Lock storeLock)
MessageGroupQueue(BasicMessageGroupStore messageGroupStore, Object groupId, Lock storeLock)

Method Summary

Modifier and Type	Method	Description
protected boolean	doOffer(Message<?> message)	It is assumed that the 'storeLock' is being held by the caller, otherwise IllegalMonitorStateException may be thrown.
protected Message<?>	doPoll()	It is assumed that the 'storeLock' is being held by the caller, otherwise IllegalMonitorStateException may be thrown.
int	drainTo(Collection<? super Message<?>> c)
int	drainTo(Collection<? super Message<?>> collection, int maxElements)
protected BasicMessageGroupStore	getMessageGroupStore()	Get the store.
protected Collection<Message<?>>	getMessages()
protected Condition	getMessageStoreNotEmpty()	Get the not empty condition.
protected Condition	getMessageStoreNotFull()	Get the not full condition.
protected Lock	getStoreLock()	Get the store lock.
Iterator<Message<?>>	iterator()
boolean	offer(Message<?> message)
boolean	offer(Message<?> message, long timeout, TimeUnit unit)
Message<?>	peek()
Message<?>	poll()
Message<?>	poll(long timeout, TimeUnit unit)
void	put(Message<?> message)
int	remainingCapacity()
void	setPriority(boolean priority)	If true, ensures that the message store supports priority.
int	size()
Stream<Message<?>>	stream()
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.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, remove

Constructor Details

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
 Object groupId)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
 Object groupId,
 int capacity)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
 Object groupId,
 Lock storeLock)

MessageGroupQueue

public MessageGroupQueue(BasicMessageGroupStore messageGroupStore,
 Object groupId,
 int capacity,
 Lock storeLock)

Method Details

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 Iterator<Message<?>> iterator()

Specified by:

iterator in interface Collection<Message<?>>

Specified by:

iterator in interface Iterable<Message<?>>

Specified by:

iterator in class AbstractCollection<Message<?>>

getMessageGroupStore

protected BasicMessageGroupStore getMessageGroupStore()

Get the store.

Returns:

the store.

Since:

5.0.11

getStoreLock

protected Lock getStoreLock()

Get the store lock.

Returns:

the lock.

Since:

5.0.11

getMessageStoreNotFull

protected Condition getMessageStoreNotFull()

Get the not full condition.

Returns:

the condition.

Since:

5.0.11

getMessageStoreNotEmpty

protected Condition getMessageStoreNotEmpty()

Get the not empty condition.

Returns:

the condition.

Since:

5.0.11

size

public int size()

Specified by:

size in interface Collection<Message<?>>

Specified by:

size in class AbstractCollection<Message<?>>

peek

public Message<?> peek()

Specified by:

peek in interface Queue<Message<?>>

poll

public Message<?> poll(long timeout,
 TimeUnit unit)
                throws InterruptedException

Specified by:

poll in interface BlockingQueue<Message<?>>

Throws:

InterruptedException

poll

public Message<?> poll()

Specified by:

poll in interface Queue<Message<?>>

drainTo

public int drainTo(Collection<? super Message<?>> c)

Specified by:

drainTo in interface BlockingQueue<Message<?>>

drainTo

public int drainTo(Collection<? super Message<?>> collection,
 int maxElements)

Specified by:

drainTo in interface BlockingQueue<Message<?>>

offer

public boolean offer(Message<?> message)

Specified by:

offer in interface BlockingQueue<Message<?>>

Specified by:

offer in interface Queue<Message<?>>

offer

public boolean offer(Message<?> message,
 long timeout,
 TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<Message<?>>

Throws:

InterruptedException

put

public void put(Message<?> message)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<Message<?>>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<Message<?>>

take

public Message<?> take()
                throws InterruptedException

Specified by:

take in interface BlockingQueue<Message<?>>

Throws:

InterruptedException

getMessages

protected Collection<Message<?>> getMessages()

stream

public Stream<Message<?>> stream()

Specified by:

stream in interface Collection<Message<?>>

doPoll

protected Message<?> doPoll()

It is assumed that the 'storeLock' is being held by the caller, otherwise IllegalMonitorStateException may be thrown.

Returns:

a message // TODO @Nullable

doOffer

protected boolean doOffer(Message<?> message)

It is assumed that the 'storeLock' is being held by the caller, otherwise IllegalMonitorStateException may be thrown.

Parameters:

message - the message to offer.

Returns:

true if offered.