Package org.apache.activemq.store.memory

Class MemoryPersistenceAdapter

java.lang.Object

org.apache.activemq.store.memory.MemoryPersistenceAdapter

All Implemented Interfaces:

BrokerServiceAware, org.apache.activemq.Service, NoLocalSubscriptionAware, PersistenceAdapter

public class MemoryPersistenceAdapter
extends Object
implements PersistenceAdapter, NoLocalSubscriptionAware, BrokerServiceAware

Field Summary

Fields

Modifier and Type	Field	Description
protected BrokerService	brokerService

Constructor Summary

Constructors

Constructor	Description
MemoryPersistenceAdapter()

Method Summary

Modifier and Type	Method	Description
void	allowIOResumption()
protected MemoryMessageStore	asMemoryMessageStore(Object value)
void	beginTransaction(ConnectionContext context)	This method starts a transaction on the persistent storage - which is nothing to do with JMS or XA transactions - its purely a mechanism to perform multiple writes to a persistent store in 1 transaction as a performance optimization.
void	checkpoint(boolean sync)	checkpoint any
void	commitTransaction(ConnectionContext context)	Commit a persistence transaction
JobSchedulerStore	createJobSchedulerStore()	Creates and returns a new Job Scheduler store instance.
MessageStore	createQueueMessageStore(org.apache.activemq.command.ActiveMQQueue destination)	Factory method to create a new queue message store with the given destination name
TopicMessageStore	createTopicMessageStore(org.apache.activemq.command.ActiveMQTopic destination)	Factory method to create a new topic message store with the given destination name
TransactionStore	createTransactionStore()	Factory method to create a new persistent prepared transaction store for XA recovery
void	deleteAllMessages()	Delete's all the messages in the persistent store.
Set<org.apache.activemq.command.ActiveMQDestination>	getDestinations()	Returns a set of all the ActiveMQDestination objects that the persistence store is aware exist.
File	getDirectory()
long	getLastMessageBrokerSequenceId()
long	getLastProducerSequenceId(org.apache.activemq.command.ProducerId id)	return the last stored producer sequenceId for this producer Id used to suppress duplicate sends on failover reconnect at the transport when a reconnect occurs
boolean	isPersistNoLocal()
boolean	isUseExternalMessageReferences()
static MemoryPersistenceAdapter	newInstance(File file)
void	removeQueueMessageStore(org.apache.activemq.command.ActiveMQQueue destination)	Cleanup method to remove any state associated with the given destination
void	removeTopicMessageStore(org.apache.activemq.command.ActiveMQTopic destination)	Cleanup method to remove any state associated with the given destination
void	rollbackTransaction(ConnectionContext context)	Rollback a persistence transaction
void	setBrokerName(String brokerName)	Set the name of the broker using the adapter
void	setBrokerService(BrokerService brokerService)
void	setCreateTransactionStore(boolean create)
void	setDirectory(File dir)	Set the directory where any data files should be created
void	setUsageManager(SystemUsage usageManager)
void	setUseExternalMessageReferences(boolean useExternalMessageReferences)
long	size()	A hint to return the size of the store on disk
void	start()
void	stop()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

brokerService

protected BrokerService brokerService

Constructor Detail

MemoryPersistenceAdapter

public MemoryPersistenceAdapter()

Method Detail

getDestinations

public Set<org.apache.activemq.command.ActiveMQDestination> getDestinations()

Description copied from interface: PersistenceAdapter

Returns a set of all the ActiveMQDestination objects that the persistence store is aware exist.

Specified by:

getDestinations in interface PersistenceAdapter

Returns:

active destinations

newInstance

public static MemoryPersistenceAdapter newInstance(File file)

createQueueMessageStore

public MessageStore createQueueMessageStore(org.apache.activemq.command.ActiveMQQueue destination)
                                     throws IOException

Description copied from interface: PersistenceAdapter

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

Specified by:

createQueueMessageStore in interface PersistenceAdapter

Returns:

the message store

Throws:

IOException

createTopicMessageStore

public TopicMessageStore createTopicMessageStore(org.apache.activemq.command.ActiveMQTopic destination)
                                          throws IOException

Description copied from interface: PersistenceAdapter

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

Specified by:

createTopicMessageStore in interface PersistenceAdapter

Returns:

the topic message store

Throws:

IOException

removeQueueMessageStore

public void removeQueueMessageStore(org.apache.activemq.command.ActiveMQQueue destination)

Cleanup method to remove any state associated with the given destination

Specified by:

removeQueueMessageStore in interface PersistenceAdapter

Parameters:

destination - Destination to forget

removeTopicMessageStore

public void removeTopicMessageStore(org.apache.activemq.command.ActiveMQTopic destination)

Cleanup method to remove any state associated with the given destination

Specified by:

removeTopicMessageStore in interface PersistenceAdapter

Parameters:

destination - Destination to forget

createTransactionStore

public TransactionStore createTransactionStore()
                                        throws IOException

Description copied from interface: PersistenceAdapter

