01: /*
02: * @(#) TransactionManager.java
03: *
04: * JOTM: Java Open Transaction Manager
05: *
06: * This module was originally developed by
07: * - INRIA inside the ObjectWeb Consortium(http://www.objectweb.org)
08: *
09: * The original code and portions created by INRIA are
10: * Copyright (C) 2002 - INRIA (www.inria.fr)
11: * All rights reserved.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions are met:
15: *
16: * -Redistributions of source code must retain the above copyright notice, this
17: * list of conditions and the following disclaimer.
18: *
19: * -Redistributions in binary form must reproduce the above copyright notice,
20: * this list of conditions and the following disclaimer in the documentation
21: * and/or other materials provided with the distribution.
22: *
23: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33: * POSSIBILITY OF SUCH DAMAGE.
34: *
35: * --------------------------------------------------------------------------
36: * $Id: TransactionManager.java,v 1.4 2003/12/05 20:24:18 degolf Exp $
37: * --------------------------------------------------------------------------
38: */
39: package org.objectweb.transaction.jta;
40:
41: import java.util.List;
42:
43: /**
44: * A <code>TransactionManager</code> extends JTA
45: * <code>javax.transaction.TransactionManager</code> with an event API that
46: * allows late enlistment of connections opened by resource managers before the
47: * transaction has begun. <br />
48: *
49: * To enable late enlistment of connections, the <code>TransactionManager</code>
50: * must be registered as a <code>ResourceManagerEventListener</code> with the
51: * resource manager.<br/>
52: * When the transaction manager receives an event from a
53: * resource manager, it stores the events in a thread local list. The thread
54: * local lists can be stacked/unstacked with the two methods
55: * <code>pushThreadLocalRMEventList</code> and
56: * <code>popThreadLocalRMEventList</code>. This is typically used when different
57: * event lists are to be nested in the same thread, or when a list spams several
58: * threads.
59: *
60: * Created on Feb 7, 2002
61: * @author Christophe Ney, cney@batisseurs. com
62: */
63: public interface TransactionManager extends
64: javax.transaction.TransactionManager,
65: ResourceManagerEventListener {
66:
67: /**
68: * Push a new event list on the stack of thread local resource event sets.
69: * The list must contain only <code>ResourceManagerEvent</code> objects.
70: *
71: * @param eventList the possibly null list of events to store forecoming
72: * <code>ResourceManagerEvent</code> events occuring in the current thread.
73: */
74: void pushThreadLocalRMEventList(List eventList);
75:
76: /**
77: * Pop the current set from the stack of thread local resource event sets
78: * The list contains <code>ResourceManagerEvent</code> objects.
79: *
80: * @return The possibly null <code>ResourceManagerEvent</code>
81: * list of events that have occured in the current thread since the last
82: * call of <code>pushThreadLocalRMEventList</code> or since the thread
83: * started.
84: */
85: List popThreadLocalRMEventList();
86: }
|