org.hornetq.jms.server.recovery

Class HornetQXAResourceWrapper

java.lang.Object

org.hornetq.jms.server.recovery.HornetQXAResourceWrapper

All Implemented Interfaces:

XAResource, SessionFailureListener, FailureListener

public class HornetQXAResourceWrapper
extends Object
implements XAResource, SessionFailureListener

XAResourceWrapper. Mainly from org.jboss.server.XAResourceWrapper from the JBoss AS server module The reason why we don't use that class directly is that it assumes on failure of connection the RM_FAIL or RM_ERR is thrown, but in HornetQ we throw XA_RETRY since we want the recovery manager to be able to retry on failure without having to manually retry

Version:

$Revision: 45341 $

Author:

Adrian Brock, Tim Fox/a>, Jeff Mesnil, Andy Taylor

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
HornetQXAResourceWrapper(XARecoveryConfig... xaRecoveryConfigs)

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeReconnect(HornetQException me) Notifies that a connection has failed due to the specified exception.
protected XAException	check(XAException e) Check whether an XAException is fatal.
void	close() Close the connection
void	commit(Xid xid, boolean onePhase) Commit the work done on this resource in the given transaction.
protected XAResource	connect() Connect to the server if not already done so
void	connectionFailed(HornetQException me, boolean failedOver) Notifies that a connection has failed due to the specified exception.
void	end(Xid xid, int flags) Called to disassociate the resource from a transaction.
protected void	finalize()
void	forget(Xid xid) Tells the resource manager to forget about a heuristic decision.
int	getTransactionTimeout() Get the current transaction timeout value for this resource.
boolean	isSameRM(XAResource xaRes) Tells the caller if this resource has the same resource manager as the argument resource.
int	prepare(Xid xid) Prepare to commit the work done on this resource in the given transaction.
Xid[]	recover(int flag) Return a list of transactions that are in a prepared or heuristically state.
void	rollback(Xid xid) Roll back the work done on this resource in the given transaction.
boolean	setTransactionTimeout(int seconds) Set the transaction timeout value for this resource.
void	start(Xid xid, int flags) Called to associate the resource with a transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HornetQXAResourceWrapper

public HornetQXAResourceWrapper(XARecoveryConfig... xaRecoveryConfigs)

Method Detail

recover

public Xid[] recover(int flag)
              throws XAException

Description copied from interface: XAResource

Return a list of transactions that are in a prepared or heuristically state. This method looks not only at the resource it is invoked on, but also on all other resources managed by the same resource manager. It is intended to be used by the application server when recovering after a server crash.

A recovery scan is done with one or more calls to this method. At the first call, XAResource.TMSTARTRSCAN must be in the flag argument to indicate that the scan should be started. During the recovery scan, the resource manager maintains an internal cursor that keeps track of the progress of the recovery scan. To end the recovery scan, the XAResource.TMENDRSCAN must be passed in the flag argument.

Specified by:

recover in interface XAResource

Parameters:

flag - Must be either XAResource.TMNOFLAGS, XAResource.TMSTARTRSCAN, XAResource.TMENDRSCAN or TMSTARTRSCAN|TMENDRSCAN.

Returns:

An array of zero or more transaction ids.

Throws:

XAException - If an error occurred.

commit

public void commit(Xid xid,
          boolean onePhase)
            throws XAException

Description copied from interface: XAResource

Commit the work done on this resource in the given transaction. If the onePhase argument is true, one-phase optimization is being used, and the prepare method must not have been called for this transaction. Otherwise, this is the second phase of the two-phase commit protocol.

Specified by:

commit in interface XAResource

Parameters:

xid - The id of the transaction to commit work for.

onePhase - If true, the transaction manager is using one-phase optimization.

Throws:

XAException - If an error occurred.

rollback

public void rollback(Xid xid)
              throws XAException

Description copied from interface: XAResource

Roll back the work done on this resource in the given transaction.

Specified by:

rollback in interface XAResource

Parameters:

xid - The id of the transaction to commit work for.

Throws:

XAException - If an error occurred.

forget

public void forget(Xid xid)
            throws XAException

Description copied from interface: XAResource

Tells the resource manager to forget about a heuristic decision.

Specified by:

forget in interface XAResource

Parameters:

