Package org.synchronoss.cpo.core.jta

Class CpoBaseXaResource<T>

java.lang.Object
org.synchronoss.cpo.core.jta.CpoBaseXaResource<T>
Type Parameters:
T - the type of the underlying local resource each transaction branch is associated with
All Implemented Interfaces:
XAResource, CpoXaResource
public abstract class CpoBaseXaResource<T> extends Object implements CpoXaResource
Base CpoXaResource implementation that tracks per-Xid state for a family of XA resources and drives the JTA two-phase-commit protocol against a subclass-supplied local resource of type T (e.g. a JDBC Connection).

Each concrete subclass (e.g. a JDBC or Cassandra XA resource) shares one XID-state map per subclass, keyed by Class.getName(), because every XAResource instance representing the same kind of resource must see the same in-flight transaction branches. Subclasses supply the resource-lifecycle primitives (createNewResource(), prepareResource(T), commitResource(T), rollbackResource(T), closeResource(T)); this class implements the XAResource state machine (start/end/prepare/commit/rollback/recover) on top of them.

Author:
dberry

  • 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
    Description
    CpoBaseXaResource(T localResource)
    Constructs a resource manager backed by the given local (non-XA) resource, used whenever no transaction branch is currently associated with this instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(Consumer<T> consumer)
    Applies consumer to the resource currently associated with this instance (the transaction branch's resource if one is associated, otherwise the local resource), serialized against concurrent calls on this instance.
    <R> R
    apply(Function<T,R> function)
    Applies function to the resource currently associated with this instance (the transaction branch's resource if one is associated, otherwise the local resource), serialized against concurrent calls on this instance.
    void
    close(Xid xid)
    Closes the resource for the specified xid
    void
    closeAssociated()
    Closes the resource associated with this instance
    void
    commit(Xid xid, boolean onePhase)
    Commits the global transaction specified by xid.
    void
    end(Xid xid, int flags)
    Ends the work performed on behalf of a transaction branch.
    void
    forget(Xid xid)
    Tells the resource manager to forget about a heuristically completed transaction branch.
    int
    getTransactionTimeout()
    Obtains the current transaction timeout value set for this XAResource instance.
    int
    prepare(Xid xid)
    Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
    Xid[]
    recover(int flags)
    Obtains a list of prepared transaction branches from a resource manager.
    void
    rollback(Xid xid)
    Informs the resource manager to roll back work done on behalf of a transaction branch.
    boolean
    setTransactionTimeout(int seconds)
    Sets the current transaction timeout value for this XAResource instance.
    void
    start(Xid xid, int flags)
    Starts work on behalf of a transaction branch specified in xid.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javax.transaction.xa.XAResource

    isSameRM

  • Constructor Details

    • CpoBaseXaResource

      public CpoBaseXaResource(T localResource)
      Constructs a resource manager backed by the given local (non-XA) resource, used whenever no transaction branch is currently associated with this instance.
      Parameters:
      localResource - the resource to use outside of an XA transaction branch; must not be null

  • Method Details

    • apply

      public <R> R apply(Function<T,R> function) throws CpoException
      Applies function to the resource currently associated with this instance (the transaction branch's resource if one is associated, otherwise the local resource), serialized against concurrent calls on this instance.
      Type Parameters:
      R - the type returned by function
      Parameters:
      function - the operation to run against the current resource
      Returns:
      the value returned by function
      Throws:
      CpoException - if function threw a CpoException, unwrapped from its RuntimeException wrapper

    • accept

      public void accept(Consumer<T> consumer) throws CpoException
      Applies consumer to the resource currently associated with this instance (the transaction branch's resource if one is associated, otherwise the local resource), serialized against concurrent calls on this instance.
      Parameters:
      consumer - the operation to run against the current resource
      Throws:
      CpoException - if consumer threw a CpoException, unwrapped from its RuntimeException wrapper

    • closeAssociated

      public void closeAssociated() throws XAException
      Closes the resource associated with this instance
      Throws:
      XAException - -

    • close

      public void close(Xid xid) throws XAException
      Closes the resource for the specified xid
      Specified by:
      close in interface CpoXaResource
      Parameters:
      xid - of the global transaction
      Throws:
      XAException - An error has occurred.

    • commit

      public void commit(Xid xid, boolean onePhase) throws XAException
      Commits the global transaction specified by xid.
      Specified by:
      commit in interface XAResource
      Parameters:
      xid - A global transaction identifier
      onePhase - If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.
      Throws:
      XAException - An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

      If the resource manager did not commit the transaction and the parameter onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

    • end

      public void end(Xid xid, int flags) throws XAException
      Ends the work performed on behalf of a transaction branch. The resource manager disassociates the XA resource from the transaction branch specified and lets the transaction complete.

      If TMSUSPEND is specified in the flags, the transaction branch is temporarily suspended in an incomplete state. The transaction context is in a suspended state and must be resumed via the start method with TMRESUME specified.

      If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as rollback-only

      If TMSUCCESS is specified, the portion of work has completed successfully.

      Specified by:
      end in interface XAResource
      Parameters:
      xid - A global transaction identifier that is the same as the identifier used previously in the start method.
      flags - One of TMSUCCESS, TMFAIL, or TMSUSPEND.
      Throws:
      XAException - An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.

    • forget

      public void forget(Xid xid) throws XAException
      Tells the resource manager to forget about a heuristically completed transaction branch.
      Specified by:
      forget in interface XAResource
      Parameters:
      xid - A global transaction identifier.
      Throws:
      XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

    • getTransactionTimeout

      public int getTransactionTimeout() throws XAException
      Obtains the current transaction timeout value set for this XAResource instance. If XAResource.setTransactionTimeout was not used prior to invoking this method, the return value is the default timeout set for the resource manager; otherwise, the value used in the previous setTransactionTimeout call is returned.
      Specified by:
      getTransactionTimeout in interface XAResource
      Returns:
      the transaction timeout value in seconds.
      Throws:
      XAException - An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

    • prepare

      public int prepare(Xid xid) throws XAException
      Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
      Specified by:
      prepare in interface XAResource
      Parameters:
      xid - A global transaction identifier.
      Returns:
      - A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method.
      Throws:
      XAException - - An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

    • recover

      public Xid[] recover(int flags) throws XAException
      Obtains a list of prepared transaction branches from a resource manager. The transaction manager calls this method during recovery to obtain the list of transaction branches that are currently in prepared or heuristically completed states.
      Specified by:
      recover in interface XAResource
      Parameters:
      flags - - One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter.
      Returns:
      - The resource manager returns zero or more XIDs of the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should throw the appropriate XAException.
      Throws:
      XAException - - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

    • rollback

      public void rollback(Xid xid) throws XAException
      Informs the resource manager to roll back work done on behalf of a transaction branch.
      Specified by:
      rollback in interface XAResource
      Parameters:
      xid - - A global transaction identifier.
      Throws:
      XAException - - An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

      If the transaction branch is already marked rollback-only the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

    • setTransactionTimeout

      public boolean setTransactionTimeout(int seconds) throws XAException
      Sets the current transaction timeout value for this XAResource instance. Once set, this timeout value is effective until setTransactionTimeout is invoked again with a different value. To reset the timeout value to the default value used by the resource manager, set the value to zero. If the timeout operation is performed successfully, the method returns true; otherwise false. If a resource manager does not support explicitly setting the transaction timeout value, this method returns false.
      Specified by:
      setTransactionTimeout in interface XAResource
      Parameters:
      seconds - - The transaction timeout value in seconds.
      Returns:
      - true if the transaction timeout value is set successfully; otherwise false.
      Throws:
      XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

    • start

      public void start(Xid xid, int flags) throws XAException
      Starts work on behalf of a transaction branch specified in xid. If TMJOIN is specified, the start applies to joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start applies to resuming a suspended transaction specified in the parameter xid. If neither TMJOIN nor TMRESUME is specified and the transaction specified by xid has previously been seen by the resource manager, the resource manager throws the XAException exception with XAER_DUPID error code.
      Specified by:
      start in interface XAResource
      Parameters:
      xid - - A global transaction identifier to be associated with the resource.
      flags - - One of TMNOFLAGS, TMJOIN, or TMRESUME.
      Throws:
      XAException - - An error has occurred. Possible exceptions are XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA, XAER_INVAL, or XAER_PROTO.