Factory method to create a new persistent prepared transaction store for XA recovery

Specified by:

createTransactionStore in interface PersistenceAdapter

Returns:

transaction store

Throws:

IOException

beginTransaction

public void beginTransaction(ConnectionContext context)

Description copied from interface: PersistenceAdapter

This method starts a transaction on the persistent storage - which is nothing to do with JMS or XA transactions - its purely a mechanism to perform multiple writes to a persistent store in 1 transaction as a performance optimization.

Typically one transaction will require one disk synchronization point and so for real high performance its usually faster to perform many writes within the same transaction to minimize latency caused by disk synchronization. This is especially true when using tools like Berkeley Db or embedded JDBC servers.

Specified by:

beginTransaction in interface PersistenceAdapter

commitTransaction

public void commitTransaction(ConnectionContext context)

Description copied from interface: PersistenceAdapter

Commit a persistence transaction

Specified by:

commitTransaction in interface PersistenceAdapter

See Also:

PersistenceAdapter.beginTransaction(ConnectionContext context)

rollbackTransaction

public void rollbackTransaction(ConnectionContext context)

Description copied from interface: PersistenceAdapter

Rollback a persistence transaction

Specified by:

rollbackTransaction in interface PersistenceAdapter

See Also:

PersistenceAdapter.beginTransaction(ConnectionContext context)

start

public void start()
           throws Exception

Specified by:

start in interface org.apache.activemq.Service

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface org.apache.activemq.Service

Throws:

Exception

getLastMessageBrokerSequenceId

public long getLastMessageBrokerSequenceId()
                                    throws IOException

Specified by:

getLastMessageBrokerSequenceId in interface PersistenceAdapter

Returns:

last broker sequence

Throws:

IOException

deleteAllMessages

public void deleteAllMessages()
                       throws IOException

Description copied from interface: PersistenceAdapter

Delete's all the messages in the persistent store.

Specified by:

deleteAllMessages in interface PersistenceAdapter

Throws:

IOException

isUseExternalMessageReferences

public boolean isUseExternalMessageReferences()

setUseExternalMessageReferences

public void setUseExternalMessageReferences(boolean useExternalMessageReferences)

asMemoryMessageStore

protected MemoryMessageStore asMemoryMessageStore(Object value)

setUsageManager

public void setUsageManager(SystemUsage usageManager)

Specified by:

setUsageManager in interface PersistenceAdapter

Parameters:

usageManager - The UsageManager that is controlling the broker's memory usage.

toString

public String toString()

Overrides:

toString in class Object

setBrokerName

public void setBrokerName(String brokerName)

Description copied from interface: PersistenceAdapter

Set the name of the broker using the adapter

Specified by:

setBrokerName in interface PersistenceAdapter

setDirectory

public void setDirectory(File dir)

Description copied from interface: PersistenceAdapter

Set the directory where any data files should be created

Specified by:

setDirectory in interface PersistenceAdapter

getDirectory

public File getDirectory()

Specified by:

getDirectory in interface PersistenceAdapter

Returns:

the directory used by the persistence adaptor

checkpoint

public void checkpoint(boolean sync)
                throws IOException

Description copied from interface: PersistenceAdapter

checkpoint any

Specified by:

checkpoint in interface PersistenceAdapter

Throws:

IOException

size

public long size()

Description copied from interface: PersistenceAdapter

A hint to return the size of the store on disk

Specified by:

size in interface PersistenceAdapter

Returns:

disk space used in bytes of 0 if not implemented

setCreateTransactionStore

public void setCreateTransactionStore(boolean create)
                               throws IOException

Throws:

IOException

getLastProducerSequenceId

public long getLastProducerSequenceId(org.apache.activemq.command.ProducerId id)

Description copied from interface: PersistenceAdapter

return the last stored producer sequenceId for this producer Id used to suppress duplicate sends on failover reconnect at the transport when a reconnect occurs

Specified by:

getLastProducerSequenceId in interface PersistenceAdapter

Parameters:

id - the producerId to find a sequenceId for

Returns:

the last stored sequence id or -1 if no suppression needed

allowIOResumption

public void allowIOResumption()

Specified by:

allowIOResumption in interface PersistenceAdapter

createJobSchedulerStore

public JobSchedulerStore createJobSchedulerStore()
                                          throws IOException,
                                                 UnsupportedOperationException

Description copied from interface: PersistenceAdapter

Creates and returns a new Job Scheduler store instance.

Specified by:

createJobSchedulerStore in interface PersistenceAdapter

Returns:

a new JobSchedulerStore instance if this Persistence adapter provides its own.

Throws:

IOException - If an error occurs while creating the new JobSchedulerStore.

UnsupportedOperationException - If this adapter does not provide its own scheduler store implementation.

isPersistNoLocal

public boolean isPersistNoLocal()

Specified by:

isPersistNoLocal in interface NoLocalSubscriptionAware

setBrokerService

public void setBrokerService(BrokerService brokerService)

Specified by:

setBrokerService in interface BrokerServiceAware