org.sapia.ubik.rmi.server

Class Hub

java.lang.Object

org.sapia.ubik.rmi.server.Hub

public class Hub
extends Object

This class is the single-entry point into Ubik RMI's API.

Author:

Yanick Duchesne

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TRANSPORT_TYPE

Constructor Summary

Constructors

Constructor and Description
Hub()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	connect(ServerAddress address) This method allows connecting to a RMI server listening on the given address.
static Object	connect(String host, int port) This method allows connecting to a RMI server listening to the given host and port.
static Object	exportObject(Object o) "Exports" the passed in object as a remote RMI server: this method internally starts an RMI server that listens on a random port and implements the interfaces of the passed in object.
static Object	exportObject(Object o, int port) This method creates a server listening on the specified port.
static Object	exportObject(Object object, Properties props) Exports the given object as a server (and creates a remote reference).
static Object	exportObject(Object object, String transportType) Exports the given object as a remote object that will receive request through a server that must already have been exported for the given transport type.
static Modules	getModules()
static ServerAddress	getServerAddressFor(String transportType) Returns the address of the server for the given transport type.
static boolean	isShutdown() Returns true if the Hub is shut down.
static void	refresh(ServerAddress address) Forces the clearing of the connection pool corresponding to the given address.
static void	shutdown() Shuts down this instance.
static void	shutdown(long timeout) Shuts down this instance; some part of the shutdown can be asynchronous.
static void	unexport(ClassLoader loader) This method "unexports" all objects whose class was loaded by the given ClassLoader.
static void	unexport(Object o) This method "unexports" an object that was exported through one of this class' export() methods.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TRANSPORT_TYPE

public static final String DEFAULT_TRANSPORT_TYPE

See Also:

Constant Field Values

Constructor Detail

Hub

public Hub()

Method Detail

exportObject

public static Object exportObject(Object o)
                           throws RemoteException

"Exports" the passed in object as a remote RMI server: this method internally starts an RMI server that listens on a random port and implements the interfaces of the passed in object. The stub is returned and can be bound to the JNDI.

Returns:

the stub corresponding to the exported object.

Throws:

RemoteException - if a problem occurs performing the connection.

See Also:

exportObject(Object, int), connect(String, int)

exportObject

public static Object exportObject(Object o,
                  int port)
                           throws RemoteException

This method creates a server listening on the specified port.

Returns:

the stub for the given exported object.

Throws:

RemoteException - if a problem occurs performing the connection.

See Also:

exportObject(Object)

exportObject

public static Object exportObject(Object object,
                  Properties props)
                           throws RemoteException

Exports the given object as a server (and creates a remote reference). The properties passed in must contain the property identifying the desired "transport type" (ubik.rmi.transport.type).

The method returns the stub for the given object.

Parameters:

object - the Object to export.

props - the transport provider Properties.

Returns:

the stub of the exported server.

Throws:

RemoteException

See Also:

TransportManager, TransportManager.getProviderFor(String), TransportProvider

exportObject

public static Object exportObject(Object object,
                  String transportType)
                           throws RemoteException

Exports the given object as a remote object that will receive request through a server that must already have been exported for the given transport type.

The method returns the stub for the given object.

Parameters:

object - an Object to export.

transportType - the identifier of the transport layer to which the given object will be exported.

Returns:

a stub.

Throws:

RemoteException - if the object could not be exported.

unexport

public static void unexport(Object o)

This method "unexports" an object that was exported through one of this class' export() methods. The unexported object will not receive remote method calls anymore.

NOTE: this method does not stop the server through which the exported instance is receiving remote method calls. To stop the servers that have been started by this class, call the latter's shutdown() method.

Parameters:

o - the exported object that is to be unexported.

See Also:

shutdown(long)

unexport

public static void unexport(ClassLoader loader)

This method "unexports" all objects whose class was loaded by the given ClassLoader.

This method can be useful in hot-deploy scenarios.

NOTE: this method does not stop the server through which the exported instances (that correspond to the given classloader) are receiving remote method calls. To stop the servers that have been started by the Hub, call the latter's shutdown method.

Parameters:

loader -

See Also:

shutdown(long)

connect

public static Object connect(String host,
             int port)
                      throws RemoteException

This method allows connecting to a RMI server listening to the given host and port.

Throws:

RemoteException - if a problem occurs performing the connection.

connect

public static Object connect(ServerAddress address)
                      throws RemoteException

This method allows connecting to a RMI server listening on the given address.

Parameters:

address - the ServerAddress corresponding to the target server's physical endpoint.

Throws:

RemoteException - if a problem occurs performing the connection.

refresh

public static void refresh(ServerAddress address)

Forces the clearing of the connection pool corresponding to the given address.

Parameters:

address - a ServerAddress

See Also:

Connections.clear()

getServerAddressFor

public static ServerAddress getServerAddressFor(String transportType)

Returns the address of the server for the given transport type.

Parameters:

transportType - the logical identifier of a "transport type".

Returns:

a ServerAddress,

isShutdown

public static boolean isShutdown()

Returns true if the Hub is shut down.

Returns:

true if the Hub is shut down.

shutdown

public static void shutdown()

Shuts down this instance. The calling thread will wait a builtin maximum of seconds for the shutdown to be completed - after which it will return.

shutdown

public static void shutdown(long timeout)
                     throws InterruptedException

Shuts down this instance; some part of the shutdown can be asynchronous. A timeout must be given in order not to risk the shutdown to last for too long.

Parameters:

timeout - a shutdown "timeout", in millis.

Throws:

InterruptedException

getModules

public static Modules getModules()

Returns:

this class' Modules.