KickJava   Java API By Example, From Geeks To Geeks.

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


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 org.jboss.tm.remoting.interfaces.Coordinator;
25
26 /**
27  * Interface of a factory that creates OTS propagation contexts.
28  *
29  * @author <a HREF="mailto:reverbel@ime.usp.br">Francisco Reverbel</a>
30  * @version $Revision: 37459 $
31  */

32 public interface OTSContextFactory
33 {
34    /**
35     * Creates an OTS context with the specified <code>formatId</code>,
36     * <code>globalId</code>, and <code>coordinator</code>. The OTS context
37     * will contain a null <code>Terminator</code> reference and an
38     * <code>org.omg.CosTransactions.Coordinator</code> reference extracted from
39     * the <code>coordinator</code> parameter, which must be an instance of
40     * <code>org.jboss.tm.iiop.wrapper.OTSCoordinatorWrapper</code>.
41     * It will contain zero in its timeout field. The caller should use the
42     * method <code>setTimeout</code> to set the timeout field of the newly
43     * created OTS context.
44     *
45     * @param formatId the format id to be stored in the OTS context
46     * @param globalId the global id to be stored in the OTS context
47     * @param coordinator an <code>org.jboss.tm.iiop.wrapper.OTSCoordinatorWrapper</code>
48     * containing the <code>org.omg.CosTransactions.Coordinator</code>
49     * reference to be stored in the OTS context
50     * @return an instance of <code>org.omg.CosTransactions.PropagationContext</code>.
51     */

52    Object JavaDoc createOTSContext(int formatId,
53                            byte[] globalId,
54                            Coordinator coordinator);
55
56    /**
57     * Creates an OTS context with the specified <code>formatId</code> and
58     * <code>globalId</code>, and with an
59     * <code>org.omg.CosTransactions.Coordinator</code> reference that
60     * corresponds to the local transaction whose local id is
61     * <code>coordinatorLocalId</code>. The OTS context will contain a null
62     * <code>Terminator</code> reference and zero in its timeout field.
63     * The caller should use the method <code>setTimeout</code> to set the
64     * timeout field of the newly created OTS context.
65     *
66     * @param formatId the format id to be stored in the OTS context
67     * @param globalId the global id to be stored in the OTS context
68     * @param coordinatorLocalId the local id of the transaction associated with
69     * the coordinator reference to be stored in the OTS context
70     * @return an instance of <code>org.omg.CosTransactions.PropagationContext</code>.
71     */

72    Object JavaDoc createOTSContext(int formatId,
73                            byte[] globalId,
74                            long coordinatorLocalId);
75
76    /**
77     * Sets the timeout field of the specified OTS context.
78     * @param otsContext an instance of <code>org.omg.CosTransactions.PropagationContext</code>
79     * @param timeout the timeout value, in seconds, to be stored in the OTS
80     * context.
81     */

82    void setTimeout(Object JavaDoc otsContext, int timeout);
83    
84 }
85
Popular Tags