Interface Registry
-
- All Superinterfaces:
- Remote
public interface Registry extends Remote
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. Thebind
,unbind
, andrebind
methods are used to alter the name bindings in the registry, and thelookup
andlist
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-knownObjID
and TCP port number (default is1099
).The
LocateRegistry
class provides a programmatic API for constructing a bootstrap reference to aRegistry
at a remote address (see the staticgetRegistry
methods) and for creating and exporting aRegistry
in the current VM on a particular local address (see the staticcreateRegistry
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 aRegistry
method chooses to deny access for a given invocation, its implementation may throwAccessException
, which (because it extendsRemoteException
) will be wrapped in aServerException
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 aRegistry
may wish to use a package name as a prefix in the name binding to reduce the likelihood of name collisions in the registry.- Since:
- JDK1.1
- See Also:
-
LocateRegistry
-
-
Field Summary
Fields Modifier and Type Field and Description static int
REGISTRY_PORT
Well known port for registry.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
bind(String name, Remote obj)
Binds a remote reference to the specifiedname
in this registry.String[]
list()
Returns an array of the names bound in this registry.Remote
lookup(String name)
Returns the remote reference bound to the specifiedname
in this registry.void
rebind(String name, Remote obj)
Replaces the binding for the specifiedname
in this registry with the supplied remote reference.void
unbind(String name)
Removes the binding for the specifiedname
in this registry.
-
-
-
Field Detail
REGISTRY_PORT
static final int REGISTRY_PORT
Well known port for registry.- See Also:
- Constant Field Values
-
Method Detail
lookup
Remote lookup(String name) throws RemoteException, NotBoundException, AccessException
Returns the remote reference bound to the specifiedname
in this registry.- Parameters:
-
name
- the name for the remote reference to look up - Returns:
- a reference to a remote object
- Throws:
-
NotBoundException
- ifname
is not currently bound -
RemoteException
- if remote communication with the registry failed; if exception is aServerException
containing anAccessException
, then the registry denies the caller access to perform this operation -
AccessException
- if this registry is local and it denies the caller access to perform this operation -
NullPointerException
- ifname
isnull
bind
void bind(String name, Remote obj) throws RemoteException, AlreadyBoundException, AccessException
Binds a remote reference to the specifiedname
in this registry.- Parameters:
-
name
- the name to associate with the remote reference -
obj
- a reference to a remote object (usually a stub) - Throws:
-
AlreadyBoundException
- ifname
is already bound -
RemoteException
- if remote communication with the registry failed; if exception is aServerException
containing anAccessException
, then the registry denies the caller access to perform this operation (if originating from a non-local host, for example) -
AccessException
- if this registry is local and it denies the caller access to perform this operation -
NullPointerException
- ifname
isnull
, or ifobj
isnull
unbind
void unbind(String name) throws RemoteException, NotBoundException, AccessException
Removes the binding for the specifiedname
in this registry.- Parameters:
-
name
- the name of the binding to remove - Throws:
-
NotBoundException
- ifname
is not currently bound -
RemoteException
- if remote communication with the registry failed; if exception is aServerException
containing anAccessException
, then the registry denies the caller access to perform this operation (if originating from a non-local host, for example) -
AccessException
- if this registry is local and it denies the caller access to perform this operation -
NullPointerException
- ifname
isnull
rebind
void rebind(String name, Remote obj) throws RemoteException, AccessException
Replaces the binding for the specifiedname
in this registry with the supplied remote reference. If there is an existing binding for the specifiedname
, it is discarded.- Parameters:
-
name
- the name to associate with the remote reference -
obj
- a reference to a remote object (usually a stub) - Throws:
-
RemoteException
- if remote communication with the registry failed; if exception is aServerException
containing anAccessException
, then the registry denies the caller access to perform this operation (if originating from a non-local host, for example) -
AccessException
- if this registry is local and it denies the caller access to perform this operation -
NullPointerException
- ifname
isnull
, or ifobj
isnull
list
String[] list() throws RemoteException, AccessException
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.- Returns:
- an array of the names bound in this registry
- Throws:
-
RemoteException
- if remote communication with the registry failed; if exception is aServerException
containing anAccessException
, then the registry denies the caller access to perform this operation -
AccessException
- if this registry is local and it denies the caller access to perform this operation
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.