APIdia Launch Partner
Top Description Constructors Methods
java.rmi.registry

public final Class LocateRegistry

extends Object
Class Inheritance
Imports
java.rmi.RemoteException, java.rmi.server.ObjID, .RMIClientSocketFactory, .RMIServerSocketFactory, .RemoteRef, .UnicastRemoteObject, sun.rmi.registry.RegistryImpl, sun.rmi.server.UnicastRef2, .UnicastRef, .Util, sun.rmi.transport.LiveRef, sun.rmi.transport.tcp.TCPEndpoint
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.

Authors
Ann Wollrath, Peter Jones
Since
1.1
See Also
java.rmi.registry.Registry

Constructor Summary

AccessConstructor and Description
private
LocateRegistry()

Private constructor to disable public construction.

Method Summary

Modifier and TypeMethod and Description
public static Registry

Returns:

the registry
createRegistry(int
the port on which the registry accepts requests
port)

Creates and exports a Registry instance on the local host that accepts requests on the specified port.

public static Registry

Returns:

the registry
createRegistry(int
port on which the registry accepts requests
port, RMIClientSocketFactory
client-side Socket factory used to make connections to the registry
csf, RMIServerSocketFactory
server-side ServerSocket factory used to accept connections to the registry
ssf)

Creates and exports a Registry instance on the local host that uses custom socket factories for communication with that instance.

public static Registry

Returns:

reference (a stub) to the remote object registry
getRegistry()

Returns a reference to the remote object Registry for the local host on the default registry port of 1099.

public static Registry

Returns:

reference (a stub) to the remote object registry
getRegistry(int
port on which the registry accepts requests
port)

Returns a reference to the remote object Registry for the local host on the specified port.

public static Registry

Returns:

reference (a stub) to the remote object registry
getRegistry(String
host for the remote registry
host)

Returns a reference to the remote object Registry on the specified host on the default registry port of 1099.

public static Registry

Returns:

reference (a stub) to the remote object registry
getRegistry(String
host for the remote registry
host, int
port on which the registry accepts requests
port)

Returns a reference to the remote object Registry on the specified host and port.

public static Registry

Returns:

reference (a stub) to the remote registry
getRegistry(String
host for the remote registry
host, int
port on which the registry accepts requests
port, RMIClientSocketFactory
client-side Socket factory used to make connections to the registry. If csf is null, then the default client-side Socket factory will be used in the registry stub.
csf)

Returns a locally created remote reference to the remote object Registry on the specified host and port.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

LocateRegistryback to summary
private LocateRegistry()

Private constructor to disable public construction.

Method Detail

createRegistryback to summary
public static Registry createRegistry(int port) throws RemoteException

Creates and exports a Registry instance on the local host that accepts requests on the specified port.

The Registry instance is exported as if the static UnicastRemoteObject.exportObject method is invoked, passing the Registry instance and the specified port as arguments, except that the Registry instance is exported with a well-known object identifier, an ObjID instance constructed with the value ObjID#REGISTRY_ID.

Parameters
port:int

the port on which the registry accepts requests

Returns:Registry

the registry

Exceptions
RemoteException:
if the registry could not be exported
Since
1.1
createRegistryback to summary
public static Registry createRegistry(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException

Creates and exports a Registry instance on the local host that uses custom socket factories for communication with that instance. The registry that is created listens for incoming requests on the given port using a ServerSocket created from the supplied RMIServerSocketFactory.

The Registry instance is exported as if the static UnicastRemoteObject.exportObject method is invoked, passing the Registry instance, the specified port, the specified RMIClientSocketFactory, and the specified RMIServerSocketFactory as arguments, except that the Registry instance is exported with a well-known object identifier, an ObjID instance constructed with the value ObjID#REGISTRY_ID.

Parameters
port:int

port on which the registry accepts requests

csf:RMIClientSocketFactory

client-side Socket factory used to make connections to the registry

ssf:RMIServerSocketFactory

server-side ServerSocket factory used to accept connections to the registry

Returns:Registry

the registry

Exceptions
RemoteException:
if the registry could not be exported
Since
1.2
getRegistryback to summary
public static Registry getRegistry() throws RemoteException

Returns a reference to the remote object Registry for the local host on the default registry port of 1099.

Returns:Registry

reference (a stub) to the remote object registry

Exceptions
RemoteException:
if the reference could not be created
Since
1.1
getRegistryback to summary
public static Registry getRegistry(int port) throws RemoteException

Returns a reference to the remote object Registry for the local host on the specified port.

Parameters
port:int

port on which the registry accepts requests

Returns:Registry

reference (a stub) to the remote object registry

Exceptions
RemoteException:
if the reference could not be created
Since
1.1
getRegistryback to summary
public static Registry getRegistry(String host) throws RemoteException

Returns a reference to the remote object Registry on the specified host on the default registry port of 1099. If host is null, the local host is used.

Parameters
host:String

host for the remote registry

Returns:Registry

reference (a stub) to the remote object registry

Exceptions
RemoteException:
if the reference could not be created
Since
1.1
getRegistryback to summary
public static Registry getRegistry(String host, int port) throws RemoteException

Returns a reference to the remote object Registry on the specified host and port. If host is null, the local host is used.

Parameters
host:String

host for the remote registry

port:int

port on which the registry accepts requests

Returns:Registry

reference (a stub) to the remote object registry

Exceptions
RemoteException:
if the reference could not be created
Since
1.1
getRegistryback to summary
public static Registry getRegistry(String host, int port, RMIClientSocketFactory csf) throws RemoteException

Returns a locally created remote reference to the remote object Registry on the specified host and port. Communication with this remote registry will use the supplied RMIClientSocketFactory csf to create Socket connections to the registry on the remote host and port.

Parameters
host:String

host for the remote registry

port:int

port on which the registry accepts requests

csf:RMIClientSocketFactory

client-side Socket factory used to make connections to the registry. If csf is null, then the default client-side Socket factory will be used in the registry stub.

Returns:Registry

reference (a stub) to the remote registry

Exceptions
RemoteException:
if the reference could not be created
Since
1.2