Package net.timewalker.ffmq4.local.destination

Class LocalQueue

java.lang.Object

net.timewalker.ffmq4.local.destination.AbstractLocalDestination

net.timewalker.ffmq4.local.destination.LocalQueue

All Implemented Interfaces:

javax.jms.Destination, javax.jms.Queue, LocalDestinationMBean, LocalQueueMBean, DestinationDescriptorMBean, Committable, ActiveObject

public final class LocalQueue
extends AbstractLocalDestination
implements javax.jms.Queue, LocalQueueMBean, ActiveObject

Implementation for a local JMS Queue

Field Summary

Fields inherited from class net.timewalker.ffmq4.local.destination.AbstractLocalDestination

closed, closeLock, consumersLock, destinationDef, localConsumers, transactionLock

Constructor Summary

Constructors

Constructor	Description
LocalQueue(FFMQEngine engine, QueueDefinition queueDef)	Constructor

Method Summary

Modifier and Type	Method	Description
AbstractMessage	browse(LocalQueueBrowserCursor cursor, MessageSelector selector)	Browse a message in this queue
void	close()	Release destination resources
void	commitChanges(SynchronizationBarrier barrier)	Commit all changes (make sure they are really applied) (ASYNCHRONOUS)
AbstractMessage	get(LocalSession localSession, TransactionSet transactionSet, MessageSelector selector)	Get the first available message from this destination (matching an optional message selector).
long	getAcknowledgedGetCount()	Get the number of acknowledged get operations on this queue (since startup or last reset)
QueueDefinition	getDefinition()	Get the queue definition
long	getExpiredCount()	Get the number of messages that were removed from this queue because they expired (since startup or last reset)
long	getLastActivity()	Get a timestamp of this object's last activity
int	getMemoryStoreUsage()	Get the usage amount (%) for the memory store
int	getPersistentStoreUsage()	Get the usage amount (%) for the memory store
String	getQueueName()
long	getReceivedFromQueueCount()	Get the number of messages received from this queue (since startup or last reset)
long	getRollbackedGetCount()	Get the number of rollbacked get operations on this queue (since startup or last reset)
long	getSentToQueueCount()	Get the number of messages sent to this queue (since startup or last reset)
int	getSize()	Get the destination size (number of contained messages)
long	getStoreFullEventsCount()	Get the number of times a message could not be stored because the queue store was full
long	getTimeoutDelay()	Get the maximum allowed time between activities
protected boolean	hasPendingChanges()	Test if this destinations still has some uncommitted changes
boolean	onActivityTimeout()	Called if the object has been inactive for more
protected void	processAvailabilityNotificationQueue()
void	purge(MessageSelector selector)	Purge some messages from the buffer
boolean	putLocked(AbstractMessage message, LocalSession session, MessageLockSet locks)	Put a new message in the destination.
boolean	redeliverLocked(TransactionItem[] items, MessageLockSet locks)	Rollback get operations on this queue (messages are unlocked)..
protected void	redeliverMessage(AbstractMessage msg, MessageStore store, int handle)	See RedeliveryTask
boolean	remove(LocalSession localSession, TransactionItem[] items)	Commit get operations on this queue (messages are removed)
void	removeLocked(MessageLock lockRef)	Remove a locked message from this queue.
protected boolean	requiresTransactionalUpdate()	Test if this destination requires transactional semantics to be updated
void	resetStats()	Reset statistics on this destination
String	toString()
void	unlockAndDeliver(MessageLock lockRef)	Unlock a message.

Methods inherited from class net.timewalker.ffmq4.local.destination.AbstractLocalDestination

checkNotClosed, checkTransactionLock, closeTransaction, commitChanges, getAutoExtendAmount, getAverageCommitTime, getBlockSize, getInitialBlockCount, getJournalOutputBuffer, getMaxBlockCount, getMaxCommitTime, getMaxJournalSize, getMaxNonPersistentMessages, getMaxUncommittedStoreSize, getMaxUnflushedJournalSize, getMaxWriteBatchSize, getMinCommitTime, getName, getRegisteredConsumersCount, getStorageSyncMethod, isClosed, isConsumerRegistered, isPreAllocateFiles, isTemporary, isUseJournal, lookupConsumer, notifyCommitTime, openTransaction, registerConsumer, unregisterConsumer

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.timewalker.ffmq4.management.destination.DestinationDescriptorMBean

