Module org.newsclub.net.unix.rmi

Package org.newsclub.net.unix.rmi

Class AFNaming

java.lang.Object

org.newsclub.net.unix.rmi.AFNaming

Direct Known Subclasses:

AFUNIXNaming

public abstract class AFNaming
extends Object

The AFSocket-compatible equivalent of Naming. Use this class for accessing RMI registries that are reachable by AFSockets.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFNaming(int registryPort, int servicePort)	Creates a new naming instance with the given ports.

Method Summary

Modifier and Type	Method	Description
void	bind(String name, Remote obj)	Convenience method for getRegistry().bind.
AFRegistry	createRegistry()	Creates a new RMI Registry.
void	exportAndBind(String name, Remote obj)	Exports and binds the given Remote object to the given name, using the given AFNaming setup.
void	exportAndRebind(String name, Remote obj)	Exports and re-binds the given Remote object to the given name, using the given AFNaming setup.
static Remote	exportObject(Remote obj, RMISocketFactory socketFactory)	Exports the given Remote object, using the given socket factory and a randomly assigned port.
AFRegistry	getRegistry()	Returns a reference to the existing RMI registry.
AFRegistry	getRegistry(boolean create)	Returns a reference to the RMI registry, or null.
AFRegistry	getRegistry(long timeout, TimeUnit unit)	Returns a reference to the existing RMI registry.
final int	getRegistryPort()	Returns the registry port.
AFRMISocketFactory	getSocketFactory()	Returns the AFRMISocketFactory associated with this instance.
protected abstract void	initRegistryPrerequisites()	Called by createRegistry() right before creating/setting the registry.
protected abstract AFRMISocketFactory	initSocketFactory()	Creates or returns the AFRMISocketFactory to be used with this instance.
boolean	isRemoteShutdownAllowed()	Checks if this AFNaming instance can be shut down remotely.
String[]	list()	Convenience method for getRegistry().list.
Remote	lookup(String name)	Convenience method for getRegistry().lookup.
Remote	lookup(String name, long timeout, TimeUnit unit)	Convenience method for getRegistry().lookup.
protected abstract AFRegistry	newAFRegistry(Registry impl)	Creates a new AFRegistry given a Registry implementation.
protected abstract AFRegistry	openRegistry(long timeout, TimeUnit unit)	Tries to access the registry, waiting some time if necessary.
void	rebind(String name, Remote obj)	Convenience method for getRegistry().rebind.
void	setRemoteShutdownAllowed(boolean remoteShutdownAllowed)	Controls whether this AFNaming instance can be shut down remotely.
void	shutdownRegistry()	Shuts this RMI Registry down.
protected abstract void	shutdownRegistryFinishingTouches()	Called by shutdownRegistry() as the final step.
void	unbind(String name)	Convenience method for getRegistry().unbind.
void	unexportAndUnbind(String name, Remote obj)	Forcibly un-exports the given object, if it exists, and unbinds the object from the registry (otherwise returns without an error).
static void	unexportObject(Remote obj)	Forcibly un-exports the given object, if it exists (otherwise returns without an error).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AFNaming

protected AFNaming(int registryPort,
 int servicePort)

Creates a new naming instance with the given ports.

Parameters:

registryPort - The registry port.

servicePort - The port for AFRMIService.

Method Details

newAFRegistry

protected abstract AFRegistry newAFRegistry(Registry impl)
                                     throws RemoteException

Creates a new AFRegistry given a Registry implementation.

Parameters:

impl - The implementation.

Returns:

The new AFRegistry instance.

Throws:

RemoteException - on error.

initSocketFactory

protected abstract AFRMISocketFactory initSocketFactory()
                                                 throws IOException

Creates or returns the AFRMISocketFactory to be used with this instance.

Returns:

The socket factory.

Throws:

IOException - on error.

getSocketFactory

public AFRMISocketFactory getSocketFactory()

Returns the AFRMISocketFactory associated with this instance.

Returns:

The AFRMISocketFactory.

getRegistryPort

public final int getRegistryPort()

Returns the registry port.

Returns:

The port.

getRegistry

public AFRegistry getRegistry()
                       throws RemoteException

Returns a reference to the existing RMI registry. If there's no registry running at this port, an exception is thrown.

Returns:

The registry.

Throws:

RemoteException - If there was a problem.

getRegistry

public AFRegistry getRegistry(long timeout,
 TimeUnit unit)
                       throws RemoteException

Returns a reference to the existing RMI registry. If there's no registry running at this port after waiting for up to the given time, an exception is thrown.

Parameters:

timeout - The timeout value.

unit - The timeout unit.

Returns:

The registry.

Throws:

RemoteException - If there was a problem.

openRegistry

protected abstract AFRegistry openRegistry(long timeout,
 TimeUnit unit)
                                    throws RemoteException

Tries to access the registry, waiting some time if necessary.

Parameters:

timeout - The timeout.

unit - The unit for the timeout.

Returns:

The registry instance.

Throws:

RemoteException - on error.

getRegistry

public AFRegistry getRegistry(boolean create)
                       throws RemoteException

Returns a reference to the RMI registry, or null. If there's no registry running at this port, and create is set to true, a new one is created; when create is set to false, null is returned.

Parameters:

create - true if a new register may be created if necessary.

