View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2003-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: Registry.java,v 1.1 2004/11/26 01:51:05 tanderson Exp $
44   */
45  package org.exolab.jms.net.registry;
46  
47  import java.rmi.AccessException;
48  import java.rmi.AlreadyBoundException;
49  import java.rmi.NotBoundException;
50  import java.rmi.RemoteException;
51  
52  import org.exolab.jms.net.proxy.Proxy;
53  
54  
55  /***
56   * The <code>Registry</code> provides a simple interface for binding and
57   * retrieving remote object references by name.
58   *
59   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
60   * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:05 $
61   */
62  public interface Registry {
63  
64      /***
65       * Returns a proxy for the remote object associated with the specified name
66       *
67       * @param name the name the proxy is bound under
68       * @return the proxy bound to <code>name</code>
69       * @throws NotBoundException if <code>name<code> is not bound
70       * @throws RemoteException   if the registry could not be contacted
71       */
72      Proxy lookup(String name) throws NotBoundException, RemoteException;
73  
74      /***
75       * Binds the specified name to a remote object.
76       *
77       * @param name  the name of the binding
78       * @param proxy the proxy for the remote object
79       * @throws AccessException       if the caller doesn't have permission to
80       *                               bind the object
81       * @throws AlreadyBoundException if <code>name</code> is already bound
82       * @throws RemoteException       if the registry could not be contacted
83       */
84      void bind(String name, Proxy proxy)
85              throws AccessException, AlreadyBoundException, RemoteException;
86  
87      /***
88       * Removes the binding for the specified name
89       *
90       * @param name the name of the binding
91       * @throws AccessException   if the caller doesn't have permission to unbind
92       *                           the object
93       * @throws NotBoundException if <code>name<code> is not bound
94       * @throws RemoteException   if the registry could not be contacted
95       */
96      void unbind(String name)
97              throws AccessException, NotBoundException, RemoteException;
98  
99  }
100