org.hornetq.core.persistence.impl.nullpm

Class NullStorageManager

java.lang.Object

org.hornetq.core.persistence.impl.nullpm.NullStorageManager

All Implemented Interfaces:

StorageManager, HornetQComponent

public class NullStorageManager
extends Object
implements StorageManager

A NullStorageManager

Author:

Andy Taylor, Tim Fox

Nested Class Summary

Nested classes/interfaces inherited from interface org.hornetq.core.persistence.StorageManager

StorageManager.LargeMessageExtension

Constructor Summary

Constructors

Constructor and Description
NullStorageManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBytesToLargeMessage(SequentialFile appendFile, long messageID, byte[] bytes)
void	addGrouping(GroupBinding groupBinding)
void	addQueueBinding(long tx, Binding binding)
boolean	addToPage(PagingStore s, ServerMessage msg, Transaction tx, RouteContextList listCtx) Write message to page if we are paging.
void	afterCompleteOperations(IOAsyncTask run)
void	afterPageRead() We need a safeguard in place to avoid too much concurrent IO happening on Paging, otherwise the system may become unresponsive if too many destinations are reading all the same time.
ByteBuffer	allocateDirectBuffer(int size) AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC.
void	beforePageRead() We need a safeguard in place to avoid too much concurrent IO happening on Paging, otherwise the system may become unresponsive if too many destinations are reading all the same time.
void	clearContext()
void	commit(long txID)
void	commit(long txID, boolean lineUpContext)
void	commitBindings(long txID)
void	confirmPendingLargeMessage(long recordID) Confirms that a large message was finished
void	confirmPendingLargeMessageTX(Transaction transaction, long messageID, long recordID) Confirms that a large message was finished
SequentialFile	createFileForLargeMessage(long messageID, StorageManager.LargeMessageExtension extension) Instantiates a SequentialFile to be used for storing a LargeServerMessage.
LargeServerMessage	createLargeMessage()
LargeServerMessage	createLargeMessage(long id, MessageInternal message) Creates a new LargeMessage with the given id.
void	deleteAddressSetting(SimpleString addressMatch)
void	deleteCursorAcknowledge(long ackID)
void	deleteCursorAcknowledgeTransactional(long txID, long ackID)
void	deleteDuplicateID(long recordID)
void	deleteDuplicateIDTransactional(long txID, long recordID)
void	deleteGrouping(GroupBinding groupBinding)
void	deleteHeuristicCompletion(long txID)
void	deleteIncrementRecord(long txID, long recordID)
void	deleteMessage(long messageID)
void	deletePageComplete(long ackID)
void	deletePageCounter(long txID, long recordID)
void	deletePageTransactional(long recordID)
void	deleteQueueBinding(long tx, long queueBindingID)
void	deleteSecurityRoles(SimpleString addressMatch)
void	freeDirectBuffer(ByteBuffer buffer) AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC.
long	generateUniqueID()
Journal	getBindingsJournal()
OperationContext	getContext() Get the context associated with the thread for later reuse
long	getCurrentUniqueID()
Journal	getMessageJournal()
boolean	isStarted()
void	lineUpContext()
JournalLoadInformation	loadBindingJournal(List<QueueBindingInfo> queueBindingInfos, List<GroupingInfo> groupingInfos)
JournalLoadInformation	loadMessageJournal(PostOffice postOffice, PagingManager pagingManager, ResourceManager resourceManager, Map<Long,Queue> queues, Map<Long,QueueBindingInfo> queueInfos, Map<SimpleString,List<Pair<byte[],Long>>> duplicateIDMap, Set<Pair<Long,Long>> pendingLargeMessages)
OperationContext	newContext(Executor executor) It just creates an OperationContext without associating it
OperationContext	newSingleThreadContext()
void	pageClosed(SimpleString storeName, int pageNumber)
void	pageDeleted(SimpleString storeName, int pageNumber)
void	pageWrite(PagedMessage message, int pageNumber)
void	persistIdGenerator() Closes the IDGenerator persisting the current record ID.
void	prepare(long txID, Xid xid)
void	readLock() Read lock the StorageManager.
void	readUnLock() Unlock the manager.
List<PersistedAddressSetting>	recoverAddressSettings()
List<PersistedRoles>	recoverPersistedRoles()
void	rollback(long txID)
void	rollbackBindings(long txID)
void	setContext(OperationContext context) Set the context back to the thread
void	start()
void	startReplication(ReplicationManager replicationManager, PagingManager pagingManager, String nodeID, boolean autoFailBack)
void	stop()
void	stop(boolean ioCriticalError)
void	stopReplication() Stops the replication of data from the live to the backup.
void	storeAcknowledge(long queueID, long messageID)
void	storeAcknowledgeTransactional(long txID, long queueID, long messageiD)
void	storeAddressSetting(PersistedAddressSetting addressSetting)
void	storeCursorAcknowledge(long queueID, PagePosition position)
void	storeCursorAcknowledgeTransactional(long txID, long queueID, PagePosition position)
void	storeDuplicateID(SimpleString address, byte[] duplID, long recordID)
void	storeDuplicateIDTransactional(long txID, SimpleString address, byte[] duplID, long recordID)
long	storeHeuristicCompletion(Xid xid, boolean isCommit)
void	storeID(long journalID, long id) Stores the given journalID in the bindingsJournal.
void	storeMessage(ServerMessage message)
void	storeMessageTransactional(long txID, ServerMessage message)
void	storePageCompleteTransactional(long txID, long queueID, PagePosition position)
long	storePageCounter(long txID, long queueID, long value)
long	storePageCounterInc(long queueID, int add)
long	storePageCounterInc(long txID, long queueID, int add)
void	storePageTransaction(long txID, PageTransactionInfo pageTransaction)
void	storeReference(long queueID, long messageID, boolean last)
void	storeReferenceTransactional(long txID, long queueID, long messageID)
void	storeSecurityRoles(PersistedRoles persistedRoles)
void	updateDeliveryCount(MessageReference ref)
void	updateDuplicateIDTransactional(long txID, SimpleString address, byte[] duplID, long recordID)
void	updatePageTransaction(long txID, PageTransactionInfo pageTransaction, int depage)
void	updatePageTransaction(PageTransactionInfo pageTransaction, int depage) FIXME Unused
void	updateScheduledDeliveryTime(MessageReference ref)
void	updateScheduledDeliveryTimeTransactional(long txID, MessageReference ref)
void	waitOnOperations() Block until the operations are done.
boolean	waitOnOperations(long timeout) Block until the operations are done.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullStorageManager

public NullStorageManager()

Method Detail

deleteQueueBinding

public void deleteQueueBinding(long tx,
                      long queueBindingID)
                        throws Exception

Specified by:

deleteQueueBinding in interface StorageManager

Throws:

Exception

commit

public void commit(long txID)
            throws Exception

Specified by:

commit in interface StorageManager

Throws:

Exception

loadBindingJournal

public JournalLoadInformation loadBindingJournal(List<QueueBindingInfo> queueBindingInfos,
                                        List<GroupingInfo> groupingInfos)
                                          throws Exception

Specified by:

loadBindingJournal in interface StorageManager

Throws:

Exception

prepare

public void prepare(long txID,
           Xid xid)
             throws Exception

Specified by:

prepare in interface StorageManager

Throws:

Exception

rollback

public void rollback(long txID)
              throws Exception

Specified by:

rollback in interface StorageManager

Throws:

Exception

rollbackBindings

public void rollbackBindings(long txID)
                      throws Exception

Specified by:

rollbackBindings in interface StorageManager

Throws:

Exception

commitBindings

public void commitBindings(long txID)
                    throws Exception

Specified by:

commitBindings in interface StorageManager

Throws:

Exception

storeReference

public void storeReference(long queueID,
                  long messageID,
                  boolean last)
                    throws Exception

Specified by:

storeReference in interface StorageManager

Throws:

Exception

storeReferenceTransactional

public void storeReferenceTransactional(long txID,
                               long queueID,
                               long messageID)
                                 throws Exception

Specified by:

storeReferenceTransactional in interface StorageManager

Throws:

Exception

storeAcknowledge

public void storeAcknowledge(long queueID,
                    long messageID)
                      throws Exception

