org.hornetq.core.persistence

Interface StorageManager

All Superinterfaces:

HornetQComponent

All Known Implementing Classes:

JournalStorageManager, NullStorageManager

public interface StorageManager
extends HornetQComponent

A StorageManager

Author:

Tim Fox, Clebert Suconic,

Method Summary

Methods

Modifier and Type	Method and Description
void	addGrouping(GroupBinding groupBinding)
void	addQueueBinding(long tx, Binding binding)
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 irrensponsive 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 irrensponsive 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)
void	confirmPendingLargeMessageTX(Transaction transaction, long messageID, long recordID)
LargeServerMessage	createLargeMessage()
LargeServerMessage	createLargeMessage(long id, MessageInternal message)
void	deleteAddressSetting(SimpleString addressMatch)
void	deleteCursorAcknowledgeTransactional(long txID, long ackID)
void	deleteDuplicateID(long recordID)
void	deleteDuplicateIDTransactional(long txID, long recordID)
void	deleteGrouping(GroupBinding groupBinding)
void	deleteHeuristicCompletion(long id)
void	deleteIncrementRecord(long txID, long recordID)
void	deleteMessage(long messageID)
void	deletePageCounter(long txID, long recordID)
void	deletePageTransactional(long recordID)
void	deleteQueueBinding(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()
OperationContext	getContext() Get the context associated with the thread for later reuse
long	getCurrentUniqueID()
boolean	isReplicated()
void	lineUpContext()
JournalLoadInformation	loadBindingJournal(List<QueueBindingInfo> queueBindingInfos, List<GroupingInfo> groupingInfos)
JournalLoadInformation[]	loadInternalOnly() This method is only useful at the backup side.
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	prepare(long txID, Xid xid)
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	stop(boolean ioCriticalError)
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	storeMessage(ServerMessage message)
void	storeMessageTransactional(long txID, ServerMessage message)
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)
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 interface org.hornetq.core.server.HornetQComponent

isStarted, start, stop

Method Detail

getContext

OperationContext getContext()

Get the context associated with the thread for later reuse

lineUpContext

void lineUpContext()

newContext

OperationContext newContext(Executor executor)

It just creates an OperationContext without associating it

newSingleThreadContext

OperationContext newSingleThreadContext()

setContext

void setContext(OperationContext context)

Set the context back to the thread

stop

void stop(boolean ioCriticalError)
          throws Exception

Parameters:

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

Throws:

Exception

pageClosed

void pageClosed(SimpleString storeName,
              int pageNumber)

pageDeleted

void pageDeleted(SimpleString storeName,
               int pageNumber)

pageWrite

void pageWrite(PagedMessage message,
             int pageNumber)

isReplicated

boolean isReplicated()

afterCompleteOperations

void afterCompleteOperations(IOAsyncTask run)

waitOnOperations

boolean waitOnOperations(long timeout)
                         throws Exception

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

Throws:

Exception

waitOnOperations

void waitOnOperations()
                      throws Exception

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

Throws:

Exception

beforePageRead

void beforePageRead()
                    throws Exception

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

Throws:

Exception

afterPageRead

void afterPageRead()
                   throws Exception

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

Throws:

Exception

allocateDirectBuffer

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. These methods will use that buffer if the inner method supports it

freeDirectBuffer

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. These methods will use that buffer if the inner method supports it

clearContext

void clearContext()

generateUniqueID

long generateUniqueID()

getCurrentUniqueID

long getCurrentUniqueID()

confirmPendingLargeMessageTX

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

Throws:

Exception

confirmPendingLargeMessage

void confirmPendingLargeMessage(long recordID)
                                throws Exception

Throws:

Exception

storeMessage

void storeMessage(ServerMessage message)
                  throws Exception

Throws:

Exception

storeReference

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

Throws:

Exception

deleteMessage

void deleteMessage(long messageID)
                   throws Exception

Throws:

Exception

storeAcknowledge

void storeAcknowledge(long queueID,
                    long messageID)
                      throws Exception

Throws:

Exception

storeCursorAcknowledge

void storeCursorAcknowledge(long queueID,
                          PagePosition position)
                            throws Exception

Throws:

Exception

updateDeliveryCount

void updateDeliveryCount(MessageReference ref)
                         throws Exception

Throws:

Exception

updateScheduledDeliveryTime

void updateScheduledDeliveryTime(MessageReference ref)
                                 throws Exception

Throws:

Exception

storeDuplicateID

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

Throws:

Exception

deleteDuplicateID

void deleteDuplicateID(long recordID)
                       throws Exception

Throws:

Exception

storeMessageTransactional

void storeMessageTransactional(long txID,
                             ServerMessage message)
                               throws Exception

Throws:

