org.apache.activemq.store
Interface ReferenceStoreAdapter

All Superinterfaces:

PersistenceAdapter, Service

All Known Implementing Classes:

KahaReferenceStoreAdapter

public interface ReferenceStoreAdapter
extends PersistenceAdapter

Adapter to the actual persistence mechanism used with ActiveMQ

Method Summary

void	clearMessages() called by recover to clear out message references
ReferenceStore	createQueueReferenceStore(ActiveMQQueue destination) Factory method to create a new queue message store with the given destination name
TopicReferenceStore	createTopicReferenceStore(ActiveMQTopic destination) Factory method to create a new topic message store with the given destination name
long	getMaxDataFileLength()
java.util.Set<java.lang.Integer>	getReferenceFileIdsInUse()
boolean	isStoreValid() If the store isn't valid, it can be recoverd at start-up
void	recoverState() recover any state
void	recoverSubscription(SubscriptionInfo info) Recover particular subscription.
java.util.Map<TransactionId,AMQTx>	retrievePreparedState()
void	savePreparedState(java.util.Map<TransactionId,AMQTx> map) Save prepared transactions
void	setMaxDataFileLength(long maxDataFileLength) set the max data length of a reference data log - if used

Methods inherited from interface org.apache.activemq.store.PersistenceAdapter

beginTransaction, checkpoint, commitTransaction, createQueueMessageStore, createTopicMessageStore, createTransactionStore, deleteAllMessages, getDestinations, getDirectory, getLastMessageBrokerSequenceId, getLastProducerSequenceId, removeQueueMessageStore, removeTopicMessageStore, rollbackTransaction, setBrokerName, setDirectory, setUsageManager, size

Methods inherited from interface org.apache.activemq.Service

start, stop

Method Detail

createQueueReferenceStore

ReferenceStore createQueueReferenceStore(ActiveMQQueue destination)
                                         throws java.io.IOException

Factory method to create a new queue message store with the given destination name

Parameters:

destination -

Returns:

the QueueReferenceStore

Throws:

java.io.IOException

createTopicReferenceStore

TopicReferenceStore createTopicReferenceStore(ActiveMQTopic destination)
                                              throws java.io.IOException

Factory method to create a new topic message store with the given destination name

Parameters:

destination -

Returns:

the TopicRefererenceStore

Throws:

java.io.IOException

getReferenceFileIdsInUse

java.util.Set<java.lang.Integer> getReferenceFileIdsInUse()
                                                          throws java.io.IOException

Returns:

Set of File ids in use

Throws:

java.io.IOException

isStoreValid

boolean isStoreValid()

If the store isn't valid, it can be recoverd at start-up

Returns:

true if the reference store is in a consistent state

clearMessages

void clearMessages()
                   throws java.io.IOException

called by recover to clear out message references

Throws:

java.io.IOException

recoverState

void recoverState()
                  throws java.io.IOException

recover any state

Throws:

java.io.IOException

savePreparedState

void savePreparedState(java.util.Map<TransactionId,AMQTx> map)
                       throws java.io.IOException

Save prepared transactions

Parameters:

map -

Throws:

java.io.IOException

retrievePreparedState

java.util.Map<TransactionId,AMQTx> retrievePreparedState()
                                                         throws java.io.IOException

Returns:

saved prepared transactions

Throws:

java.io.IOException

getMaxDataFileLength

long getMaxDataFileLength()

Returns:

the maxDataFileLength

setMaxDataFileLength

void setMaxDataFileLength(long maxDataFileLength)

set the max data length of a reference data log - if used

Parameters:

maxDataFileLength -

recoverSubscription

void recoverSubscription(SubscriptionInfo info)
                         throws java.io.IOException

Recover particular subscription. Used for recovery of durable consumers

Parameters:

info -

Throws:

java.io.IOException