Save This Page
Home » openjdk-7 » java » rmi » registry » [javadoc | source]
java.rmi.registry
public interface: Registry [javadoc | source]

All Implemented Interfaces:
    Remote

All Known Implementing Classes:
   

Registry is a remote interface to a simple remote object registry that provides methods for storing and retrieving remote object references bound with arbitrary string names. The bind, unbind, and rebind methods are used to alter the name bindings in the registry, and the lookup and list methods are used to query the current name bindings.

In its typical usage, a Registry enables RMI client bootstrapping: it provides a simple means for a client to obtain an initial reference to a remote object. Therefore, a registry's remote object implementation is typically exported with a well-known address, such as with a well-known ObjID and TCP port number (default is 1099 ).

The LocateRegistry class provides a programmatic API for constructing a bootstrap reference to a Registry at a remote address (see the static getRegistry methods) and for creating and exporting a Registry in the current VM on a particular local address (see the static createRegistry methods).

A Registry implementation may choose to restrict access to some or all of its methods (for example, methods that mutate the registry's bindings may be restricted to calls originating from the local host). If a Registry method chooses to deny access for a given invocation, its implementation may throw java.rmi.AccessException , which (because it extends java.rmi.RemoteException ) will be wrapped in a java.rmi.ServerException when caught by a remote client.

The names used for bindings in a Registry are pure strings, not parsed. A service which stores its remote reference in a Registry may wish to use a package name as a prefix in the name binding to reduce the likelihood of name collisions in the registry.

Field Summary
public static final  int REGISTRY_PORT    Well known port for registry. 
Method from java.rmi.registry.Registry Summary:
bind,   list,   lookup,   rebind,   unbind
Method from java.rmi.registry.Registry Detail:
 public  void bind(String name,
    Remote obj) throws AccessException, AlreadyBoundException, RemoteException
    Binds a remote reference to the specified name in this registry.
 public String[] list() throws AccessException, RemoteException
    Returns an array of the names bound in this registry. The array will contain a snapshot of the names bound in this registry at the time of the given invocation of this method.
 public Remote lookup(String name) throws AccessException, NotBoundException, RemoteException
    Returns the remote reference bound to the specified name in this registry.
 public  void rebind(String name,
    Remote obj) throws AccessException, RemoteException
    Replaces the binding for the specified name in this registry with the supplied remote reference. If there is an existing binding for the specified name, it is discarded.
 public  void unbind(String name) throws AccessException, NotBoundException, RemoteException
    Removes the binding for the specified name in this registry.