KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > transaction > jta > ResourceManagerEventListener


1 /*
2  * @(#) ResourceManagerEventListener.java
3  *
4  * JOTM: Java Open Transaction Manager
5  *
6  * This module was originally developed by
7  * - INRIA inside the ObjectWeb Consortium(http://www.objectweb.org)
8  *
9  * 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: JTAClientTransactionInterceptor.java,v 1.5 2003/12/05 20:24:18 degolf Exp $
37  * --------------------------------------------------------------------------
38  */
39 package org.objectweb.transaction.jta;
40
41 /**
42  * A <code>ResourceManagerEventListener</code> allows late enrolment of
43  * connections that are opened in the thread before the transaction starts.
44  *
45  * <p>Resource Managers that support registration of
46  * <code>ResourceManagerEventListener</code> will be able to notify the
47  * transaction manager of connections opened without transaction context and get
48  * a callback from the transaction manager when the transaction begins.<br /> In
49  * a typical Resource Manager, the registration of the listener is made by the
50  * application server via mutator method such as <code>ResourceManager.
51  * setResourceManagerEventListener(listener)</code>.</p>
52  *
53  * @author Christophe Ney cney@batisseurs.com for Lutris Technologies
54  */
55 public interface ResourceManagerEventListener {
56
57     /**
58      * This method is called by the resource manager when a
59      * <code>getConnection</code> call is made without a transaction
60      * context. The <code>ResourceManagerEvent</code> is to be used
61      * by the listener to keep track of those events and perform a late
62      * enrolment of those logical connection when the transaction begins.
63      *
64      * @param event event sent to the listener
65      */
66     void connectionOpened(ResourceManagerEvent event);
67
68     /**
69      * This method is called by the resource manager when a logical connection
70      * that was opened without transaction context is closed.
71      * It is to be used by the listener to keep track of those events and
72      * perform clean-up.
73      *
74      * @param event event sent to the listener
75      */
76     void connectionClosed(ResourceManagerEvent event);
77
78     /**
79      * This method is called by the resource manager when a logical connection
80      * that was opened without transaction context is about to throw an
81      * exception.
82      * It is to be used by the listener to keep track of those events and
83      * perform clean-up.
84      *
85      * @param event event sent to the listener
86      */
87     void connectionErrorOccured(ResourceManagerEvent event);
88 }
89
Popular Tags