KickJava   Java API By Example, From Geeks To Geeks.

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


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.Resource;
25
26 /**
27  * Interface of a factory that creates references to DTM or OTS resources.
28  * In order to register itself as a subcoordinator with the parent coordinator,
29  * a <code>TransactionImpl</code> instance needs to obtain a reference to a
30  * resource associated with itself. It calls a <code>ResourceFactory</code> to
31  * obtain that reference, which it then uses as the resource parameter in a
32  * call to <code>registerResource</code> on the parent coordinator.
33  *
34  * @author <a HREF="mailto:reverbel@ime.usp.br">Francisco Reverbel</a>
35  * @version $Revision: 37459 $
36  */
37 public interface ResourceFactory
38 {
39    /**
40     * Creates a reference to a DTM or OTS resource that corresponds to the
41     * transaction with a given <code>localId</code>.
42     * @param localId the local id of a transaction
43     * @return a <code>Resource</code> reference
44     */
45    Resource createResource(long localId);
46 }
47
Popular Tags