Specified by:

storeAcknowledge in interface StorageManager

Throws:

Exception

storeAcknowledgeTransactional

public void storeAcknowledgeTransactional(long txID,
                                 long queueID,
                                 long messageiD)
                                   throws Exception

Specified by:

storeAcknowledgeTransactional in interface StorageManager

Throws:

Exception

deleteMessage

public void deleteMessage(long messageID)
                   throws Exception

Specified by:

deleteMessage in interface StorageManager

Throws:

Exception

storeMessage

public void storeMessage(ServerMessage message)
                  throws Exception

Specified by:

storeMessage in interface StorageManager

Throws:

Exception

storeMessageTransactional

public void storeMessageTransactional(long txID,
                             ServerMessage message)
                               throws Exception

Specified by:

storeMessageTransactional in interface StorageManager

Throws:

Exception

updateScheduledDeliveryTime

public void updateScheduledDeliveryTime(MessageReference ref)
                                 throws Exception

Specified by:

updateScheduledDeliveryTime in interface StorageManager

Throws:

Exception

updateScheduledDeliveryTimeTransactional

public void updateScheduledDeliveryTimeTransactional(long txID,
                                            MessageReference ref)
                                              throws Exception

Specified by:

updateScheduledDeliveryTimeTransactional in interface StorageManager

Throws:

Exception

storePageTransaction

public void storePageTransaction(long txID,
                        PageTransactionInfo pageTransaction)
                          throws Exception

Specified by:

storePageTransaction in interface StorageManager

Throws:

Exception

updateDeliveryCount

public void updateDeliveryCount(MessageReference ref)
                         throws Exception

Specified by:

updateDeliveryCount in interface StorageManager

Throws:

Exception

storeDuplicateID

public void storeDuplicateID(SimpleString address,
                    byte[] duplID,
                    long recordID)
                      throws Exception

Specified by:

storeDuplicateID in interface StorageManager

Throws:

Exception

storeDuplicateIDTransactional

public void storeDuplicateIDTransactional(long txID,
                                 SimpleString address,
                                 byte[] duplID,
                                 long recordID)
                                   throws Exception

Specified by:

storeDuplicateIDTransactional in interface StorageManager

Throws:

Exception

updateDuplicateIDTransactional

public void updateDuplicateIDTransactional(long txID,
                                  SimpleString address,
                                  byte[] duplID,
                                  long recordID)
                                    throws Exception

Specified by:

updateDuplicateIDTransactional in interface StorageManager

Throws:

Exception

storeHeuristicCompletion

public long storeHeuristicCompletion(Xid xid,
                            boolean isCommit)
                              throws Exception

Specified by:

storeHeuristicCompletion in interface StorageManager

Throws:

Exception

deleteHeuristicCompletion

public void deleteHeuristicCompletion(long txID)
                               throws Exception

Specified by:

deleteHeuristicCompletion in interface StorageManager

Throws:

Exception

addQueueBinding

public void addQueueBinding(long tx,
                   Binding binding)
                     throws Exception

Specified by:

addQueueBinding in interface StorageManager

Throws:

Exception

createLargeMessage

public LargeServerMessage createLargeMessage()

Specified by:

createLargeMessage in interface StorageManager

createLargeMessage

public LargeServerMessage createLargeMessage(long id,
                                    MessageInternal message)

Description copied from interface: StorageManager

Creates a new LargeMessage with the given id.

Specified by:

createLargeMessage in interface StorageManager

message - This is a temporary message that holds the parsed properties. The remoting layer can't create a ServerMessage directly, then this will be replaced.

Returns:

a large message object

generateUniqueID

public long generateUniqueID()

Specified by:

generateUniqueID in interface StorageManager

getCurrentUniqueID

public long getCurrentUniqueID()

Specified by:

getCurrentUniqueID in interface StorageManager

start

public void start()
           throws Exception

Specified by:

start in interface HornetQComponent

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface HornetQComponent

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface HornetQComponent

loadMessageJournal

