javax.resource.spi.work.ExecutionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-javaee
The JBoss JavaEE API classes
The newest version!
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.resource.spi.work;

import javax.resource.NotSupportedException;
import javax.transaction.xa.Xid;

/**
 * An execution context provides context information for work, e.g.
 * transaction, security, etc.
 */
public class ExecutionContext
{
   /** The xid */
   private Xid xid;
   /** The timeout */
   private long timeout = WorkManager.UNKNOWN;

   /**
	 * Get the xid
	 * 
	 * @return the xid
	 */
   public Xid getXid()
   {
      return xid;
   }

   /**
	 * Set the xid
	 * 
	 * @param xid the xid
	 */
   public void setXid(Xid xid)
   {
      this.xid = xid;
   }

   /**
	 * Get the transaction timeout
	 * 
	 * @return the transaction timeout or WorkManager.UNKNOWN for an invalid or
	 *         unspecified value
	 */
   public long getTransactionTimeout()
   {
      return timeout;
   }

   /**
	 * Set the transaction timeout
	 * 
	 * @param timeout the timeout
	 * @throws NotSupportedException for an invalid timeout
	 */
   public void setTransactionTimeout(long timeout) throws NotSupportedException
   {
      if (timeout < 0)
         throw new NotSupportedException("Illegal timeout " + timeout);
      this.timeout = timeout;
   }
}