net.timewalker.ffmq4.local.destination

Class LocalTopic

java.lang.Object

net.timewalker.ffmq4.local.destination.AbstractLocalDestination

net.timewalker.ffmq4.local.destination.LocalTopic

All Implemented Interfaces:

javax.jms.Destination, javax.jms.Topic, LocalDestinationMBean, LocalTopicMBean, DestinationDescriptorMBean, Committable

public final class LocalTopic
extends AbstractLocalDestination
implements javax.jms.Topic, LocalTopicMBean

Implementation for a local JMS Topic

Field Summary

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

closed, closeLock, consumersLock, destinationDef, localConsumers, transactionLock

Constructor Summary

Constructors

Constructor and Description
LocalTopic(TopicDefinition topicDef) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Release destination resources
void	closeTransaction() Unlock the destination for transactional update
void	commitChanges(SynchronizationBarrier barrier) Commit all changes (make sure they are really applied) (ASYNCHRONOUS)
String	getConsumersSummary()
TopicDefinition	getDefinition() Get the queue definition
long	getDispatchedFromTopicCount() Get the number of messages dispatched from this topic (since startup or last reset)
int	getIndexedSubscriptionsCount() Get the number of indexed subscriptions on this topic
long	getSentToTopicCount() Get the number of messages sent to this topic (since startup or last reset)
int	getSize() Get the destination size (number of contained messages)
int	getSubscriptionsCount() Get the number of active subscriptions on this topic
String	getTopicName()
protected boolean	hasPendingChanges() Test if this destinations still has some uncommitted changes
boolean	putLocked(AbstractMessage srcMessage, LocalSession session, MessageLockSet locks) Put a new message in the destination.
void	registerConsumer(LocalMessageConsumer consumer) Register a message consumer on 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	unregisterConsumer(LocalMessageConsumer consumer) Unregister a message listener
void	unsubscribe(String clientID, String subscriptionName) Unsubscribe all durable consumers for a given client ID and subscription name

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

checkNotClosed, checkTransactionLock, 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

Methods inherited from class java.lang.Object

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

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

getAverageCommitTime, getMaxCommitTime, getMinCommitTime, getRegisteredConsumersCount

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

Constructor Detail

LocalTopic

public LocalTopic(TopicDefinition topicDef)

Constructor

Method Detail

getDefinition

public TopicDefinition getDefinition()

Get the queue definition

getTopicName

public String getTopicName()

Specified by:

getTopicName in interface javax.jms.Topic

registerConsumer

public void registerConsumer(LocalMessageConsumer consumer)

Description copied from class: AbstractLocalDestination

Register a message consumer on this queue

Overrides:

registerConsumer in class AbstractLocalDestination

unregisterConsumer

public void unregisterConsumer(LocalMessageConsumer consumer)

Description copied from class: AbstractLocalDestination

Unregister a message listener

Overrides:

unregisterConsumer in class AbstractLocalDestination

unsubscribe

public void unsubscribe(String clientID,
                        String subscriptionName)
                 throws javax.jms.JMSException

Unsubscribe all durable consumers for a given client ID and subscription name

Throws:

javax.jms.JMSException

putLocked

public boolean putLocked(AbstractMessage srcMessage,
                         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

getSize

public int getSize()

Description copied from interface: LocalDestinationMBean

Get the destination size (number of contained messages)

Specified by:

getSize in interface LocalDestinationMBean

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

getSentToTopicCount

public long getSentToTopicCount()

Description copied from interface: LocalTopicMBean

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

Specified by:

getSentToTopicCount in interface LocalTopicMBean

getDispatchedFromTopicCount

public long getDispatchedFromTopicCount()

Description copied from interface: LocalTopicMBean

Get the number of messages dispatched from this topic (since startup or last reset)

Specified by:

getDispatchedFromTopicCount in interface LocalTopicMBean

getSubscriptionsCount

public int getSubscriptionsCount()

Description copied from interface: LocalTopicMBean

Get the number of active subscriptions on this topic

Specified by:

getSubscriptionsCount in interface LocalTopicMBean

getIndexedSubscriptionsCount

public int getIndexedSubscriptionsCount()

Description copied from interface: LocalTopicMBean

Get the number of indexed subscriptions on this topic

Specified by:

getIndexedSubscriptionsCount in interface LocalTopicMBean

toString

public String toString()

Specified by:

toString in interface javax.jms.Topic

Overrides:

toString in class Object

getConsumersSummary

public String getConsumersSummary()

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

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

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

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

closeTransaction

public void closeTransaction()

Description copied from interface: Committable

Unlock the destination for transactional update

Specified by:

closeTransaction in interface Committable

Overrides:

closeTransaction in class AbstractLocalDestination