Class EmbedXAResource

java.lang.Object
org.apache.derby.jdbc.EmbedXAResource
All Implemented Interfaces:
XAResource

class EmbedXAResource extends Object implements XAResource
Implements XAResource
  • Field Details

  • Constructor Details

  • Method Details

    • commit

      public final void commit(Xid xid, boolean onePhase) throws XAException
      Commit 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 paramether 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 final 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 let the transaction be completed.

      If TMSUSPEND is specified in flags, the transaction branch is temporarily suspended in incomplete state. The transaction context is in suspened state and must be resumed via start 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 what was 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_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.
    • prepare

      public final 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.
    • getTransactionTimeout

      public int getTransactionTimeout()
      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 0; otherwise, the value used in the previous setTransactionTimeout call is returned.
      Specified by:
      getTransactionTimeout in interface XAResource
      Returns:
      the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout.
    • isSameRM

      public final boolean isSameRM(XAResource xares) throws XAException
      This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares.
      Specified by:
      isSameRM in interface 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:
      XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.
    • recover

      public final Xid[] recover(int flag) throws 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.
      Specified by:
      recover in interface 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 throw the appropriate XAException.
      Throws:
      XAException - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.
    • forget

      public final void forget(Xid xid) throws XAException
      Tell 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.
    • rollback

      public final void rollback(Xid xid) throws XAException
      Inform 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
    • setTransactionTimeout

      public boolean setTransactionTimeout(int seconds) throws 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 XAResource
      Parameters:
      seconds - the transaction timeout value in seconds. Value of 0 means the reasource manager's default value. Value of Integer.MAX_VALUE means no timeout.
      Returns:
      true if 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.
    • getDefaultXATransactionTimeout

      private long getDefaultXATransactionTimeout() throws XAException
      Returns the default value for the transaction timeout in milliseconds setted up by the system properties.
      Throws:
      XAException
    • start

      public final void start(Xid xid, int flags) throws XAException
      Start work on behalf of a transaction branch specified in xid If TMJOIN is specified, the start is for joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start is to resume 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.
    • getCurrentXid

      Xid getCurrentXid()
      Resturns currently active xid
      Returns:
      Xid
    • getTransactionState

      private XATransactionState getTransactionState(XAXactId xid_im)
      Returns the XATransactionState of the the transaction
      Parameters:
      xid_im -
      Returns:
      XATransactionState
    • checkUserCredentials

      private void checkUserCredentials(EmbedXAResource original) throws XAException
      Compares the user name and password of the XAResource with user name and password of this and throws XAException if there is a mismatch
      Parameters:
      original - EmbedXAResource
      Throws:
      XAException
    • checkXAActive

      private void checkXAActive() throws XAException
      Checks if currently associated connection is active throws exception if not
      Throws:
      XAException
    • wrapInXAException

      private static XAException wrapInXAException(SQLException se)
      Map a SQL exception to appropriate XAException. Return the mapped XAException.
    • wrapInXAException

      private static XAException wrapInXAException(StandardException se)
      Map a Standard exception to appropriate XAException. Return the mapped XAException.
    • returnConnectionToResource

      void returnConnectionToResource(XATransactionState tranState, XAXactId xid_im)
      Return an underlying connection object back to its XAResource if possible. If not close the connection.
      Parameters:
      tranState -
      xid_im -
    • closeUnusedConnection

      private static void closeUnusedConnection(EmbedConnection conn)
      Close an underlying connection object when there is no active XAResource to hand it to.
      Parameters:
      conn -
    • removeXATransaction

      void removeXATransaction(XAXactId xid_im)
      Removes the xid from currently active transactions
      Parameters:
      xid_im -
    • setCurrentXid

      void setCurrentXid(XAXactId aCurrentXid)
    • getContextService

      private static ContextService getContextService()
      Privileged lookup of the ContextService. Must be private so that user code can't call this entry point.
    • getContextManager

      private static ContextManager getContextManager(EmbedConnection conn)
      Privileged lookup of the ContextManager. Must be private so that user code can't call this entry point.
    • getLanguageConnectionContext

      private LanguageConnectionContext getLanguageConnectionContext(EmbedConnection conn)
      Gets the LanguageConnectionContext for this connection.
    • getLanguageConnectionContext

      private LanguageConnectionContext getLanguageConnectionContext(EmbedPooledConnection conn) throws SQLException
      Privileged LCC lookup. Must be private so that user code can't call this entry point.
      Throws:
      SQLException