Returns:

The registry, or null

Throws:

RemoteException - If there was a problem.

shutdownRegistry

public void shutdownRegistry()
                      throws RemoteException

Shuts this RMI Registry down.

Throws:

RemoteException - if the operation fails.

shutdownRegistryFinishingTouches

protected abstract void shutdownRegistryFinishingTouches()

Called by shutdownRegistry() as the final step.

createRegistry

public AFRegistry createRegistry()
                          throws RemoteException

Creates a new RMI Registry. If there already was a registry created previously, it is shut down and replaced by the current one. Use getRegistry() to try to reuse an existing registry.

Returns:

The registry

Throws:

RemoteException - if the operation fails.

See Also:

• getRegistry()

initRegistryPrerequisites

protected abstract void initRegistryPrerequisites()
                                           throws ServerException

Called by createRegistry() right before creating/setting the registry.

Throws:

ServerException - on error.

isRemoteShutdownAllowed

public boolean isRemoteShutdownAllowed()

Checks if this AFNaming instance can be shut down remotely.

Returns:

true if remote shutdown is allowed.

setRemoteShutdownAllowed

public void setRemoteShutdownAllowed(boolean remoteShutdownAllowed)

Controls whether this AFNaming instance can be shut down remotely.

Parameters:

remoteShutdownAllowed - true if remote shutdown is allowed.

exportAndBind

public void exportAndBind(String name,
 Remote obj)
                   throws RemoteException,
AlreadyBoundException

Exports and binds the given Remote object to the given name, using the given AFNaming setup.

Parameters:

name - The name to use to bind the object in the registry.

obj - The object to export and bind.

Throws:

RemoteException - if the operation fails.

AlreadyBoundException - if there already was something bound at that name

exportAndRebind

public void exportAndRebind(String name,
 Remote obj)
                     throws RemoteException

Exports and re-binds the given Remote object to the given name, using the given AFNaming setup.

Parameters:

name - The name to use to bind the object in the registry.

obj - The object to export and bind.

Throws:

RemoteException - if the operation fails.

unexportAndUnbind

public void unexportAndUnbind(String name,
 Remote obj)
                       throws RemoteException

Forcibly un-exports the given object, if it exists, and unbinds the object from the registry (otherwise returns without an error).

Parameters:

name - The name used to bind the object.

obj - The object to un-export.

Throws:

RemoteException - if the operation fails.

exportObject

public static Remote exportObject(Remote obj,
 RMISocketFactory socketFactory)
                           throws RemoteException

Exports the given Remote object, using the given socket factory and a randomly assigned port. NOTE: This helper function can also be used for regular RMI servers.

Parameters:

obj - The object to export.

socketFactory - The socket factory to use.

Returns:

The remote stub.

Throws:

RemoteException - if the operation fails.

unexportObject

public static void unexportObject(Remote obj)

Forcibly un-exports the given object, if it exists (otherwise returns without an error). This should be called upon closing a Closeable Remote object. NOTE: This helper function can also be used for regular RMI servers.

Parameters:

obj - The object to un-export.

lookup

public Remote lookup(String name)
              throws NotBoundException,
MalformedURLException,
RemoteException

Convenience method for getRegistry().lookup.

Parameters:

name - the name for the remote reference to look up

Returns:

The instance

Throws:

NotBoundException - upon error

MalformedURLException - upon error

RemoteException - upon error

See Also:

• AFRegistry.lookup(String)

lookup

public Remote lookup(String name,
 long timeout,
 TimeUnit unit)
              throws NotBoundException,
MalformedURLException,
RemoteException

Convenience method for getRegistry().lookup.

Parameters:

name - the name for the remote reference to look up

timeout - The timeout value.

unit - The timeout unit.

Returns:

The instance

Throws:

NotBoundException - upon error

MalformedURLException - upon error

RemoteException - upon error

See Also:

• AFRegistry.lookup(String, long, TimeUnit)

unbind

public void unbind(String name)
            throws RemoteException,
NotBoundException,
MalformedURLException

Convenience method for getRegistry().unbind.

Parameters:

name - the name for the remote reference to unbind

Throws:

RemoteException - upon error

NotBoundException - upon error

MalformedURLException - upon error

See Also:

• AFRegistry.unbind(String)

bind

public void bind(String name,
 Remote obj)
          throws AlreadyBoundException,
MalformedURLException,
RemoteException

Convenience method for getRegistry().bind.

Parameters:

name - the name for the remote reference to bind

obj - the remote reference to bind

Throws:

RemoteException - upon error

AlreadyBoundException - upon error

MalformedURLException - upon error

See Also:

• AFRegistry.bind(String, Remote)

rebind

public void rebind(String name,
 Remote obj)
            throws MalformedURLException,
RemoteException

Convenience method for getRegistry().rebind.

Parameters:

name - the name for the remote reference to rebind

obj - the remote reference to rebind

Throws:

RemoteException - upon error

MalformedURLException - upon error

See Also:

• AFRegistry.rebind(String, Remote)

list

public String[] list()
              throws RemoteException,
AccessException

Convenience method for getRegistry().list. Unlike AFRegistry.list(), in case the registry has been shut down already, an empty array is returned.

Returns:

an array of the names bound in this registry

Throws:

RemoteException - upon error

AccessException - upon error