Java EE 5 SDK

javax.resource.spi.work
Class ExecutionContext

java.lang.Object
  extended by javax.resource.spi.work.ExecutionContext

public class ExecutionContext
extends Object

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:

Version:
1.0
Author:
Ram Jeyaraman

Constructor Summary
ExecutionContext()
           
 
Method Summary
 long getTransactionTimeout()
          Get the transaction timeout value for a imported transaction.
 Xid getXid()
           
 void setTransactionTimeout(long timeout)
          Set the transaction timeout value for a imported transaction.
 void setXid(Xid xid)
          set a transaction context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExecutionContext

public ExecutionContext()
Method Detail

setXid

public void setXid(Xid xid)
set a transaction context.

Parameters:
xid - transaction context.

getXid

public Xid getXid()

setTransactionTimeout

public void setTransactionTimeout(long timeout)
                           throws NotSupportedException
Set the transaction timeout value for a imported transaction.

Parameters:
timeout - transaction timeout value in seconds. Only positive non-zero values are accepted. Other values are illegal and are rejected with a NotSupportedException.
Throws:
NotSupportedException - thrown to indicate an illegal timeout value.

getTransactionTimeout

public long getTransactionTimeout()
Get the transaction timeout value for a imported transaction.

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; such a transaction is excluded from regular timeout processing.

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.