Movatterモバイル変換

Interface XAResource

public interfaceXAResource

The XAResource interface is a Java mapping of the industry standard XA interface based on the X/Open CAE Specification (Distributed Transaction Processing: The XA Specification).

The XA interface defines the contract between a Resource Manager and a Transaction Manager in a distributed transaction processing (DTP) environment. A JDBC driver or a JMS provider implements the this interface to support association between a global transaction and a database or message service connection.

The XAResource interface can be supported by any transactional resource that is intended to be used by application programs in an environment where transactions are controlled by an external transaction manager. An example of such a resource is a database management system. An application may access data through multiple database connections. Each database connection is enlisted with the transaction manager as a transactional resource. The transaction manager obtains an XAResource for each connection participating in a global transaction. The transaction manager uses the start method to associate the global transaction with the resource, and it uses the end method to disassociate the transaction from the resource. The resource manager is responsible for associating the global transaction to all work performed on its data between the start and end method invocation.

At transaction commit time, the resource managers are informed by the transaction manager to prepare, commit, or rollback a transaction according to the two-phase commit protocol.


	`TMENDRSCAN` End a recovery scan.
	`TMFAIL` Disassociates the caller and mark the transaction branch rollback-only.
	`TMJOIN` Caller is joining existing transaction branch.
	`TMNOFLAGS` Use TMNOFLAGS to indicate no flags value is selected.
	`TMONEPHASE` Caller is using one-phase optimization.
	`TMRESUME` Caller is resuming association with with suspended transaction branch.
	`TMSTARTRSCAN` Start a recovery scan.
	`TMSUCCESS` Disassociate caller from transaction branch.
	`TMSUSPEND` Caller is suspending (not ending) association with transaction branch.
	`XA_OK` The transaction work has been prepared normally.
	`XA_RDONLY` The transaction branch has been read-only and has been committed.


	`commit(Xid xid, boolean onePhase)` Commit the global transaction specified by xid.
	`end(Xid xid, int flags)` Ends the work performed on behalf of a transaction branch.
	`forget(Xid xid)` Tell the resource manager to forget about a heuristically completed transaction branch.
	`getTransactionTimeout()` Obtain the current transaction timeout value set for this XAResource instance.
	`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 parameterxares.
	`prepare(Xid xid)` Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
	`recover(int flag)` Obtain a list of prepared transaction branches from a resource manager.
	`rollback(Xid xid)` Inform the resource manager to roll back work done on behalf of a transaction branch
	`setTransactionTimeout(int seconds)` Set the current transaction timeout value for this`XAResource` instance.
	`start(Xid xid, int flags)` 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.

TMENDRSCAN

public static final intTMENDRSCAN

End a recovery scan.

TMFAIL

public static final intTMFAIL

Disassociates the caller and mark the transaction branch rollback-only.

TMJOIN

public static final intTMJOIN

Caller is joining existing transaction branch.

TMNOFLAGS

public static final intTMNOFLAGS

Use TMNOFLAGS to indicate no flags value is selected.

TMONEPHASE

public static final intTMONEPHASE

Caller is using one-phase optimization.

TMRESUME

public static final intTMRESUME

Caller is resuming association with with suspended transaction branch.

TMSTARTRSCAN

public static final intTMSTARTRSCAN

Start a recovery scan.

TMSUCCESS

public static final intTMSUCCESS

Disassociate caller from transaction branch.

TMSUSPEND

public static final intTMSUSPEND

Caller is suspending (not ending) association with transaction branch.

XA_RDONLY

public static final intXA_RDONLY

The transaction branch has been read-only and has been committed.

XA_OK

public static final intXA_OK

The transaction work has been prepared normally.

commit

public voidcommit(Xid xid,                   boolean onePhase)            throwsXAException

Commit 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 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 voidend(Xid xid,                int flags)         throwsXAException

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.

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*.

forget

public voidforget(Xid xid)            throwsXAException

Tell 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.

getTransactionTimeout

public intgetTransactionTimeout()                          throwsXAException

Obtain the current transaction timeout value set for this XAResource instance. IfXAResource.setTransactionTimeout was not use prior to invoking this method, the return value is the default timeout set for the resource manager; otherwise, the value used in the previoussetTransactionTimeout call is returned.

Returns:: the transaction timeout value in seconds.
Throws:: XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

isSameRM

public booleanisSameRM(XAResource xares)                 throwsXAException

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 parameterxares.

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; otherwisefalse.
Throws:: XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

prepare

public intprepare(Xid xid)            throwsXAException

Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

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

publicXid[]recover(int flag)              throwsXAException

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.

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.

rollback

public voidrollback(Xid xid)              throwsXAException

Inform 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

public booleansetTransactionTimeout(int seconds)                              throwsXAException

Set the current transaction timeout value for thisXAResource instance. Once set, this timeout value is effective untilsetTransactionTimeout 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 returnstrue; otherwisefalse. If a resource manager does not support transaction timeout value to be set explicitly, this method returnsfalse.

Parameters:: the - transaction timeout value in seconds.
Returns:: true if transaction timeout value is set successfully; otherwisefalse.
Throws:: XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

start

public voidstart(Xid xid,                  int flags)           throwsXAException

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.

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.

[8]ページ先頭