KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jotm > TransactionRecovery


1 /*
2  * @(#) TransactionRecovery.java
3  *
4  * JOTM: Java Open Transaction Manager
5  *
6  *
7  * This module was originally developed by
8  *
9  * - Bull S.A. as part of the JOnAS application server code released in
10  * July 1999 (www.bull.com)
11  *
12  * --------------------------------------------------------------------------
13  * The original code and portions created by Bull SA are
14  * Copyright (c) 1999 BULL SA
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are met:
19  *
20  * -Redistributions of source code must retain the above copyright notice, this
21  * list of conditions and the following disclaimer.
22  *
23  * -Redistributions in binary form must reproduce the above copyright notice,
24  * this list of conditions and the following disclaimer in the documentation
25  * and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  *
39  * --------------------------------------------------------------------------
40  * $Id: TransactionRecovery.java,v 1.3 2005/04/18 16:12:46 rogerperey Exp $
41  * --------------------------------------------------------------------------
42  */
43 package org.objectweb.jotm;
44
45 import javax.transaction.xa.XAResource JavaDoc;
46 import javax.transaction.xa.XAException JavaDoc;
47 import java.util.Vector JavaDoc;
48 import org.objectweb.howl.log.LogException;
49 import java.util.Properties JavaDoc;
50
51 public interface TransactionRecovery {
52     
53     public JotmRecovery getJotmRecovery();
54     
55     public Vector JavaDoc getRmRegistration();
56
57     /**
58      * Log all the Resource Managers with the JOTM Transaction Manager.
59      *
60      * @exception XAException if an error occurs
61      */
62
63     public void startResourceManagerRecovery () throws XAException JavaDoc;
64
65     /**
66      * Register a Resource Manager with the JOTM Transaction Manager.
67      *
68      * @param rmName The Resource Manager to be registered.
69      * @param rmXares XAResource associated with the Resource Manager
70      * @param info String of information for display with admin interface
71      * @param trm TransactionResourceManager to return the registered XAResource
72      * @exception XAException if an error occurs
73      */
74
75     public void registerResourceManager (String JavaDoc rmName, XAResource JavaDoc rmXares, String JavaDoc info,
76                                          TransactionResourceManager trm) throws XAException JavaDoc;
77
78     /**
79      * Added 3/30/05
80      * Register a Resource Manager with the JOTM Transaction Manager with Recovery properties.
81      *
82      * @param rmName The Resource Manager to be registered.
83      * @param rmXares XAResource associated with the Resource Manager
84      * @param info String of information for display with admin interface
85      * @param rmProperties - Strings specifying recovery properties for resource
86      * @param trm TransactionResourceManager to return the registered XAResource
87      * @exception XAException if an error occurs
88      */
89
90     public void registerResourceManager (String JavaDoc rmName, XAResource JavaDoc rmXares, String JavaDoc info,
91                                          Properties JavaDoc rmProperties,
92                                          TransactionResourceManager trm) throws XAException JavaDoc;
93
94
95     /**
96      * Provide information regarding the status and state of the XAResource.
97      *
98      * @return The XAResource to be reported upon.
99      *
100      * @exception XAException if an error occurs
101      */
102
103     XAResource JavaDoc reportResourceManager (String JavaDoc rmName) throws XAException JavaDoc;
104
105     /**
106      * Unregister a Resource Manager from the JOTM Transaction Manager.
107      *
108      * @param rmName The Resource Manager to be unregistered.
109      * @param rmXares XAResource associated with the Resource Manager
110      * @exception XAException if an error occurs
111      */
112
113     public void unregisterResourceManager (String JavaDoc rmName, XAResource JavaDoc rmXares) throws XAException JavaDoc;
114
115     public void forget() throws LogException, Exception JavaDoc;
116 }
117
Popular Tags