public JournalLoadInformation loadMessageJournal(PostOffice postOffice,
                                        PagingManager pagingManager,
                                        ResourceManager resourceManager,
                                        Map<Long,Queue> queues,
                                        Map<Long,QueueBindingInfo> queueInfos,
                                        Map<SimpleString,List<Pair<byte[],Long>>> duplicateIDMap,
                                        Set<Pair<Long,Long>> pendingLargeMessages)
                                          throws Exception

Specified by:

loadMessageJournal in interface StorageManager

Throws:

Exception

deleteDuplicateIDTransactional

public void deleteDuplicateIDTransactional(long txID,
                                  long recordID)
                                    throws Exception

Specified by:

deleteDuplicateIDTransactional in interface StorageManager

Throws:

Exception

deleteDuplicateID

public void deleteDuplicateID(long recordID)
                       throws Exception

Specified by:

deleteDuplicateID in interface StorageManager

Throws:

Exception

pageClosed

public void pageClosed(SimpleString storeName,
              int pageNumber)

Specified by:

pageClosed in interface StorageManager

pageDeleted

public void pageDeleted(SimpleString storeName,
               int pageNumber)

Specified by:

pageDeleted in interface StorageManager

pageWrite

public void pageWrite(PagedMessage message,
             int pageNumber)

Specified by:

pageWrite in interface StorageManager

addGrouping

public void addGrouping(GroupBinding groupBinding)
                 throws Exception

Specified by:

addGrouping in interface StorageManager

Throws:

Exception

deleteGrouping

public void deleteGrouping(GroupBinding groupBinding)
                    throws Exception

Specified by:

deleteGrouping in interface StorageManager

Throws:

Exception

waitOnOperations

public boolean waitOnOperations(long timeout)
                         throws Exception

Description copied from interface: StorageManager

Block until the operations are done. Warning: Don't use it inside an ordered executor, otherwise the system may lock up in case of the pools are full

Specified by:

waitOnOperations in interface StorageManager

Throws:

Exception

afterCompleteOperations

public void afterCompleteOperations(IOAsyncTask run)

Specified by:

afterCompleteOperations in interface StorageManager

waitOnOperations

public void waitOnOperations()
                      throws Exception

Description copied from interface: StorageManager

Block until the operations are done. Warning: Don't use it inside an ordered executor, otherwise the system may lock up in case of the pools are full

Specified by:

waitOnOperations in interface StorageManager

Throws:

Exception

getContext

public OperationContext getContext()

Description copied from interface: StorageManager

Get the context associated with the thread for later reuse

Specified by:

getContext in interface StorageManager

newContext

public OperationContext newContext(Executor executor)

Description copied from interface: StorageManager

It just creates an OperationContext without associating it

Specified by:

newContext in interface StorageManager

newSingleThreadContext

public OperationContext newSingleThreadContext()

Specified by:

newSingleThreadContext in interface StorageManager

setContext

public void setContext(OperationContext context)

Description copied from interface: StorageManager

Set the context back to the thread

Specified by:

setContext in interface StorageManager

clearContext

public void clearContext()

Specified by:

clearContext in interface StorageManager

recoverAddressSettings

public List<PersistedAddressSetting> recoverAddressSettings()
                                                     throws Exception

Specified by:

recoverAddressSettings in interface StorageManager

Throws:

Exception

storeAddressSetting

public void storeAddressSetting(PersistedAddressSetting addressSetting)
                         throws Exception

Specified by:

storeAddressSetting in interface StorageManager

Throws:

Exception

recoverPersistedRoles

public List<PersistedRoles> recoverPersistedRoles()
                                           throws Exception

Specified by:

recoverPersistedRoles in interface StorageManager

Throws:

Exception

storeSecurityRoles

public void storeSecurityRoles(PersistedRoles persistedRoles)
                        throws Exception

Specified by:

storeSecurityRoles in interface StorageManager

Throws:

Exception

deleteAddressSetting

public void deleteAddressSetting(SimpleString addressMatch)
                          throws Exception

Specified by:

deleteAddressSetting in interface StorageManager

Throws:

Exception

deleteSecurityRoles

public void deleteSecurityRoles(SimpleString addressMatch)
                         throws Exception

Specified by:

deleteSecurityRoles in interface StorageManager

Throws:

Exception

deletePageTransactional

public void deletePageTransactional(long recordID)
                             throws Exception