getAutoExtendAmount, getBlockSize, getInitialBlockCount, getJournalOutputBuffer, getMaxBlockCount, getMaxJournalSize, getMaxNonPersistentMessages, getMaxUncommittedStoreSize, getMaxUnflushedJournalSize, getMaxWriteBatchSize, getName, getStorageSyncMethod, isPreAllocateFiles, isTemporary, isUseJournal

Methods inherited from interface net.timewalker.ffmq4.local.destination.LocalDestinationMBean

getAverageCommitTime, getMaxCommitTime, getMinCommitTime, getRegisteredConsumersCount

Constructor Detail

LocalQueue

public LocalQueue(FFMQEngine engine,
                  QueueDefinition queueDef)
           throws javax.jms.JMSException

Constructor

Throws:

javax.jms.JMSException

Method Detail

getDefinition

public QueueDefinition getDefinition()

Get the queue definition

getQueueName

public String getQueueName()

Specified by:

getQueueName in interface javax.jms.Queue

putLocked

public boolean putLocked(AbstractMessage message,
                         LocalSession session,
                         MessageLockSet locks)
                  throws javax.jms.JMSException

Description copied from class: AbstractLocalDestination

Put a new message in the destination. The message is locked and the lock registered in the provided lock set

Specified by:

putLocked in class AbstractLocalDestination

Returns:

true if a commit is required to ensure data safety

Throws:

javax.jms.JMSException

unlockAndDeliver

public void unlockAndDeliver(MessageLock lockRef)
                      throws javax.jms.JMSException

Unlock a message. Listeners are automatically notified of the new message availability.

Throws:

javax.jms.JMSException

removeLocked

public void removeLocked(MessageLock lockRef)
                  throws javax.jms.JMSException

Remove a locked message from this queue. The message is deleted from the underlying store.

Throws:

javax.jms.JMSException

remove

public boolean remove(LocalSession localSession,
                      TransactionItem[] items)
               throws javax.jms.JMSException

Commit get operations on this queue (messages are removed)

Returns:

true if a store commit is required to ensure data safety

Throws:

javax.jms.JMSException

redeliverLocked

public boolean redeliverLocked(TransactionItem[] items,
                               MessageLockSet locks)
                        throws javax.jms.JMSException

Rollback get operations on this queue (messages are unlocked).. Consumers are notified of rollbacked messages availability

Returns:

true if a commit is required to ensure data safety

Throws:

javax.jms.JMSException

commitChanges

public void commitChanges(SynchronizationBarrier barrier)
                   throws javax.jms.JMSException

Description copied from interface: Committable

Commit all changes (make sure they are really applied) (ASYNCHRONOUS)

Specified by:

commitChanges in interface Committable

Parameters:

barrier - a synchronization barrier

Throws:

javax.jms.JMSException

redeliverMessage

protected void redeliverMessage(AbstractMessage msg,
                                MessageStore store,
                                int handle)

See RedeliveryTask

get

public AbstractMessage get(LocalSession localSession,
                           TransactionSet transactionSet,
                           MessageSelector selector)
                    throws javax.jms.JMSException

Get the first available message from this destination (matching an optional message selector). If a message is found, the transaction set is updated accordingly.

Returns:

a message or null if there is no available message (or queue is closed)

Throws:

javax.jms.JMSException

browse

public AbstractMessage browse(LocalQueueBrowserCursor cursor,
                              MessageSelector selector)
                       throws javax.jms.JMSException

Browse a message in this queue

Parameters:

cursor - browser cursor

selector - a message selector or null

Returns:

a matching message or null

Throws:

javax.jms.JMSException - on internal error

purge

public void purge(MessageSelector selector)
           throws javax.jms.JMSException

Purge some messages from the buffer

