Package oracle.jdbc.xa.client

Class OracleXAResource

  • <section role="region"> </section> <section role="region">

    • Method Detail

      • start

        public void start​(Xid xid,
                  int flag)
           throws XAException
        start() -- Starts work on behalf of a transaction branch. If TMJOIN is specified, the start is for joining an exisiting 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. start() allows Isolation flags to be set, only when beginning a new transaction. XAER_INVAL exception is raised for error cases, such as (1) when JOIN/RESUME specified on start (2) invalid Isol flag is set. The valid Isolation levels allowed are: ORATMREADONLY ORATMREADWRITE ORATMSERIALIZABLE
        Specified by:
        start in interface XAResource
        Specified by:
        start in class OracleXAResource
        Parameters:
        xid - A global transaction identifier.
        flag - One of TMNOFLAGS, TMJOIN, TMNOMIGRATE 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.

      • end

        public void end​(Xid xid,
                int flag)
         throws 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 suspened 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 XAResource
        Specified by:
        end in class OracleXAResource
        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:
        XAException - An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB.

      • commit

        public void commit​(Xid xid,
                   boolean onePhase)
            throws XAException
        commit() -- Commit work done by global transaction specified by xid.
        Specified by:
        commit in interface XAResource
        Specified by:
        commit in class OracleXAResource
        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:
        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 paramether 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 int prepare​(Xid xid)
            throws XAException
        prepare() -- Ask RM to prepare for a commit of the txn specified in xid.
        Specified by:
        prepare in interface XAResource
        Specified by:
        prepare in class OracleXAResource
        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:
        XAException - (An error has occurred.) Possible exception values are: XA_RB, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

      • forget

        public void forget​(Xid xid)
            throws XAException
        forget() -- Tell RM to forget about a heuristically completed txn branch
        Specified by:
        forget in interface XAResource
        Specified by:
        forget in class OracleXAResource
        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.
    </section>