org.jboss.mq.pm
Interface PersistenceManager

All Known Subinterfaces:

NewPersistenceManager

All Known Implementing Classes:

NewPersistenceManager, PersistenceManager, PersistenceManager, PersistenceManager

public interface PersistenceManager

This class allows provides the base for user supplied persistence packages.

Version:

$Revision: 1.12 $

Author:

Hiram Chirino (Cojonudo14@hotmail.com), Paul Kendall (paul.kendall@orion.co.nz), Adrian Brock

Method Summary

void	add(MessageReference message, Tx txId) Add a message to the persistent store.
void	closeQueue(JMSDestination jmsDest, SpyDestination dest) Close a queue
void	commitPersistentTx(Tx txId) Commit the transaction to the persistent store.
Tx	createPersistentTx() Create and return a unique transaction id.
MessageCache	getMessageCacheInstance() Get the message cache
TxManager	getTxManager() Get a transaction manager.
void	remove(MessageReference message, Tx txId) Remove message from the persistent store.
void	restoreQueue(JMSDestination jmsDest, SpyDestination dest) Restore a queue.
void	rollbackPersistentTx(Tx txId) Rollback the transaction.
void	update(MessageReference message, Tx txId) Update message in the persistent store.

Method Detail

getMessageCacheInstance

MessageCache getMessageCacheInstance()

Get the message cache

Returns:

the instance of the message cache

createPersistentTx

Tx createPersistentTx()
                      throws javax.jms.JMSException

Create and return a unique transaction id.

Returns:

the transaction

Throws:

javax.jms.JMSException - for any error

commitPersistentTx

void commitPersistentTx(Tx txId)
                        throws javax.jms.JMSException

Commit the transaction to the persistent store.

Parameters:

txId - Description of Parameter

Throws:

javax.jms.JMSException - for any error

rollbackPersistentTx

void rollbackPersistentTx(Tx txId)
                          throws javax.jms.JMSException

Rollback the transaction.

Parameters:

txId - Description of Parameter

Throws:

javax.jms.JMSException - for any error

getTxManager

TxManager getTxManager()

Get a transaction manager.

Returns:

the transaction manager

Throws:

javax.jms.JMSException - for any error

add

void add(MessageReference message,
         Tx txId)
         throws javax.jms.JMSException

Add a message to the persistent store. If the message is part of a transaction, txId is not null.

Parameters:

message - the message

txId - the transaction

Throws:

javax.jms.JMSException - for any error

restoreQueue

void restoreQueue(JMSDestination jmsDest,
                  SpyDestination dest)
                  throws javax.jms.JMSException

Restore a queue.

Parameters:

jmsDest - the jms destination

dest - the client destination

Throws:

javax.jms.JMSException - for any error

update

void update(MessageReference message,
            Tx txId)
            throws javax.jms.JMSException

Update message in the persistent store. If the message is part of a transaction, txId is not null (not currently supported).

Parameters:

message -

txId - Description of Parameter

Throws:

javax.jms.JMSException - for any error

remove

void remove(MessageReference message,
            Tx txId)
            throws javax.jms.JMSException

Remove message from the persistent store. If the message is part of a transaction, txId is not null.

Parameters:

message - the message

txId - the transaction

Throws:

javax.jms.JMSException - for any error

closeQueue

void closeQueue(JMSDestination jmsDest,
                SpyDestination dest)
                throws javax.jms.JMSException

Close a queue

Parameters:

jmsDest - the jms destination

dest - the client destination

Throws:

javax.jms.JMSException - for any error