com.crankuptheamps.client

Class ProtocolFactory

java.lang.Object

com.crankuptheamps.client.ProtocolFactory

public class ProtocolFactory
extends java.lang.Object

Class which creates Protocols as well as registering and unregistering them from a Java Map.

Constructor Summary

Constructors

Constructor and Description
ProtocolFactory()

Method Summary

Modifier and Type	Method and Description
static Protocol	createProtocol(java.lang.String name, java.util.Properties props) Creates a protocol.
static void	register(java.lang.String name, java.lang.String msgType) Method to register the name of the message and the message type.
static void	unregister(java.lang.String name) Method to unregister a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolFactory

public ProtocolFactory()

Method Detail

register

public static void register(java.lang.String name,
                            java.lang.String msgType)
                     throws ProtocolException

Method to register the name of the message and the message type.

Parameters:

name - A string containing the name of the message

msgType - A string containing the type of the message

Throws:

ProtocolException - The name is already registered

unregister

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

Method to unregister a message.

Parameters:

name - A string containing the name of the message.

Throws:

ProtocolException - the provided name is not registered

createProtocol

public static Protocol createProtocol(java.lang.String name,
                                      java.util.Properties props)
                               throws ProtocolException

Creates a protocol.

Parameters:

name - A string which holds the name of the Protocol

props - A Properties object which holds the properties of the Protocol

Returns:

Returns this instance so that various operations can be chained together.

Throws:

ProtocolException - provided name is not a valid Protocol