borland Packages  Class Hierarchy  datastore.javax.sql Package 

JXAResource class (abstract)

java.lang.Object
   +----com.borland.datastore.javax.sql.JXAResource
           +----com.borland.datastore.javax.sql.JXA
           +----com.borland.datastore.javax.sql.JXARemote

About the JXAResource class

Properties  Methods  

Note: This is a feature of JBuilder Professional and Enterprise.

This class is used internally by other com.borland classes. You should never use this class directly.


JXAResource properties

*Read-only properties **Write-only properties

Properties implemented in this class

Properties implemented in java.lang.Object

JXAResource methods

Methods implemented in this class

Methods implemented in java.lang.Object


JXAResource properties

globalTx

 public abstract boolean isGlobalTx()

transactionTimeout

 public abstract int getTransactionTimeout()
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.

Returns: The transaction timeout value in seconds.

Throws: XAException An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.


JXAResource methods

close()

  public abstract void close()

commit(xid, boolean)

  public abstract void commit(Xid xid, boolean onePhase)
Commits the global transaction specified by xid.

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 onePhase parameter 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.

create(con, delegateCon, props)

  public static final JXAResource create(BConnection con, DelegateConnection delegateCon, DataSourceProperties props)

end(xid, int)

  public abstract void end(Xid xid, int flags)
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.

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_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*. XAER_NOTA is a possible value if there is not a started xid transaction for this resource manager. XAER_INVAL is possible if xid is null or flags is not TMSUSPEND, TMFAIL or TMSUCCESS. XAER_PROTO is possible if not in a started or suspended state.

forget(xid)

  public abstract void forget(Xid xid)
Tells the resource manager to forget about a heuristically completed transaction branch.

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. XAER_PROTO is thrown if transaction was not started for xid. XAER_NOTA is thrown if the transaction was not heuristically completed.

isSameRM(xares)

  public boolean isSameRM(XAResource xares)
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.

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 and XAER_RMFAIL.

prepare(xid)

  public abstract int prepare(Xid xid)
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Parameters:

xid
- A global transaction identifier.

Throws: XAException An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

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.

recover(int)

  public abstract Xid[] recover(int flag)
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.

Parameters:

flag
- One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter.

Throws: XAException An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

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.

rollback(xid)

  public abstract void rollback(Xid xid)
Informs the resource manager to roll back work done on behalf of a transaction branch.

Parameters:

xid
- A global transaction identifier.

Throws: XAException An error has occurred.

setTransactionTimeout(int)

  public abstract boolean setTransactionTimeout(int seconds)

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.

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(xid, int)

  public abstract void start(Xid xid, int flags)
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 an XAException with XAER_DUPID error code.

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. XAER_PROTO is thrown for an invalid state or an attempt to join a transaction branch when the Connection associated with this resource has already joined another transaction branch. XAER_INVAL can be thrown if an attempt is made to join a transaction where the two resources to be joined are not in the same database.