com.crankuptheamps.client

Class TransportFactory

java.lang.Object

com.crankuptheamps.client.TransportFactory

public class TransportFactory
extends java.lang.Object

Factory class that allows you to register and unregister handler classes for various connection URI prefixes. Handler class is expected to create a transport when asked. Built-in transports such as "tcp" cannot be un-registered.

Constructor Summary

Constructors

Constructor and Description
TransportFactory()

Method Summary

Modifier and Type	Method and Description
static Transport	createTransport(java.lang.String name, Protocol messageType, java.util.Properties props) Creates a Transport using the parameters provided.
static void	register(java.lang.String name, java.lang.String className) Registers a new Transport and URI prefix with the AMPS Client.
static void	reset() Resets self to the default state, unregistering any Transports registered at runtime.
static void	unregister(java.lang.String name) Unregisters a Transport from the AMPS client.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportFactory

public TransportFactory()

Method Detail

register

public static void register(java.lang.String name,
                            java.lang.String className)
                     throws TransportTypeException

Registers a new Transport and URI prefix with the AMPS Client.

Parameters:

name - The URI prefix to register for this transport.

className - The name of the Java class to instantiate.

Throws:

TransportTypeException - Thrown when this transport type is already registered.

unregister

public static void unregister(java.lang.String name)
                       throws TransportTypeException

Unregisters a Transport from the AMPS client. Note: built-in transport types (e.g. 'tcp') cannot be unregistered.

Parameters:

name - The URI prefix to unregister.

Throws:

TransportTypeException - Thrown when this transport type has not been registered.

reset

public static void reset()

Resets self to the default state, unregistering any Transports registered at runtime.

createTransport

public static Transport createTransport(java.lang.String name,
                                        Protocol messageType,
                                        java.util.Properties props)
                                 throws TransportTypeException

Creates a Transport using the parameters provided.

Parameters:

name - A string which contains the name of the future Transport.

messageType - A parameter of type Protocol which contains the classification of the message.

props - A parameter of type Properties which contains the information about the message to be created.

Returns:

The newly-created Transport.

Throws:

TransportTypeException - Thrown when the requested transport type cannot be constructed.