01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57208 $
33: */
34: public interface TransactionTimeoutConfiguration {
35: /**
36: * Get the transaction timeout.
37: *
38: * @return the timeout in seconds associated with this thread
39: * @throws SystemException for any error
40: */
41: int getTransactionTimeout() throws SystemException;
42:
43: /**
44: * Get the time left before transaction timeout
45: *
46: * @param errorRollback throw an error if the transaction is marked for rollback
47: * @return the remaining in the current transaction or -1
48: * if there is no transaction
49: * @throws RollbackException if the transaction is marked for rollback and
50: * errorRollback is true
51: */
52: long getTimeLeftBeforeTransactionTimeout(boolean errorRollback)
53: throws RollbackException;
54: }
|