org.transitime.ipc.rmi

Class ClientFactory<T extends java.rmi.Remote>

java.lang.Object

org.transitime.ipc.rmi.ClientFactory<T>

public class ClientFactory<T extends java.rmi.Remote>
extends java.lang.Object

For clients to access RMI based method calls for a remote object simply need to call something like: Hello hello = ClientFactory.getInstance(agencyId, Hello.class);

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
ClientFactory()

Method Summary

Modifier and Type	Method and Description
static <T extends java.rmi.Remote> T	getInstance(java.lang.String agencyId, java.lang.Class<T> clazz) This serves as a factory class For a Remote object.
static <T extends java.rmi.Remote> T	getRmiStub(RmiStubInfo info, boolean updateHostName) Creates an RMI stub based on the project name, host name, and class name.
static int	getTimeoutSec() Returns the timeout time.
static void	main(java.lang.String[] args) Just for debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientFactory

public ClientFactory()

Method Detail

getInstance

public static <T extends java.rmi.Remote> T getInstance(java.lang.String agencyId,
                                                        java.lang.Class<T> clazz)

This serves as a factory class For a Remote object. It is expected that a new instance is created every time getInstance() is called. This is reasonable because usually will only be creating a single such object and if there are a few that is fine as well since they are not that expensive.

Parameters:

host - Where remote object lives

agencyId - For creating bind name for remote object

clazz - Because this is a static method the only way to get the class name is to pass in the class.

Returns:

Proxy to the RMI object on the server. If there is a problem accessing the object then null is returned.

getRmiStub

public static <T extends java.rmi.Remote> T getRmiStub(RmiStubInfo info,
                                                       boolean updateHostName)
                                                throws java.rmi.RemoteException,
                                                       java.rmi.NotBoundException

Creates an RMI stub based on the project name, host name, and class name. An RMI stub is a remote reference to an object.

Parameters:

info - Species the agency ID and the host name

updateHostName - Indicates whether should update host name instead of just getting old values from cache. Should update if there is a problem in invoking an RMI call since perhaps the server for an agency was moved to a new hostname. But when first creating a client factory don't want to access db so should just use cached value.

Returns:

The RMI stub for the remote object

Throws:

java.rmi.RemoteException

java.rmi.NotBoundException

getTimeoutSec

public static int getTimeoutSec()

Returns the timeout time. Useful for error messages.

Returns:

Timeout time in seconds

main

public static void main(java.lang.String[] args)

Just for debugging.

Parameters:

args -