Throws:

javax.jms.JMSException

getSize

public int getSize()

Description copied from interface: LocalDestinationMBean

Get the destination size (number of contained messages)

Specified by:

getSize in interface LocalDestinationMBean

getMemoryStoreUsage

public int getMemoryStoreUsage()

Description copied from interface: LocalQueueMBean

Get the usage amount (%) for the memory store

Specified by:

getMemoryStoreUsage in interface LocalQueueMBean

getPersistentStoreUsage

public int getPersistentStoreUsage()

Description copied from interface: LocalQueueMBean

Get the usage amount (%) for the memory store

Specified by:

getPersistentStoreUsage in interface LocalQueueMBean

resetStats

public void resetStats()

Description copied from interface: LocalDestinationMBean

Reset statistics on this destination

Specified by:

resetStats in interface LocalDestinationMBean

Overrides:

resetStats in class AbstractLocalDestination

toString

public String toString()

Specified by:

toString in interface javax.jms.Queue

Overrides:

toString in class Object

close

public final void close()
                 throws javax.jms.JMSException

Description copied from class: AbstractLocalDestination

Release destination resources

Specified by:

close in class AbstractLocalDestination

Throws:

javax.jms.JMSException

getSentToQueueCount

public long getSentToQueueCount()

Description copied from interface: LocalQueueMBean

Get the number of messages sent to this queue (since startup or last reset)

Specified by:

getSentToQueueCount in interface LocalQueueMBean

getReceivedFromQueueCount

public long getReceivedFromQueueCount()

Description copied from interface: LocalQueueMBean

Get the number of messages received from this queue (since startup or last reset)

Specified by:

getReceivedFromQueueCount in interface LocalQueueMBean

getAcknowledgedGetCount

public long getAcknowledgedGetCount()

Description copied from interface: LocalQueueMBean

Get the number of acknowledged get operations on this queue (since startup or last reset)

Specified by:

getAcknowledgedGetCount in interface LocalQueueMBean

getRollbackedGetCount

public long getRollbackedGetCount()

Description copied from interface: LocalQueueMBean

Get the number of rollbacked get operations on this queue (since startup or last reset)

Specified by:

getRollbackedGetCount in interface LocalQueueMBean

getExpiredCount

public long getExpiredCount()

Description copied from interface: LocalQueueMBean

Get the number of messages that were removed from this queue because they expired (since startup or last reset)

Specified by:

getExpiredCount in interface LocalQueueMBean

getStoreFullEventsCount

public long getStoreFullEventsCount()

Description copied from interface: LocalQueueMBean

Get the number of times a message could not be stored because the queue store was full

Specified by:

getStoreFullEventsCount in interface LocalQueueMBean

getLastActivity

public long getLastActivity()

Description copied from interface: ActiveObject

Get a timestamp of this object's last activity

Specified by:

getLastActivity in interface ActiveObject

Returns:

a java timestamp

getTimeoutDelay

public long getTimeoutDelay()

Description copied from interface: ActiveObject

Get the maximum allowed time between activities

Specified by:

getTimeoutDelay in interface ActiveObject

Returns:

a delay in milliseconds

onActivityTimeout

public boolean onActivityTimeout()
                          throws Exception

Description copied from interface: ActiveObject

Called if the object has been inactive for more

Specified by:

onActivityTimeout in interface ActiveObject

Returns:

true if the object should be unregistered immediately upon return

Throws:

Exception

processAvailabilityNotificationQueue

protected void processAvailabilityNotificationQueue()

hasPendingChanges

protected boolean hasPendingChanges()

Description copied from class: AbstractLocalDestination

Test if this destinations still has some uncommitted changes

Specified by:

hasPendingChanges in class AbstractLocalDestination

Returns:

true if this destinations still has some uncommitted changes

requiresTransactionalUpdate

protected boolean requiresTransactionalUpdate()

Description copied from class: AbstractLocalDestination

Test if this destination requires transactional semantics to be updated

Specified by:

requiresTransactionalUpdate in class AbstractLocalDestination

Returns:

true if a transaction is required