net.timewalker.ffmq4.local.destination

Class AbstractLocalDestination

java.lang.Object

net.timewalker.ffmq4.local.destination.AbstractLocalDestination

All Implemented Interfaces:

javax.jms.Destination, LocalDestinationMBean, DestinationDescriptorMBean, Committable

Direct Known Subclasses:

LocalQueue, LocalTopic

public abstract class AbstractLocalDestination
extends Object
implements javax.jms.Destination, LocalDestinationMBean, Committable

Base implementation for a local JMS destination

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected Object	closeLock
protected ReentrantReadWriteLock	consumersLock
protected AbstractDestinationDefinition	destinationDef
protected List<LocalMessageConsumer>	localConsumers
protected ReentrantLock	transactionLock

Constructor Summary

Constructors

Constructor and Description
AbstractLocalDestination(AbstractDestinationDefinition destinationDef) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed()
protected void	checkTransactionLock()
abstract void	close() Release destination resources
void	closeTransaction() Unlock the destination for transactional update
void	commitChanges() Commit all changes (make sure they are really applied)
int	getAutoExtendAmount()
double	getAverageCommitTime() Get the average commit time for this queue (milliseconds)
int	getBlockSize()
int	getInitialBlockCount()
int	getJournalOutputBuffer()
int	getMaxBlockCount()
long	getMaxCommitTime() Get the maximum commit time for this queue (milliseconds)
long	getMaxJournalSize()
int	getMaxNonPersistentMessages()
int	getMaxUncommittedStoreSize()
int	getMaxUnflushedJournalSize()
int	getMaxWriteBatchSize()
long	getMinCommitTime() Get the minimum commit time for this queue (milliseconds)
String	getName() Get the destination name
int	getRegisteredConsumersCount() Get the number of currently registered consumers on this destination
int	getStorageSyncMethod()
protected abstract boolean	hasPendingChanges() Test if this destinations still has some uncommitted changes
boolean	isClosed()
protected boolean	isConsumerRegistered(String consumerID)
boolean	isPreAllocateFiles()
boolean	isTemporary()
boolean	isUseJournal()
protected LocalMessageConsumer	lookupConsumer(String consumerID)
protected void	notifyCommitTime(long duration)
void	openTransaction() Lock the destination for transactional update
abstract boolean	putLocked(AbstractMessage message, LocalSession session, MessageLockSet locks) Put a new message in the destination.
void	registerConsumer(LocalMessageConsumer consumer) Register a message consumer on this queue
protected abstract boolean	requiresTransactionalUpdate() Test if this destination requires transactional semantics to be updated
void	resetStats() Reset statistics on this destination
void	unregisterConsumer(LocalMessageConsumer consumer) Unregister a message listener

Methods inherited from class java.lang.Object

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

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

getSize

Methods inherited from interface net.timewalker.ffmq4.utils.Committable

commitChanges

Field Detail

destinationDef

protected AbstractDestinationDefinition destinationDef

localConsumers

protected List<LocalMessageConsumer> localConsumers

consumersLock

protected ReentrantReadWriteLock consumersLock

transactionLock

protected ReentrantLock transactionLock

closed

protected boolean closed

closeLock

protected Object closeLock

Constructor Detail

AbstractLocalDestination

public AbstractLocalDestination(AbstractDestinationDefinition destinationDef)

Constructor

Method Detail

getName

public final String getName()

Description copied from interface: DestinationDescriptorMBean

Get the destination name

Specified by:

getName in interface DestinationDescriptorMBean

Specified by:

getName in interface Committable

registerConsumer

public void registerConsumer(LocalMessageConsumer consumer)

Register a message consumer on this queue

unregisterConsumer

public void unregisterConsumer(LocalMessageConsumer consumer)

Unregister a message listener

isClosed

public final boolean isClosed()

Returns:

the closed

checkNotClosed

protected final void checkNotClosed()
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

checkTransactionLock

protected final void checkTransactionLock()
                                   throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getRegisteredConsumersCount

public final int getRegisteredConsumersCount()

Description copied from interface: LocalDestinationMBean

Get the number of currently registered consumers on this destination

Specified by:

getRegisteredConsumersCount in interface LocalDestinationMBean

