Module org.newsclub.net.unix.rmi

Package org.newsclub.net.unix.rmi

Class AFRMISocketFactory

java.lang.Object

java.rmi.server.RMISocketFactory

org.newsclub.net.unix.rmi.AFRMISocketFactory

All Implemented Interfaces:

Closeable, Externalizable, Serializable, AutoCloseable, RMIClientSocketFactory, RMIServerSocketFactory

Direct Known Subclasses:

AFUNIXRMISocketFactory

public abstract class AFRMISocketFactory
extends RMISocketFactory
implements Externalizable, Closeable

An RMISocketFactory that supports AFSockets.

Author:

Christian Kohlschütter

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	AFRMISocketFactory.PortLease	A lease on a registered port; closing the lease will return the port.

Constructor Summary

Constructors

Constructor	Description
AFRMISocketFactory()	Constructor required per definition.
AFRMISocketFactory(AFNaming naming, RMIClientSocketFactory defaultClientFactory, RMIServerSocketFactory defaultServerFactory)	Creates a new socket factory.

Method Summary

Modifier and Type	Method	Description
void	close()
ServerSocket	createServerSocket(int port)
Socket	createSocket(String host, int port)
protected AFNaming	getNaming()	The naming instance.
boolean	isLocalServer(int port)	Checks if the given port refers to a local server port.
protected abstract org.newsclub.net.unix.AFSocket<?>	newConnectedSocket(org.newsclub.net.unix.AFSocketAddress addr)	Creates a new socket that is connected to the given socket address.
protected int	newPort()	Deprecated. use newPortLease().
protected AFRMISocketFactory.PortLease	newPortLease()	Returns a new free port.
protected abstract org.newsclub.net.unix.AFSocketAddress	newSocketAddress(int port)	Creates a new socket address for the given RMI port.
void	readExternal(ObjectInput in)
protected abstract AFNaming	readNamingInstance(ObjectInput in)	Deserializes information necessary to instantiate the AFNaming instance.
protected void	returnPort(int port)	Deprecated. use newPortLease()
void	writeExternal(ObjectOutput out)
protected abstract void	writeNamingInstance(ObjectOutput out, AFNaming namingInstance)	Serializes information necessary to instantiate the given AFNaming instance.

Methods inherited from class java.rmi.server.RMISocketFactory

getDefaultSocketFactory, getFailureHandler, getSocketFactory, setFailureHandler, setSocketFactory

Methods inherited from class java.lang.Object

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

Constructor Details

AFRMISocketFactory

public AFRMISocketFactory()

Constructor required per definition.

See Also:

• RMISocketFactory

AFRMISocketFactory

public AFRMISocketFactory(AFNaming naming,
 RMIClientSocketFactory defaultClientFactory,
 RMIServerSocketFactory defaultServerFactory)

Creates a new socket factory.

Parameters:

naming - The AFNaming instance to use.

defaultClientFactory - The default RMIClientSocketFactory.

defaultServerFactory - The default RMIServerSocketFactory.

Method Details

newSocketAddress

protected abstract org.newsclub.net.unix.AFSocketAddress newSocketAddress(int port)
                                                                   throws IOException

Creates a new socket address for the given RMI port.

Parameters:

port - The port.

Returns:

The socket address.

Throws:

IOException - on error.

newConnectedSocket

protected abstract org.newsclub.net.unix.AFSocket<?> newConnectedSocket(org.newsclub.net.unix.AFSocketAddress addr)
                                                                 throws IOException

Creates a new socket that is connected to the given socket address.

Parameters:

addr - The socket address.

Returns:

The connected socket.

Throws:

IOException - on error.

createSocket

public Socket createSocket(String host,
 int port)
                    throws IOException

Specified by:

createSocket in interface RMIClientSocketFactory

Specified by:

createSocket in class RMISocketFactory

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

newPort

@Deprecated
protected int newPort()
               throws IOException

Deprecated.

use newPortLease().

Returns a new free port.

Returns:

The new port.

Throws:

IOException - on error.

See Also:

• returnPort(int)

newPortLease

protected AFRMISocketFactory.PortLease newPortLease()
                                             throws IOException

Returns a new free port.

Returns:

The new port, wrapped as a AFRMISocketFactory.PortLease. Closing the lease will return the port.

Throws:

IOException - on error.

returnPort

@Deprecated
protected void returnPort(int port)
                   throws IOException

Deprecated.

use newPortLease()

Returns a port that was previously returned by newPort(). Note that this may call may stall unnecessarily upon shutdown due to locking issues.

Parameters:

port - The port to return.

Throws:

IOException - on error.

createServerSocket

public ServerSocket createServerSocket(int port)
                                throws IOException

Specified by:

createServerSocket in interface RMIServerSocketFactory

Specified by:

createServerSocket in class RMISocketFactory

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readNamingInstance

protected abstract AFNaming readNamingInstance(ObjectInput in)
                                        throws IOException

Deserializes information necessary to instantiate the AFNaming instance.

Parameters:

in - The stream.

Returns:

The AFNaming instance.

Throws:

IOException - on error.

writeNamingInstance

protected abstract void writeNamingInstance(ObjectOutput out,
 AFNaming namingInstance)
                                     throws IOException

Serializes information necessary to instantiate the given AFNaming instance.

Parameters:

out - The stream.

namingInstance - The AFNaming instance.

Throws:

IOException - on error.

isLocalServer

public boolean isLocalServer(int port)

Checks if the given port refers to a local server port.

Parameters:

port - The port to check.

Returns:

true if the given port is a local server.

getNaming

protected AFNaming getNaming()

The naming instance.

Returns:

The instance.