org.sapia.ubik.rmi.server

Class ClientRuntime

java.lang.Object

org.sapia.ubik.rmi.server.ClientRuntime

All Implemented Interfaces:

Module

public class ClientRuntime
extends Object
implements Module

Implements part of Ubik's client-side logic.

Author:

Yanick Duchesne

Constructor Summary

Constructors

Constructor and Description
ClientRuntime()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterceptor(Class<?> eventClass, Interceptor it) Adds a client-side interceptor to this client.
void	createReference(ServerAddress address, OID oid) This method is meant to increase the reference count of a remote object, whose corresponding stub has reached the current JVM.
void	dispatchEvent(Event event) Dispatches the given event to registered interceptors.
ServerAddress	getCallbackAddress(String transportType) Returns this client's call-back server address (corresponds to the this client's singleton server, which will process incoming responses).
MultiDispatcher	getDispatcher()
ClientGC	getGc()
void	init(ModuleContext context) Called upon Ubik startup.
boolean	isCallback(String transportType) Returns true if this "client" is call-back enabled (if it itself is a server supporting responses from remote servers in the for of call-backs.
void	start(ModuleContext context) Called after #init(), when all modules have initialized.
void	stop() Called upon Ubik shutdown.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRuntime

public ClientRuntime()

Method Detail

init

public void init(ModuleContext context)

Description copied from interface: Module

Called upon Ubik startup. This method is called only once in this instance's lifetime.

Specified by:

init in interface Module

start

public void start(ModuleContext context)

Description copied from interface: Module

Called after #init(), when all modules have initialized.

Specified by:

start in interface Module

stop

public void stop()

Description copied from interface: Module

Called upon Ubik shutdown.

Specified by:

stop in interface Module

getDispatcher

public MultiDispatcher getDispatcher()

Returns:

this instance's MultiDispatcher.

See Also:

#dispatcher.

getGc

public ClientGC getGc()

Returns:

the ClientGC instance.

isCallback

public boolean isCallback(String transportType)

Returns true if this "client" is call-back enabled (if it itself is a server supporting responses from remote servers in the for of call-backs.

Returns:

true if this server supports call-back mode.

See Also:

Consts.CALLBACK_ENABLED

getCallbackAddress

public ServerAddress getCallbackAddress(String transportType)
                                 throws IllegalStateException

Returns this client's call-back server address (corresponds to the this client's singleton server, which will process incoming responses).

Parameters:

transportType - a the transport type for which to return the callback address.

Returns:

the ServerAddress corresponding to the given transport type, and that should be used as the callback address.

Throws:

IllegalStateException - if this client does not allow call-backs.

See Also:

Consts.CALLBACK_ENABLED

addInterceptor

public void addInterceptor(Class<?> eventClass,
                  Interceptor it)
                    throws InvalidInterceptorException

Adds a client-side interceptor to this client.

Throws:

InvalidInterceptorException

See Also:

Interceptor, MultiDispatcher.addInterceptor(Class, Interceptor)

dispatchEvent

public void dispatchEvent(Event event)

Dispatches the given event to registered interceptors.

See Also:

Interceptor, MultiDispatcher.addInterceptor(Class, Interceptor)

createReference

public void createReference(ServerAddress address,
                   OID oid)
                     throws RemoteException

This method is meant to increase the reference count of a remote object, whose corresponding stub has reached the current JVM.

Parameters:

address - the ServerAddress of the remote server to connect to.

oid - the OID for which to create a reference.

Throws:

RemoteException