KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > tm > TransactionLocalDelegate


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.Transaction JavaDoc;
25
26 /**
27  * The interface to implementated for a transaction local implementation
28  *
29  * @author <a HREF="mailto:adrian@jboss.org">Adrian Brock</a>
30  * @version $Revision: 37459 $
31  */

32 public interface TransactionLocalDelegate
33 {
34    /**
35     * get the transaction local value.
36     */

37    Object JavaDoc getValue(TransactionLocal local, Transaction JavaDoc tx);
38
39    /**
40     * put the value in the transaction local
41     */

42    void storeValue(TransactionLocal local, Transaction JavaDoc tx, Object JavaDoc value);
43
44    /**
45     * does Transaction contain object?
46     */

47    boolean containsValue(TransactionLocal local, Transaction JavaDoc tx);
48    
49    /**
50     * Lock the transaction local in the context of this transaction
51     *
52     * @throws IllegalStateException if the transaction is not active
53     * @throws InterruptedException if the thread is interrupted
54     */

55    void lock(TransactionLocal local, Transaction JavaDoc tx) throws InterruptedException JavaDoc;
56    
57    /**
58     * Unlock the transaction local in the context of this transaction
59     */

60    void unlock(TransactionLocal local, Transaction JavaDoc tx);
61 }
62
Popular Tags