xid - The id of the transaction that was ended with a heuristic decision.

Throws:

XAException - If an error occurred.

isSameRM

public boolean isSameRM(XAResource xaRes)
                 throws XAException

Description copied from interface: XAResource

Tells the caller if this resource has the same resource manager as the argument resource. The transaction manager needs this method to be able to decide if the start method should be given the XAResource.TMJOIN flag.

Specified by:

isSameRM in interface XAResource

Throws:

XAException - If an error occurred.

prepare

public int prepare(Xid xid)
            throws XAException

Description copied from interface: XAResource

Prepare to commit the work done on this resource in the given transaction. This method cannot return a status indicating that the transaction should be rolled back. If the resource wants the transaction to be rolled back, it should throw an XAException at the caller.

Specified by:

prepare in interface XAResource

Parameters:

xid - The id of the transaction to prepare to commit work for.

Returns:

Either XAResource.XA_OK or XAResource.XA_RDONLY.

Throws:

XAException - If an error occurred.

start

public void start(Xid xid,
         int flags)
           throws XAException

Description copied from interface: XAResource

Called to associate the resource with a transaction. If the flags argument is XAResource.TMNOFLAGS, the transaction must not previously have been seen by this resource manager, or an XAException with error code XAER_DUPID will be thrown. If the flags argument is XAResource.TMJOIN, the resource will join a transaction previously seen by tis resource manager. If the flags argument is XAResource.TMRESUME the resource will resume the transaction association that was suspended with end(TMSUSPEND).

Specified by:

start in interface XAResource

Parameters:

xid - The id of the transaction to associate with.

flags - Must be either XAResource.TMNOFLAGS, XAResource.TMJOIN or XAResource.TMRESUME.

Throws:

XAException - If an error occurred.

end

public void end(Xid xid,
       int flags)
         throws XAException

Description copied from interface: XAResource

Called to disassociate the resource from a transaction. If the flags argument is XAResource.TMSUCCESS, the portion of work was done sucessfully. If the flags argument is XAResource.TMFAIL, the portion of work failed. The resource manager may mark the transaction for rollback only to avoid the transaction being committed. If the flags argument is XAResource.TMSUSPEND the resource will temporarily suspend the transaction association. The transaction must later be re-associated by giving the XAResource.TMRESUME flag to the start method.

Specified by:

end in interface XAResource

Parameters:

xid - The id of the transaction to disassociate from.

flags - Must be either XAResource.TMSUCCESS, XAResource.TMFAIL or XAResource.TMSUSPEND.

Throws:

XAException - If an error occurred.

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Description copied from interface: XAResource

Get the current transaction timeout value for this resource.

Specified by:

getTransactionTimeout in interface XAResource

Returns:

The current timeout value, in seconds.

Throws:

XAException - If an error occurred.

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Description copied from interface: XAResource

Set the transaction timeout value for this resource. If the seconds argument is 0, the timeout value is set to the default timeout value of the resource manager. Not all resource managers support setting the timeout value. If the resource manager does not support setting the timeout value, it should return false.

Specified by:

setTransactionTimeout in interface XAResource

Parameters:

seconds - The timeout value, in seconds.

Returns:

True if the timeout value could be set, otherwise false.

Throws:

XAException - If an error occurred.

connectionFailed

public void connectionFailed(HornetQException me,
                    boolean failedOver)

Description copied from interface: FailureListener

Notifies that a connection has failed due to the specified exception.

Specified by:

connectionFailed in interface FailureListener

Parameters:

me - exception which has caused the connection to fail

beforeReconnect

public void beforeReconnect(HornetQException me)

Description copied from interface: SessionFailureListener

Notifies that a connection has failed due to the specified exception.
This method is called before the session attempts to reconnect/failover.

Specified by:

beforeReconnect in interface SessionFailureListener

Parameters:

me - exception which has caused the connection to fail

connect

protected XAResource connect()
                      throws Exception

Connect to the server if not already done so

Returns:

the connectionFactory XAResource

Throws:

Exception - for any problem

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Close the connection

check

protected XAException check(XAException e)
                     throws XAException

Check whether an XAException is fatal. If it is an RM problem we close the connection so the next call will reconnect.

Parameters:

e - the xa exception

Returns:

never

Throws:

XAException - always

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable