PersistenceManager

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.mq.pm
Interface PersistenceManager

All Known Subinterfaces:: NewPersistenceManager (src)

All Known Implementing Classes:: NewPersistenceManager (src) , PersistenceManager (src) , PersistenceManager (src) , PersistenceManager (src)

public interface PersistenceManager

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

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

Method Detail

getMessageCacheInstance

public MessageCache (src)  getMessageCacheInstance()

Get the message cache

Returns:: the instance of the message cache

createPersistentTx

public Tx (src)  createPersistentTx()
                      throws JMSException (src)

Create and return a unique transaction id.

Returns:: the transaction
Throws:: JMSException (src) - for any error

commitPersistentTx

public void commitPersistentTx(Tx (src)  txId)
                        throws JMSException (src)

Commit the transaction to the persistent store.

Parameters:: txId - Description of Parameter
Throws:: JMSException (src) - for any error

rollbackPersistentTx

public void rollbackPersistentTx(Tx (src)  txId)
                          throws JMSException (src)

Rollback the transaction.

Parameters:: txId - Description of Parameter
Throws:: JMSException (src) - for any error

getTxManager

public TxManager (src)  getTxManager()

Get a transaction manager.

Returns:: the transaction manager
Throws:: JMSException (src) - for any error

add

public void add(MessageReference (src)  message,
                Tx (src)  txId)
         throws JMSException (src)

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:: JMSException (src) - for any error

restoreQueue

public void restoreQueue(JMSDestination (src)  jmsDest,
                         SpyDestination (src)  dest)
                  throws JMSException (src)

Restore a queue.

Parameters:: jmsDest - the jms destination; dest - the client destination
Throws:: JMSException (src) - for any error

update

public void update(MessageReference (src)  message,
                   Tx (src)  txId)
            throws JMSException (src)

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:: JMSException (src) - for any error

remove

public void remove(MessageReference (src)  message,
                   Tx (src)  txId)
            throws JMSException (src)

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:: JMSException (src) - for any error

closeQueue

public void closeQueue(JMSDestination (src)  jmsDest,
                       SpyDestination (src)  dest)
                throws JMSException (src)

Close a queue

Parameters:: jmsDest - the jms destination; dest - the client destination
Throws:: JMSException (src) - for any error