Module org.newsclub.net.unix.rmi

Package org.newsclub.net.unix.rmi

Class AFUNIXNaming

java.lang.Object

org.newsclub.net.unix.rmi.AFNaming

org.newsclub.net.unix.rmi.AFUNIXNaming

public final class AFUNIXNaming
extends AFNaming

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

Author:

Christian Kohlschütter

Method Summary

Modifier and Type	Method	Description
void	bind(String name, Remote obj)	Convenience method for getRegistry().bind.
AFUNIXRegistry	createRegistry()	Creates a new RMI Registry.
static File	getDefaultSocketDirectory()	Returns the directory where RMI sockets are stored by default.
static AFUNIXNaming	getInstance()	Returns the default instance of AFUNIXNaming.
static AFUNIXNaming	getInstance(File socketDir)	Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory.
static AFUNIXNaming	getInstance(File socketDir, int registryPort)	Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory.
static AFUNIXNaming	getInstance(File socketDir, int registryPort, String socketPrefix, String socketSuffix)	Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory.
AFRegistry	getRegistry()	Returns a reference to the existing RMI registry.
AFUNIXRegistry	getRegistry(boolean create)	Returns a reference to the RMI registry, or null.
AFUNIXRegistry	getRegistry(long timeout, TimeUnit unit)	Returns a reference to the existing RMI registry.
File	getRegistrySocketDir()	Returns the directory in which sockets used by this registry are located.
File	getRegistrySocketFile()	Returns the socket file which is used to control the RMI registry.
static AFNaming	getSingleFileInstance(File socketFile)	Returns an AFUNIXNaming instance which only supports one file.
AFUNIXRMISocketFactory	getSocketFactory()	Returns the AFRMISocketFactory associated with this instance.
protected void	initRegistryPrerequisites()	Called by AFNaming.createRegistry() right before creating/setting the registry.
protected AFUNIXRMISocketFactory	initSocketFactory()	Creates or returns the AFRMISocketFactory to be used with this instance.
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 AFUNIXRegistry	newAFRegistry(Registry impl)	Creates a new AFRegistry given a Registry implementation.
static AFUNIXNaming	newPrivateInstance()	Returns a new private instance that resides in a custom location, to avoid any collisions with existing instances.
protected 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.
protected void	shutdownRegistryFinishingTouches()	Called by AFNaming.shutdownRegistry() as the final step.
void	unbind(String name)	Convenience method for getRegistry().unbind.

Methods inherited from class org.newsclub.net.unix.rmi.AFNaming

exportAndBind, exportAndRebind, exportObject, getRegistryPort, isRemoteShutdownAllowed, setRemoteShutdownAllowed, shutdownRegistry, unexportAndUnbind, unexportObject

Methods inherited from class java.lang.Object

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

Method Details

getDefaultSocketDirectory

public static File getDefaultSocketDirectory()

Returns the directory where RMI sockets are stored by default. You can configure this location by setting the System property org.newsclub.net.unix.rmi.socketdir upon start.

Returns:

The directory.

newPrivateInstance

public static AFUNIXNaming newPrivateInstance()
                                       throws IOException

Returns a new private instance that resides in a custom location, to avoid any collisions with existing instances.

Returns:

The private AFNaming instance.

Throws:

IOException - if the operation fails.

getInstance

public static AFUNIXNaming getInstance()
                                throws IOException

Returns the default instance of AFUNIXNaming. Sockets are stored in java.io.tmpdir.

Returns:

The default instance.

Throws:

IOException - if the operation fails.

getInstance

public static AFUNIXNaming getInstance(File socketDir)
                                throws RemoteException

Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory.

Parameters:

socketDir - The directory to store sockets in.

Returns:

The instance.

Throws:

RemoteException - if the operation fails.

getInstance

public static AFUNIXNaming getInstance(File socketDir,
 int registryPort)
                                throws RemoteException

Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory. A custom "registry port" can be specified. Typically, AF-UNIX specific ports should be above 100000.

Parameters:

socketDir - The directory to store sockets in.