Exception

storeReferenceTransactional

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

Throws:

Exception

storeAcknowledgeTransactional

void storeAcknowledgeTransactional(long txID,
                                 long queueID,
                                 long messageID)
                                   throws Exception

Throws:

Exception

storeCursorAcknowledgeTransactional

void storeCursorAcknowledgeTransactional(long txID,
                                       long queueID,
                                       PagePosition position)
                                         throws Exception

Throws:

Exception

deleteCursorAcknowledgeTransactional

void deleteCursorAcknowledgeTransactional(long txID,
                                        long ackID)
                                          throws Exception

Throws:

Exception

updateScheduledDeliveryTimeTransactional

void updateScheduledDeliveryTimeTransactional(long txID,
                                            MessageReference ref)
                                              throws Exception

Throws:

Exception

storeDuplicateIDTransactional

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

Throws:

Exception

updateDuplicateIDTransactional

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

Throws:

Exception

deleteDuplicateIDTransactional

void deleteDuplicateIDTransactional(long txID,
                                  long recordID)
                                    throws Exception

Throws:

Exception

createLargeMessage

LargeServerMessage createLargeMessage()

createLargeMessage

LargeServerMessage createLargeMessage(long id,
                                    MessageInternal message)
                                      throws Exception

Parameters:

id -

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:

Throws:

Exception

prepare

void prepare(long txID,
           Xid xid)
             throws Exception

Throws:

Exception

commit

void commit(long txID)
            throws Exception

Throws:

Exception

commit

void commit(long txID,
          boolean lineUpContext)
            throws Exception

Throws:

Exception

rollback

void rollback(long txID)
              throws Exception

Throws:

Exception

rollbackBindings

void rollbackBindings(long txID)
                      throws Exception

Throws:

Exception

commitBindings

void commitBindings(long txID)
                    throws Exception

Throws:

Exception

storePageTransaction

void storePageTransaction(long txID,
                        PageTransactionInfo pageTransaction)
                          throws Exception

Throws:

Exception

updatePageTransaction

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

Throws:

Exception

updatePageTransaction

void updatePageTransaction(PageTransactionInfo pageTransaction,
                         int depage)
                           throws Exception

Throws:

Exception

deletePageTransactional

void deletePageTransactional(long recordID)
                             throws Exception

Throws:

Exception

loadInternalOnly

JournalLoadInformation[] loadInternalOnly()
                                          throws Exception

This method is only useful at the backup side. We only load internal structures making the journals ready for append mode on the backup side.

Throws:

Exception

loadMessageJournal

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

Throws:

Exception

storeHeuristicCompletion

long storeHeuristicCompletion(Xid xid,
                            boolean isCommit)
                              throws Exception

Throws:

Exception

deleteHeuristicCompletion

void deleteHeuristicCompletion(long id)
                               throws Exception

Throws:

Exception

addQueueBinding

void addQueueBinding(long tx,
                   Binding binding)
                     throws Exception

Throws:

Exception

deleteQueueBinding

void deleteQueueBinding(long queueBindingID)
                        throws Exception

Throws:

Exception

loadBindingJournal

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

Throws:

Exception

addGrouping

void addGrouping(GroupBinding groupBinding)
                 throws Exception

Throws:

Exception

deleteGrouping

void deleteGrouping(GroupBinding groupBinding)
                    throws Exception

Throws:

Exception

storeAddressSetting

void storeAddressSetting(PersistedAddressSetting addressSetting)
                         throws Exception

Throws:

Exception

deleteAddressSetting

void deleteAddressSetting(SimpleString addressMatch)
                          throws Exception

Throws:

Exception

recoverAddressSettings

List<PersistedAddressSetting> recoverAddressSettings()
                                                     throws Exception

Throws:

Exception

storeSecurityRoles

void storeSecurityRoles(PersistedRoles persistedRoles)
                        throws Exception

Throws:

Exception

deleteSecurityRoles

void deleteSecurityRoles(SimpleString addressMatch)
                         throws Exception

Throws:

Exception

recoverPersistedRoles

List<PersistedRoles> recoverPersistedRoles()
                                           throws Exception

Throws:

Exception

storePageCounter

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

Returns:

The ID with the stored counter

Throws:

Exception

deleteIncrementRecord

void deleteIncrementRecord(long txID,
                         long recordID)
                           throws Exception

Throws:

Exception

deletePageCounter

void deletePageCounter(long txID,
                     long recordID)
                       throws Exception

Throws:

Exception

storePageCounterInc

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

Returns:

the ID with the increment record

Throws:

Exception

storePageCounterInc

long storePageCounterInc(long queueID,
                       int add)
                         throws Exception

Returns:

the ID with the increment record

Throws:

Exception