java.rmi.registry Documentation Differences

This file contains all the changes in documentation in the package java.rmi.registry as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

LocateRegistry is used to obtain a reference to a bootstrap remote object registry on a particular host (including the local host) or to create a remote object registry that accepts calls on a specific port.

Note that a getRegistry call does not actually make a connection to the remote host. It simply creates a local reference to the remote registry and will succeed even if no registry is running on the remote host. Therefore a subsequent method invocation to a remote registry returned as a result of this method may fail. @version 1.22 0229 12/0203/0001 @author Ann Wollrath @author Peter Jones @since JDK1.1 @see java.rmi.registry.Registry

For obtainingRegistry references tois a remote objects RMIinterface providesto a simple remote object registry interface implemented by RMI's rmiregistry that provides methods for storing and retrieving remote object references bound with arbitrary string names. The java.rmi.Namingbind classunbind providesand rebind methods are used to access a remotealter the name objectbindings in the registry usingand URL-formattedthe nameslookup and list methods are used to specifyquery inthe current name bindings.

In its typical usage a compactRegistry format both theenables RMI client remotebootstrapping: registry along with the nameit provides a simple means for thea client to obtain an initial reference to a remote object. TypicallyTherefore a "registry"'s exists on every node that allows RMI connectionsremote object implementation is typically exported with a towell-known servers on thataddress such as node.with Aa registrywell-known onObjID aand particularTCP port number (default is node1099})

The LocateRegistry class containsprovides a transientprogrammatic database that maps namesAPI for constructing a bootstrap reference to remotea objects.Registry Whenat a registryremote startsaddress up(see the registrystatic databasegetRegistry ismethods) empty.and Thefor namescreating and storedexporting a Registry in the registry are pure and are notcurrent VM on a particular local parsedaddress (see the static createRegistry methods).

A serviceRegistry storing itselfimplementation may inchoose to restrict access to some or all of its methods (for example methods that mutate the registry's bindings may want to prefix its name ofbe restricted to calls originating from the servicelocal byhost). If a packageRegistry namemethod (althoughchooses notto required)deny to reduce name collisions in theaccess for a given invocation its registryimplementation may throw java.rmi.AccessException Towhich create(because a registryit extends thatwil be runswrapped in ana applicationjava.rmi.ServerException use one of thewhen caught by a LocateRegistryremote client.createRegistry

The names used for bindings in a Registry methodsare pure strings not parsed. To obtain aA service which stores its remote reference toin a remoteRegistry object registrymay wish to use onea package ofname as a prefix in the LocateRegistry.getRegistryname methods.binding @versionto 1.13reduce 02/02/00the likelihood of name collisions in the registry. @author Ann Wollrath @sinceauthor JDK1.1Peter Jones @see javaversion 1.rmi16 01/12/03 @since JDK1.Naming1 @see java.rmi.registry.LocateRegistry

Binds a remote reference to the specified name to ain remote objectthis registry. @param name a URL-formattedthe name forto associate with the remote objectreference @param obj a reference forto thea remote object (usually a stub) @exceptionthrows AlreadyBoundException if name is already bound @exception MalformedURLExceptionthrows RemoteException if the nameremote is not an appropriatelycommunication with the registry formattedfailed; URLif @exception RemoteException ifis a registryServerException could notcontaining an beAccessException contactedthen @exceptionthe AccessException if this operation isregistry denies the caller access notto perform this permittedoperation (if originating from a non-local host for example) @sincethrows JDK1.1AccessException if this registry is local and it denies the caller access to perform this operation @throws NullPointerException if name is null or if obj is null

Returns an array of the names bound in thethis registry. The names are URL-formatted strings. The array containswill contain a snapshot of the names presentbound in thethis registry at the time of the callgiven invocation of this method. @return an array of the names (bound in thethis registry appropriate@throws URLRemoteException format)if boundremote incommunication with the registry @failed; if exception RemoteExceptionis ifa ServerException containing an AccessException then the registry coulddenies the caller not be contactedaccess to perform this operation @exceptionthrows AccessException if this operationregistry is not permittedlocal (ifand originating from ait denies the non-localcaller host foraccess to example)perform @sincethis JDK1.1operation

Returns a reference a stub for the remote object associated withreference bound to the specified name in this registry. @param name a URL-formattedthe name for the remote objectreference to look up @return a reference forto a remote object @exceptionthrows NotBoundException if name is not currently bound @exceptionthrows RemoteException if remote communication with the registry couldfailed; notif exception is a ServerException containing an AccessException then the registry denies the caller access be contactedto perform this operation @exceptionthrows AccessException if this operationregistry is not permittedlocal and (ifit originating from adenies the caller non-localaccess hostto forperform this example)operation @sincethrows JDK1.1NullPointerException if name is null

RebindsReplaces the binding for the specified name toin athis registry with the newsupplied remote objectreference. AnyIf there is an existing binding for the specified name it is replaceddiscarded. @param name a URL-formattedthe name associatedto associate with the remote objectreference @param obj new remotea objectreference to associatea with theremote object name(usually a stub) @exception MalformedURLExceptionthrows RemoteException if the nameremote is not an appropriatelycommunication with the registry formattedfailed; URLif @exception RemoteException ifis a registryServerException could notcontaining an beAccessException contactedthen @exceptionthe AccessException if this operationregistry denies the caller isaccess to notperform permittedthis operation (if originating from a non-local host for example) @sincethrows JDK1.1AccessException if this registry is local and it denies the caller access to perform this operation @throws NullPointerException if name is null or if obj is null

DestroysRemoves the binding for the specified name thatin is associated with a remotethis objectregistry. @param name a URL-formattedthe name associated with a remote objectof the binding to remove @exceptionthrows NotBoundException if name is not currently bound @exception MalformedURLExceptionthrows RemoteException if the nameremote is not an appropriatelycommunication with the registry formattedfailed; URLif @exception RemoteException ifis a registryServerException could notcontaining an beAccessException contactedthen @exceptionthe AccessException if this operation isregistry denies the caller access notto perform this permittedoperation (if originating from a non-local host for example) @sincethrows JDK1.1AccessException if this registry is local and it denies the caller access to perform this operation @throws NullPointerException if name is null

RegistryHandler is an interface used internally by the RMI runtime in previous implementation versions. It should never be accessed by application code. @version 1.10 0211 12/0203/0001 @author Ann Wollrath @since JDK1.1 @deprecated no replacement