Specified by:

deletePageTransactional in interface StorageManager

Throws:

Exception

updatePageTransaction

public void updatePageTransaction(long txID,
                         PageTransactionInfo pageTransaction,
                         int depage)
                           throws Exception

Specified by:

updatePageTransaction in interface StorageManager

Throws:

Exception

storeCursorAcknowledge

public void storeCursorAcknowledge(long queueID,
                          PagePosition position)

Specified by:

storeCursorAcknowledge in interface StorageManager

storeCursorAcknowledgeTransactional

public void storeCursorAcknowledgeTransactional(long txID,
                                       long queueID,
                                       PagePosition position)

Specified by:

storeCursorAcknowledgeTransactional in interface StorageManager

deleteCursorAcknowledgeTransactional

public void deleteCursorAcknowledgeTransactional(long txID,
                                        long ackID)
                                          throws Exception

Specified by:

deleteCursorAcknowledgeTransactional in interface StorageManager

Throws:

Exception

deleteCursorAcknowledge

public void deleteCursorAcknowledge(long ackID)
                             throws Exception

Specified by:

deleteCursorAcknowledge in interface StorageManager

Throws:

Exception

storePageCompleteTransactional

public void storePageCompleteTransactional(long txID,
                                  long queueID,
                                  PagePosition position)
                                    throws Exception

Specified by:

storePageCompleteTransactional in interface StorageManager

Throws:

Exception

deletePageComplete

public void deletePageComplete(long ackID)
                        throws Exception

Specified by:

deletePageComplete in interface StorageManager

Throws:

Exception

updatePageTransaction

public void updatePageTransaction(PageTransactionInfo pageTransaction,
                         int depage)
                           throws Exception

Description copied from interface: StorageManager

FIXME Unused

Specified by:

updatePageTransaction in interface StorageManager

Throws:

Exception

storePageCounter

public long storePageCounter(long txID,
                    long queueID,
                    long value)
                      throws Exception

Specified by:

storePageCounter in interface StorageManager

Returns:

The ID with the stored counter

Throws:

Exception

deleteIncrementRecord

public void deleteIncrementRecord(long txID,
                         long recordID)
                           throws Exception

Specified by:

deleteIncrementRecord in interface StorageManager

Throws:

Exception

deletePageCounter

public void deletePageCounter(long txID,
                     long recordID)
                       throws Exception

Specified by:

deletePageCounter in interface StorageManager

Throws:

Exception

storePageCounterInc

public long storePageCounterInc(long txID,
                       long queueID,
                       int add)
                         throws Exception

Specified by:

storePageCounterInc in interface StorageManager

Returns:

the ID with the increment record

Throws:

Exception

storePageCounterInc

public long storePageCounterInc(long queueID,
                       int add)
                         throws Exception

Specified by:

storePageCounterInc in interface StorageManager

Returns:

the ID with the increment record

Throws:

Exception

commit

public void commit(long txID,
          boolean lineUpContext)
            throws Exception

Specified by:

commit in interface StorageManager

Throws:

Exception

lineUpContext

public void lineUpContext()

Specified by:

lineUpContext in interface StorageManager

confirmPendingLargeMessageTX

public void confirmPendingLargeMessageTX(Transaction transaction,
                                long messageID,
                                long recordID)
                                  throws Exception

Description copied from interface: StorageManager

Confirms that a large message was finished

Specified by:

confirmPendingLargeMessageTX in interface StorageManager

Throws:

Exception

confirmPendingLargeMessage

public void confirmPendingLargeMessage(long recordID)
                                throws Exception

Description copied from interface: StorageManager

Confirms that a large message was finished

Specified by:

confirmPendingLargeMessage in interface StorageManager

Throws:

Exception

stop

public void stop(boolean ioCriticalError)
          throws Exception

Specified by:

stop in interface StorageManager

Parameters:

ioCriticalError - is the server being stopped due to an IO critical error

Throws:

Exception

getBindingsJournal

public Journal getBindingsJournal()

Specified by:

getBindingsJournal in interface StorageManager

Returns:

the bindings journal

getMessageJournal

public Journal getMessageJournal()

Specified by:

