Package oracle.jdbc.xa

Class OracleXAResource

  • All Implemented Interfaces:
    java.beans.PropertyChangeListener, java.util.EventListener, javax.transaction.xa.XAResource, oracle.jdbc.diagnostics.Diagnosable, oracle.jdbc.internal.Monitor
    Direct Known Subclasses:
    OracleXAResource
    public abstract class OracleXAResource
extends java.lang.Object
implements javax.transaction.xa.XAResource, oracle.jdbc.internal.Monitor, oracle.jdbc.diagnostics.Diagnosable
    An Oracle XA Resource.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface oracle.jdbc.internal.Monitor

        oracle.jdbc.internal.Monitor.CloseableLock, oracle.jdbc.internal.Monitor.WaitableMonitor

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void allowGlobalTxnModeOnly​(int errorCode)  
      protected void checkError​(int error)  
      protected void checkError​(int error, int defaultXAError)  
      protected void checkError​(int error, java.sql.SQLException sqlException)  
      abstract void commit​(javax.transaction.xa.Xid xid, boolean onePhase)
      commit() -- Commit work done by global transaction specified by xid.
      protected javax.transaction.xa.XAException convertError​(java.sql.SQLException sqlex, int defaultXAError)
      Convert a SQLException into an XAException.
      protected void createOrUpdateXid​(javax.transaction.xa.Xid xid, boolean isSuspended, boolean[] isLocallySuspended)
      createOrUpdateXid () - Pushes the current xid.
      abstract void end​(javax.transaction.xa.Xid xid, int flag)
      end()-- End work performed on behalf of a transaction branch.
      protected void enterGlobalTxnMode()  
      protected void exitGlobalTxnMode()  
      abstract void forget​(javax.transaction.xa.Xid xid)
      forget() -- Tell RM to forget about a heuristically completed txn branch
      protected oracle.jdbc.internal.OracleConnection getConnectionDuringExceptionHandling()  
      oracle.jdbc.diagnostics.Diagnosable getDiagnosable()  
      oracle.jdbc.internal.Monitor.CloseableLock getMonitorLock()  
      protected oracle.jdbc.internal.OracleConnection getPhysicalConnection()
      Returns the physical connection that this OracleXAResource object should use.
      int getTransactionTimeout()
      Obtain the current transaction timeout value set for this XAResource instance.
      protected boolean isOnStack​(javax.transaction.xa.Xid xid)  
      boolean isSameRM​(javax.transaction.xa.XAResource xares)
      This method is called to determine if the resource manager instance represented by the target object is the same as the resource manager instance represented by the parameter xares.
      protected boolean isXidListEmpty()  
      protected boolean isXidSuspended​(javax.transaction.xa.Xid xid)
      isXidSuspended(Xid) - Checks if the passed Xid is suspended or not.
      abstract int prepare​(javax.transaction.xa.Xid xid)
      prepare() -- Ask RM to prepare for a commit of the txn specified in xid.
      javax.transaction.xa.Xid[] recover​(int flag)
      Obtain a list of prepared transaction branches from a resource manager.
      protected boolean removeXidFromList​(javax.transaction.xa.Xid xid)  
      protected void restoreAutoCommitModeForGlobalTransaction()
      Restore the auto-commit status of the Connection & the PooledConnection.
      protected void resumeStacked​(javax.transaction.xa.Xid xid)
      resumeStacked() - Resumes the current transaction after the possible suspension of the stacked transaction, if any.
      abstract void rollback​(javax.transaction.xa.Xid xid)
      rollback() -- Ask RM to roll back work done on behalf of a txn branch.
      protected void saveAndAlterAutoCommitModeForGlobalTransaction()
      Save the auto-commit status of the Connection & the PooledConnection.
      boolean setTransactionTimeout​(int seconds)
      Set the current transaction timeout value for this XAResource instance.
      abstract void start​(javax.transaction.xa.Xid xid, int flag)
      start() -- Starts work on behalf of a transaction branch.
      protected javax.transaction.xa.Xid suspendStacked​(javax.transaction.xa.Xid xid)
      suspendStacked() - Suspends the stacked transaction, if any.
      protected boolean updateXidList​(javax.transaction.xa.Xid xid, boolean[] flags)
      updateXidList() - Update the Xid status in the list

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface oracle.jdbc.diagnostics.Diagnosable

        begin, begin, beginCurrentSql, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debugp, end, end, endCurrentSql, format, isDebugEnabled, isDiagnoseFirstFailureEnabled, isLoggable, isSensitiveEnabled, onClose, propertyChange, resumeLogging, secure, suspendLogging, trace, tracep

      • Methods inherited from interface oracle.jdbc.internal.Monitor

        acquireCloseableLock, acquireLock, releaseLock

    • Constructor Detail

      • OracleXAResource

        public OracleXAResource()

      • OracleXAResource

        public OracleXAResource​(java.sql.Connection pm_conn,
                        OracleXAConnection xaconn)
                 throws javax.transaction.xa.XAException
        OracleXAResource() -- The initializer.
        Throws:
        javax.transaction.xa.XAException - throws an exception if the connection object is null.

    • Method Detail

      • getPhysicalConnection

        protected final oracle.jdbc.internal.OracleConnection getPhysicalConnection()
                                                                     throws javax.transaction.xa.XAException
        Returns the physical connection that this OracleXAResource object should use. If the physical connection is proxied by a replayable connection, the replay function will be disabled.
        Throws:
        javax.transaction.xa.XAException

      • removeXidFromList

        protected final boolean removeXidFromList​(javax.transaction.xa.Xid xid)

      • isOnStack

        protected final boolean isOnStack​(javax.transaction.xa.Xid xid)
                           throws javax.transaction.xa.XAException
        Throws:
        javax.transaction.xa.XAException

      • isXidListEmpty

        protected final boolean isXidListEmpty()

      • createOrUpdateXid

        protected void createOrUpdateXid​(javax.transaction.xa.Xid xid,
                                 boolean isSuspended,
                                 boolean[] isLocallySuspended)
        createOrUpdateXid () - Pushes the current xid. This should be called from start.
        Parameters:
        xid - Xid to save.

      • updateXidList

        protected boolean updateXidList​(javax.transaction.xa.Xid xid,
                                boolean[] flags)
        updateXidList() - Update the Xid status in the list
        Returns:
        true - if the xid is found the xidlist false - if the xid is not found the xidlist

      • isXidSuspended

        protected boolean isXidSuspended​(javax.transaction.xa.Xid xid)
                          throws javax.transaction.xa.XAException
        isXidSuspended(Xid) - Checks if the passed Xid is suspended or not.
        Throws:
        javax.transaction.xa.XAException - if the suspend operation fails.

      • suspendStacked

        protected javax.transaction.xa.Xid suspendStacked​(javax.transaction.xa.Xid xid)
                                           throws javax.transaction.xa.XAException
        suspendStacked() - Suspends the stacked transaction, if any. This version should be called at the beginning of commit, rollback, and prepare.
        Parameters:
        xid - Xid of current transaction. If this is different from the stacked Xid, the stacked Xid will be suspended, clearing the way for the current operation.
        Returns:
        null if there was no stacked Xid, otherwise the Xid which was stacked.
        Throws:
        javax.transaction.xa.XAException - if the suspend operation fails.

      • resumeStacked

        protected void resumeStacked​(javax.transaction.xa.Xid xid)
                      throws javax.transaction.xa.XAException
        resumeStacked() - Resumes the current transaction after the possible suspension of the stacked transaction, if any. This should be called from the end of commit, rollback, prepare, and end.
        Parameters:
        xid - Xid of stacked transaction. If null, then this is a no-op.
        Throws:
        javax.transaction.xa.XAException - if the resume operation fails.

      • start

        public abstract void start​(javax.transaction.xa.Xid xid,
                           int flag)
                    throws javax.transaction.xa.XAException
        start() -- Starts work on behalf of a transaction branch. If TMJOIN is specified, the start is for joining an existing txn branch xid. If TMRESUME is specified, the start is to resume a suspended transaction branch specified in xid. Transaction suspend is done by calling the end method specifying the TMSUSPEND flag. If neither TMJOIN nor TMRESUME is specified and the transaction branch specified in xid already exists, the resource manager raises the duplicate transaction exception via XAER_DUPID.
        Specified by:
        start in interface javax.transaction.xa.XAResource
        Parameters:
        xid - A global transaction identifier.
        Throws:
        javax.transaction.xa.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.

      • end

        public abstract void end​(javax.transaction.xa.Xid xid,
                         int flag)
                  throws javax.transaction.xa.XAException
        end()-- End work performed on behalf of a transaction branch. The resource manager dissociates the XA resource from the transaction branch specified and let the transaction be completed. If TMSUSPEND is specified in flag, the txn branch is temporarily suspended in incomplete state. The txn context is in suspended state and must be resumed via start with TMRESUME specified. If TMFAIL is specified, the portion of work has failed. The RM may mark the transaction as rollback-only. If TMSUCCESS is specified, the portion of work has completed successfully.
        Specified by:
        end in interface javax.transaction.xa.XAResource
        Parameters:
        xid - A global transaction identifier that is the same as what was used previously in the start method.
        flag - One of TMSUCCESS, TMFAIL, or TMSUSPEND.
        Throws:
        javax.transaction.xa.XAException - An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB.

      • commit

        public abstract void commit​(javax.transaction.xa.Xid xid,
                            boolean onePhase)
                     throws javax.transaction.xa.XAException
        commit() -- Commit work done by global transaction specified by xid.
        Specified by:
        commit in interface javax.transaction.xa.XAResource
        Parameters:
        xid - A global transaction identifier.
        onePhase - If true, the RM should use a 1-phase commit protocol to commit the work done on behalf of xid.
        Throws:
        javax.transaction.xa.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 txn and the parameter onePhase is set to true, the RM may raise one of the XA_RB exceptions. Upon return, the RM has rolled back the branch's work and has released all held resources.

      • prepare

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

      • forget

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

      • rollback

        public abstract void rollback​(javax.transaction.xa.Xid xid)
                       throws javax.transaction.xa.XAException
        rollback() -- Ask RM to roll back work done on behalf of a txn branch.
        Specified by:
        rollback in interface javax.transaction.xa.XAResource
        Parameters:
        xid - A global transaction identifier.
        Throws:
        javax.transaction.xa.XAException - An error has occurred.

      • recover

        public javax.transaction.xa.Xid[] recover​(int flag)
                                   throws javax.transaction.xa.XAException
        Obtain 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. JDBC has been returning a complete list of prepared transaction branches when recover(flag) is called regardless which flag (TMNOFLAGS or TMSTARTRSCAN or TMENDRSCAN) is set. Beginning in 11.2.0.2, JDBC will do the following in order to accommodate certain TMs way of handling the recovery scan:
        • If recover(TMSTARTRSCAN) is called, continues to return a complete list of prepared transaction branches.
        • If recover(TMNOFLAGS) is called after a TMSTARTSCAN, returns an empty list until the scan is ended. Otherwise, continues to return a complete list of prepared transaction branches.
        • If recover(TMENDRSCAN) is called after a TMSTARTSCAN, ends the scan and returns an empty list. Otherwise, continues to return a complete list of prepared transaction branches until TMSTARTRSCAN is called again.

        Example 1:

              MyXid[] xids = 
         xaRes.recover(XAResource.TMSTARTRSCAN | XAResource.TMENDRSCAN);
      for (int i=0; xids != null && i < xids.length; i++) {
      try {
         xaRes.rollback(xids[i]);
      ...

        Example 2:

              MyXid[] xids = xaRes.recover(XAResource.TMSTARTRSCAN);
      while( xids!=null && xids.length>0)
      {
         for (int i=0; i < xids.length; i++) {
         try {
            xaRes.rollback(xids[i]);
            ...
            xids = xaRes.recover(XAResource.TMNOFLAG);
      }
      xaRes.recover(XAResource.TMENDRSCAN);

        Example 3:

              MyXid[] xids = xaRes.recover(XAResource.TMNOFLAG);
      for (int i=0; xids != null && i < xids.length; i++) {
      try {
         xaRes.rollback(xids[i]);
      ...
        Specified by:
        recover in interface javax.transaction.xa.XAResource
        Parameters:
        flag - One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in flags.
        Returns:
        The resource manager returns zero or more XIDs for the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should raise the appropriate XAException.
        Throws:
        javax.transaction.xa.XAException - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

      • restoreAutoCommitModeForGlobalTransaction

        protected void restoreAutoCommitModeForGlobalTransaction()
                                                  throws javax.transaction.xa.XAException
        Restore the auto-commit status of the Connection & the PooledConnection. Typically, invoked after the end of a global transaction.
        Throws:
        javax.transaction.xa.XAException

      • saveAndAlterAutoCommitModeForGlobalTransaction

        protected void saveAndAlterAutoCommitModeForGlobalTransaction()
                                                       throws javax.transaction.xa.XAException
        Save the auto-commit status of the Connection & the PooledConnection. Typically, invoked just before starting the transaction.
        Throws:
        java.sql.SQLException
        javax.transaction.xa.XAException

      • getTransactionTimeout

        public int getTransactionTimeout()
                          throws javax.transaction.xa.XAException
        Obtain the current transaction timeout value set for this XAResource instance. If XAResource.setTransactionTimeout was not use prior to invoking this method, the return value is the default timeout set fo the resource manager; otherwise, the value used in the previous setTransactionTimeout call is returned.

        Specified by:
        getTransactionTimeout in interface javax.transaction.xa.XAResource
        Returns:
        the transaction timeout value in seconds.
        Throws:
        javax.transaction.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

      • isSameRM

        public boolean isSameRM​(javax.transaction.xa.XAResource xares)
                 throws javax.transaction.xa.XAException
        This method is called to determine if the resource manager instance represented by the target object is the same as the resource manager instance represented by the parameter xares.
        Specified by:
        isSameRM in interface javax.transaction.xa.XAResource
        Parameters:
        xares - - An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object.
        Returns:
        true if it's the same RM instance; otherwise false.
        Throws:
        javax.transaction.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

      • setTransactionTimeout

        public boolean setTransactionTimeout​(int seconds)
                              throws javax.transaction.xa.XAException
        Set 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 transaction timeout value to be set explicitly, this method returns false.

        Specified by:
        setTransactionTimeout in interface javax.transaction.xa.XAResource
        Parameters:
        seconds - - transaction timeout value in seconds.
        Returns:
        true if transaction timeout value is set successfully; otherwise false.
        Throws:
        javax.transaction.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

      • allowGlobalTxnModeOnly

        protected void allowGlobalTxnModeOnly​(int errorCode)
                               throws javax.transaction.xa.XAException
        Throws:
        javax.transaction.xa.XAException

      • exitGlobalTxnMode

        protected void exitGlobalTxnMode()

      • enterGlobalTxnMode

        protected void enterGlobalTxnMode()

      • checkError

        protected void checkError​(int error)
                   throws javax.transaction.xa.XAException
        Throws:
        javax.transaction.xa.XAException

      • checkError

        protected void checkError​(int error,
                          java.sql.SQLException sqlException)
                   throws javax.transaction.xa.XAException
        Throws:
        javax.transaction.xa.XAException

      • checkError

        protected void checkError​(int error,
                          int defaultXAError)
                   throws javax.transaction.xa.XAException
        Throws:
        javax.transaction.xa.XAException

      • convertError

        protected javax.transaction.xa.XAException convertError​(java.sql.SQLException sqlex,
                                                        int defaultXAError)
        Convert a SQLException into an XAException.
        Returns:
        An XAException with the SQLException as it's cause.

      • getConnectionDuringExceptionHandling

        protected oracle.jdbc.internal.OracleConnection getConnectionDuringExceptionHandling()

      • getMonitorLock

        public final oracle.jdbc.internal.Monitor.CloseableLock getMonitorLock()
        Specified by:
        getMonitorLock in interface oracle.jdbc.internal.Monitor

      • getDiagnosable

        public oracle.jdbc.diagnostics.Diagnosable getDiagnosable()
        Specified by:
        getDiagnosable in interface oracle.jdbc.diagnostics.Diagnosable