JavaEE API 8.0.1 · javax.resource.spi.work.ExecutionContext

This class models an execution context (transaction, security, etc) with which the Work instance must be executed. This class is provided as a convenience for easily creating ExecutionContext instances by extending this class and overriding only those methods of interest.

Some reasons why it is better for ExecutionContext to be a class rather than an interface:

There is no need for a resource adapter to implement this class. It only needs to implement the context information like transaction, etc.
The resource adapter code does not have to change when the ExecutionContext class evolves. For example, more context types could be added to the ExecutionContext class (in the future) without forcing resource adapter implementations to change.

Note

Resource adapters that are developed for Connectors 1.6 specification compliant application servers and above, are recommended to use the TransactionContext interface instead of this class. See Chapter.11 Generic Work Context in the Connectors 1.6 specification for more details.

Modifier and Type	Field and Description
private long	transactionTimeout transaction timeout value.
private Xid	xid transaction context.

Access	Constructor and Description
public	ExecutionContext()

Method Summary

Modifier and Type	Method and Description
public long	Returns: the specified transaction timeout value in seconds. When no timeout value or an illegal timeout value had been specified, a value of -1 (`WorkManager.UNKNOWN`) is returned; the timeout processing of such a transaction depends on the application server implementation. getTransactionTimeout() Get the transaction timeout value for a imported transaction.
public Xid	Returns: an Xid object carrying a transaction context, if any. getXid()
public void	setTransactionTimeout(long transaction timeout value in seconds. Only positive non-zero values are accepted. Other values are illegal and are rejected with a `NotSupportedException`. timeout) Set the transaction timeout value for a imported transaction.
public void	setXid(Xid transaction context. xid) set a transaction context.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

transactionTimeout	back to summary
private long transactionTimeout transaction timeout value.

xid	back to summary
private Xid xid transaction context.

ExecutionContext	back to summary
public ExecutionContext()

Method Detail

getTransactionTimeout back to summary

getTransactionTimeout	back to summary
public long getTransactionTimeout() Get the transaction timeout value for a imported transaction. Returns:long the specified transaction timeout value in seconds. When no timeout value or an illegal timeout value had been specified, a value of -1 (`WorkManager.UNKNOWN`) is returned; the timeout processing of such a transaction depends on the application server implementation.

public long getTransactionTimeout()

Get the transaction timeout value for a imported transaction.

Returns:long: the specified transaction timeout value in seconds. When no timeout value or an illegal timeout value had been specified, a value of -1 (WorkManager.UNKNOWN) is returned; the timeout processing of such a transaction depends on the application server implementation.

getXid	back to summary
public Xid getXid() Returns:Xid an Xid object carrying a transaction context, if any.

setTransactionTimeout back to summary

setTransactionTimeout	back to summary
public void setTransactionTimeout(long timeout) throws NotSupportedException Set the transaction timeout value for a imported transaction. Parameters timeout:long transaction timeout value in seconds. Only positive non-zero values are accepted. Other values are illegal and are rejected with a `NotSupportedException`. Exceptions NotSupportedException: thrown to indicate an illegal timeout value.

public void setTransactionTimeout(long timeout) throws NotSupportedException

Set the transaction timeout value for a imported transaction.

Parameters

timeout:long: transaction timeout value in seconds. Only positive non-zero values are accepted. Other values are illegal and are rejected with a NotSupportedException.

Exceptions

NotSupportedException:: thrown to indicate an illegal timeout value.

setXid	back to summary
public void setXid(Xid xid) set a transaction context. Parameters xid:Xid transaction context.

setXid

back to summary

public void setXid(Xid xid)

set a transaction context.

Parameters

xid:Xid: transaction context.

public Class ExecutionContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail