org.sapia.ubik.rmi.server.transport.socket

Class SocketTransportProvider

java.lang.Object

org.sapia.ubik.rmi.server.transport.socket.SocketTransportProvider

All Implemented Interfaces:

TransportProvider

Direct Known Subclasses:

MultiplexSocketTransportProvider

public class SocketTransportProvider
extends Object
implements TransportProvider

Implements the TransportProvider interface over the standard java Socket class.

Author:

Yanick Duchesne

See Also:

Socket

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIND_ADDRESS This constant corresponds to the ubik.rmi.transport.socket.bind-address system property.
static String	CLIENT_FACTORY This constant corresponds to the ubik.rmi.transport.socket.client-factory system property (it identifies the ConnectionFactory to use to create client-side connections).
protected static long	DEFAULT_RESET_INTERVAL
static String	MAX_THREADS This constant corresponds to the ubik.rmi.transport.socket.max-threads system property.
static String	PORT This constant corresponds to the ubik.rmi.transport.socket.port system property.
static String	SERVER_FACTORY This constant corresponds to the ubik.rmi.transport.socket.server-factory system property.
static String	SOCKET_TRANSPORT_TYPE Constant corresponding to this provider class' transport type.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SocketTransportProvider()
protected	SocketTransportProvider(String transportType)

Method Summary

Methods

Modifier and Type	Method and Description
protected Server	doNewServer(int port, Props props)
Connections	getPoolFor(ServerAddress address) Returns a client connection pool to the given server address.
String	getTransportType() Returns this instance's "transport type".
Server	newDefaultServer() This method is called by Ubik RMI's runtime when a server is needed on the client side to recieve asynchronous responses (i.e.: callbacks).
Server	newServer(int port)
Server	newServer(Properties props) Returns a server implementation.
void	shutdown() Shuts down this provider.

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_TRANSPORT_TYPE

public static final String SOCKET_TRANSPORT_TYPE

Constant corresponding to this provider class' transport type.

See Also:

Constant Field Values

MAX_THREADS

public static final String MAX_THREADS

This constant corresponds to the ubik.rmi.transport.socket.max-threads system property.

See Also:

Constant Field Values

CLIENT_FACTORY

public static final String CLIENT_FACTORY

This constant corresponds to the ubik.rmi.transport.socket.client-factory system property (it identifies the ConnectionFactory to use to create client-side connections).

See Also:

Constant Field Values

SERVER_FACTORY

public static final String SERVER_FACTORY

This constant corresponds to the ubik.rmi.transport.socket.server-factory system property. It identifies the UbikServerSocketFactory implementation to use.

See Also:

Constant Field Values

BIND_ADDRESS

public static final String BIND_ADDRESS

This constant corresponds to the ubik.rmi.transport.socket.bind-address system property.

See Also:

Constant Field Values

PORT

public static final String PORT

This constant corresponds to the ubik.rmi.transport.socket.port system property.

See Also:

Constant Field Values

DEFAULT_RESET_INTERVAL

protected static final long DEFAULT_RESET_INTERVAL

See Also:

Constant Field Values

Constructor Detail

SocketTransportProvider

protected SocketTransportProvider(String transportType)

SocketTransportProvider

public SocketTransportProvider()

Method Detail

getPoolFor

public Connections getPoolFor(ServerAddress address)
                       throws RemoteException

Description copied from interface: TransportProvider

Returns a client connection pool to the given server address.

Specified by:

getPoolFor in interface TransportProvider

Parameters:

address - a ServerAddress.

Returns:

a ConnectionOptionsException.

Throws:

RemoteException - if a problem occurs creating the connection.

See Also:

TransportProvider.getPoolFor(ServerAddress)

newServer

public Server newServer(Properties props)
                 throws RemoteException

Description copied from interface: TransportProvider

Returns a server implementation.

Specified by:

newServer in interface TransportProvider

Parameters:

props - the Properties used to create the server.

Returns:

a Server instance.

Throws:

RemoteException

See Also:

TransportProvider.newServer(Properties)

newDefaultServer

public Server newDefaultServer()
                        throws RemoteException

Description copied from interface: TransportProvider

This method is called by Ubik RMI's runtime when a server is needed on the client side to recieve asynchronous responses (i.e.: callbacks). Implementations must in this case provide a "default" Server instance.

Specified by:

newDefaultServer in interface TransportProvider

Returns:

a Server.

Throws:

RemoteException

See Also:

TransportProvider.newDefaultServer()

newServer

public Server newServer(int port)
                 throws RemoteException

Throws:

RemoteException

doNewServer

protected Server doNewServer(int port,
                 Props props)
                      throws RemoteException

Throws:

RemoteException

getTransportType

public String getTransportType()

Description copied from interface: TransportProvider

Returns this instance's "transport type".

Specified by:

getTransportType in interface TransportProvider

Returns:

a transport type.

See Also:

TransportProvider.getTransportType()

shutdown

public void shutdown()

Description copied from interface: TransportProvider

Shuts down this provider.

Specified by:

shutdown in interface TransportProvider

See Also:

TransportProvider.shutdown()