isTemporary

public final boolean isTemporary()

Specified by:

isTemporary in interface DestinationDescriptorMBean

getStorageSyncMethod

public int getStorageSyncMethod()

Specified by:

getStorageSyncMethod in interface DestinationDescriptorMBean

getInitialBlockCount

public final int getInitialBlockCount()

Specified by:

getInitialBlockCount in interface DestinationDescriptorMBean

getMaxBlockCount

public int getMaxBlockCount()

Specified by:

getMaxBlockCount in interface DestinationDescriptorMBean

isUseJournal

public boolean isUseJournal()

Specified by:

isUseJournal in interface DestinationDescriptorMBean

getBlockSize

public final int getBlockSize()

Specified by:

getBlockSize in interface DestinationDescriptorMBean

getMaxNonPersistentMessages

public final int getMaxNonPersistentMessages()

Specified by:

getMaxNonPersistentMessages in interface DestinationDescriptorMBean

getAutoExtendAmount

public int getAutoExtendAmount()

Specified by:

getAutoExtendAmount in interface DestinationDescriptorMBean

getJournalOutputBuffer

public int getJournalOutputBuffer()

Specified by:

getJournalOutputBuffer in interface DestinationDescriptorMBean

getMaxJournalSize

public long getMaxJournalSize()

Specified by:

getMaxJournalSize in interface DestinationDescriptorMBean

getMaxUnflushedJournalSize

public int getMaxUnflushedJournalSize()

Specified by:

getMaxUnflushedJournalSize in interface DestinationDescriptorMBean

getMaxUncommittedStoreSize

public int getMaxUncommittedStoreSize()

Specified by:

getMaxUncommittedStoreSize in interface DestinationDescriptorMBean

getMaxWriteBatchSize

public int getMaxWriteBatchSize()

Specified by:

getMaxWriteBatchSize in interface DestinationDescriptorMBean

isPreAllocateFiles

public boolean isPreAllocateFiles()

Specified by:

isPreAllocateFiles in interface DestinationDescriptorMBean

lookupConsumer

protected final LocalMessageConsumer lookupConsumer(String consumerID)

isConsumerRegistered

protected final boolean isConsumerRegistered(String consumerID)

getMinCommitTime

public final long getMinCommitTime()

Description copied from interface: LocalDestinationMBean

Get the minimum commit time for this queue (milliseconds)

Specified by:

getMinCommitTime in interface LocalDestinationMBean

getMaxCommitTime

public final long getMaxCommitTime()

Description copied from interface: LocalDestinationMBean

Get the maximum commit time for this queue (milliseconds)

Specified by:

getMaxCommitTime in interface LocalDestinationMBean

getAverageCommitTime

public final double getAverageCommitTime()

Description copied from interface: LocalDestinationMBean

Get the average commit time for this queue (milliseconds)

Specified by:

getAverageCommitTime in interface LocalDestinationMBean

notifyCommitTime

protected final void notifyCommitTime(long duration)

resetStats

public void resetStats()

Description copied from interface: LocalDestinationMBean

Reset statistics on this destination

Specified by:

resetStats in interface LocalDestinationMBean

close

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

Release destination resources

Throws:

javax.jms.JMSException

requiresTransactionalUpdate

protected abstract boolean requiresTransactionalUpdate()

Test if this destination requires transactional semantics to be updated

Returns:

true if a transaction is required

hasPendingChanges

protected abstract boolean hasPendingChanges()

Test if this destinations still has some uncommitted changes

Returns:

true if this destinations still has some uncommitted changes

openTransaction

public final void openTransaction()

Description copied from interface: Committable

Lock the destination for transactional update

Specified by:

openTransaction in interface Committable

closeTransaction

public void closeTransaction()

Description copied from interface: Committable

Unlock the destination for transactional update

Specified by:

closeTransaction in interface Committable

commitChanges

public void commitChanges()
                   throws javax.jms.JMSException

Description copied from interface: Committable

Commit all changes (make sure they are really applied)

Specified by:

commitChanges in interface Committable

Throws:

javax.jms.JMSException

putLocked

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

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

Returns:

true if a commit is required to ensure data safety

Throws:

javax.jms.JMSException