registryPort - The registry port. Should be above 100000.

Returns:

The instance.

Throws:

RemoteException - if the operation fails.

getInstance

public static AFUNIXNaming getInstance(File socketDir,
 int registryPort,
 String socketPrefix,
 String socketSuffix)
                                throws RemoteException

Returns a AFUNIXNaming instance which support several socket files that can be stored under the same, given directory. A custom "registry port" can be specified. Typically, AF-UNIX specific ports should be above 100000.

Parameters:

socketDir - The directory to store sockets in.

registryPort - The registry port. Should be above 100000.

socketPrefix - A string to be inserted at the beginning of each socket filename, or null.

socketSuffix - A string to be added at the end of each socket filename, or null.

Returns:

The instance.

Throws:

RemoteException - if the operation fails.

getSingleFileInstance

public static AFNaming getSingleFileInstance(File socketFile)
                                      throws IOException

Returns an AFUNIXNaming instance which only supports one file. (Probably only useful when you want/can access the exported UnicastRemoteObject directly)

Parameters:

socketFile - The socket file.

Returns:

The instance.

Throws:

IOException - if the operation fails.

getSocketFactory

public AFUNIXRMISocketFactory getSocketFactory()

Description copied from class: AFNaming

Returns the AFRMISocketFactory associated with this instance.

Overrides:

getSocketFactory in class AFNaming

Returns:

The AFRMISocketFactory.

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.

Overrides:

getRegistry in class AFNaming

Returns:

The registry.

Throws:

RemoteException - If there was a problem.

getRegistry

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

Description copied from class: AFNaming

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.

Overrides:

getRegistry in class AFNaming

Parameters:

timeout - The timeout value.

unit - The timeout unit.

Returns:

The registry.

Throws:

RemoteException - If there was a problem.

getRegistry

public AFUNIXRegistry getRegistry(boolean create)
                           throws RemoteException

Description copied from class: AFNaming

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.

Overrides:

getRegistry in class AFNaming

Parameters:

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

Returns:

The registry, or null

Throws:

RemoteException - If there was a problem.

createRegistry

public AFUNIXRegistry createRegistry()
                              throws RemoteException

Description copied from class: AFNaming

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

Overrides:

createRegistry in class AFNaming

Returns:

The registry

Throws:

RemoteException - if the operation fails.

See Also:

• AFNaming.getRegistry()

getRegistrySocketFile

public File getRegistrySocketFile()

Returns the socket file which is used to control the RMI registry. The file is usually in the directory returned by getRegistrySocketDir().

Returns:

The directory.

initSocketFactory

protected AFUNIXRMISocketFactory initSocketFactory()
                                            throws IOException

Description copied from class: AFNaming

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

Specified by:

initSocketFactory in class AFNaming

Returns:

The socket factory.

Throws:

IOException - on error.

newAFRegistry

protected AFUNIXRegistry newAFRegistry(Registry impl)
                                throws RemoteException

Description copied from class: AFNaming

Creates a new AFRegistry given a Registry implementation.

Specified by:

newAFRegistry in class AFNaming

Parameters:

impl - The implementation.

Returns:

The new AFRegistry instance.

Throws:

RemoteException - on error.

openRegistry

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

Description copied from class: AFNaming

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

Specified by:

openRegistry in class AFNaming

Parameters:

timeout - The timeout.

unit - The unit for the timeout.

Returns:

The registry instance.

Throws:

RemoteException - on error.

shutdownRegistryFinishingTouches

protected void shutdownRegistryFinishingTouches()

Description copied from class: AFNaming

Called by AFNaming.shutdownRegistry() as the final step.

Specified by:

shutdownRegistryFinishingTouches in class AFNaming

getRegistrySocketDir

public File getRegistrySocketDir()

Returns the directory in which sockets used by this registry are located.

Returns:

The directory.

initRegistryPrerequisites

protected void initRegistryPrerequisites()
                                  throws ServerException

Description copied from class: AFNaming

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

Specified by:

initRegistryPrerequisites in class AFNaming

Throws:

ServerException - on error.

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