getMessageJournal in interface StorageManager

Returns:

the message journal

startReplication

public void startReplication(ReplicationManager replicationManager,
                    PagingManager pagingManager,
                    String nodeID,
                    boolean autoFailBack)
                      throws Exception

Specified by:

startReplication in interface StorageManager

Throws:

Exception

See Also:

JournalStorageManager.startReplication(ReplicationManager, PagingManager, String, boolean)

addToPage

public boolean addToPage(PagingStore s,
                ServerMessage msg,
                Transaction tx,
                RouteContextList listCtx)
                  throws Exception

Description copied from interface: StorageManager

Write message to page if we are paging.

This is primarily a PagingStore call, but as with any other call writing persistent data, it must go through here. Both for the sake of replication, and also to ensure that it takes the locks (storage manager and pagingStore) in the right order. Avoiding thus the creation of dead-locks.

Specified by:

addToPage in interface StorageManager

Returns:

true if we are paging and have handled the data, false if the data needs to be sent to the journal

Throws:

Exception

stopReplication

public void stopReplication()

Description copied from interface: StorageManager

Stops the replication of data from the live to the backup.

Typical scenario is a broken connection.

Specified by:

stopReplication in interface StorageManager

createFileForLargeMessage

public SequentialFile createFileForLargeMessage(long messageID,
                                       StorageManager.LargeMessageExtension extension)

Description copied from interface: StorageManager

Instantiates a SequentialFile to be used for storing a LargeServerMessage.

Specified by:

createFileForLargeMessage in interface StorageManager

Parameters:

messageID - the id of the message

extension - the extension to add to the file

Returns:

addBytesToLargeMessage

public void addBytesToLargeMessage(SequentialFile appendFile,
                          long messageID,
                          byte[] bytes)
                            throws Exception

Specified by:

addBytesToLargeMessage in interface StorageManager

Throws:

Exception

beforePageRead

public void beforePageRead()
                    throws Exception

Description copied from interface: StorageManager

We need a safeguard in place to avoid too much concurrent IO happening on Paging, otherwise the system may become unresponsive if too many destinations are reading all the same time. This is called before we read, so we can limit concurrent reads

Specified by:

beforePageRead in interface StorageManager

Throws:

Exception

afterPageRead

public void afterPageRead()
                   throws Exception

Description copied from interface: StorageManager

We need a safeguard in place to avoid too much concurrent IO happening on Paging, otherwise the system may become unresponsive if too many destinations are reading all the same time. This is called after we read, so we can limit concurrent reads

Specified by:

afterPageRead in interface StorageManager

Throws:

Exception

allocateDirectBuffer

public ByteBuffer allocateDirectBuffer(int size)

Description copied from interface: StorageManager

AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC. These methods will use that buffer if the inner method supports it

Specified by:

allocateDirectBuffer in interface StorageManager

freeDirectBuffer

public void freeDirectBuffer(ByteBuffer buffer)

Description copied from interface: StorageManager

AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC. These methods will use that buffer if the inner method supports it

Specified by:

freeDirectBuffer in interface StorageManager

storeID

public void storeID(long journalID,
           long id)
             throws Exception

Description copied from interface: StorageManager

Stores the given journalID in the bindingsJournal.

Specified by:

storeID in interface StorageManager

Throws:

Exception

readLock

public void readLock()

Description copied from interface: StorageManager

Read lock the StorageManager. USE WITH CARE!

The main lock is used to write lock the whole manager when starting replication. Sub-systems, say Paging classes, that use locks of their own AND also write through the StorageManager MUST first read lock the storageManager before taking their own locks. Otherwise, we may dead-lock when starting replication sync.

Specified by:

readLock in interface StorageManager

readUnLock

public void readUnLock()

Description copied from interface: StorageManager

Unlock the manager.

Specified by:

readUnLock in interface StorageManager

See Also:

StorageManager.readLock()

persistIdGenerator

public void persistIdGenerator()

Description copied from interface: StorageManager

Closes the IDGenerator persisting the current record ID.

Effectively a "pre-stop" method. Necessary due to the "stop"-order at HornetQServerImpl

Specified by:

persistIdGenerator in interface StorageManager