TransactionTimeoutConfiguration


1   /*
2     * JBoss, Home of Professional Open Source
3     * Copyright 2005, JBoss Inc., and individual contributors as indicated
4     * by the @authors tag. See the copyright.txt in the distribution for a
5     * full listing of individual contributors.
6     *
7     * This is free software; you can redistribute it and/or modify it
8     * under the terms of the GNU Lesser General Public License as
9     * published by the Free Software Foundation; either version 2.1 of
10    * the License, or (at your option) any later version.
11    *
12    * This software is distributed in the hope that it will be useful,
13    * but WITHOUT ANY WARRANTY; without even the implied warranty of
14    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15    * Lesser General Public License for more details.
16    *
17    * You should have received a copy of the GNU Lesser General Public
18    * License along with this software; if not, write to the Free
19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21    */
22  package org.jboss.tm;
23  
24  import javax.transaction.RollbackException  ;
25  import javax.transaction.SystemException  ;
26  
27  /**
28   * The interface to implementated by a transaction manager
29   * that supports retrieving the current threads transaction timeout
30   *
31   * @author <a HREF="mailto:adrian@jboss.org">Adrian Brock</a>
32   * @version $Revision: 37459 $
33   */
34  public interface TransactionTimeoutConfiguration
35  {
36     /**
37      * Get the transaction timeout.
38      * 
39      * @return the timeout in seconds associated with this thread
40      * @throws SystemException for any error
41      */
42     int getTransactionTimeout() throws SystemException  ;
43  
44     /**
45      * Get the time left before transaction timeout
46      * 
47      * @param errorRollback throw an error if the transaction is marked for rollback
48      * @return the remaining in the current transaction or -1
49      * if there is no transaction
50      * @throws RollbackException if the transaction is marked for rollback and
51      * errorRollback is true
52      */
53     long getTimeLeftBeforeTransactionTimeout(boolean errorRollback) throws RollbackException  ;
54  }
55
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags