org.jgroups.stack
Class Configurator

java.lang.Object
  extended by org.jgroups.stack.Configurator

public class Configurator
extends java.lang.Object

The task if this class is to setup and configure the protocol stack. A string describing the desired setup, which is both the layering and the configuration of each layer, is given to the configurator which creates and configures the protocol stack and returns a reference to the top layer (Protocol).

Future functionality will include the capability to dynamically modify the layering of the protocol stack and the properties of each layer.

Version:
$Id: Configurator.java,v 1.28.4.8 2008/10/29 08:31:05 belaban Exp $
Author:
Bela Ban

Nested Class Summary
static class Configurator.ProtocolConfiguration
          Parses and encapsulates the specification for 1 protocol of the protocol stack, e.g.
 
Field Summary
protected static org.apache.commons.logging.Log log
           
 
Constructor Summary
Configurator()
           
 
Method Summary
static Protocol createProtocol(java.lang.String prot_spec, ProtocolStack stack)
          Creates a new protocol given the protocol specification.
static void destroyProtocolStack(java.util.List<Protocol> protocols)
           
static Protocol findProtocol(Protocol prot_stack, java.lang.String name)
           
static Protocol getBottommostProtocol(Protocol prot_stack)
           
static void initProtocolStack(java.util.List<Protocol> protocols)
           
static void insertProtocol(Protocol prot, int position, java.lang.Class<? extends Protocol> neighbor_prot, ProtocolStack stack)
           
static void insertProtocol(Protocol prot, int position, java.lang.String neighbor_prot, ProtocolStack stack)
          Inserts an already created (and initialized) protocol into the protocol list.
protected static void insertProtocol(Protocol prot, Protocol neighbor, int position)
           
static java.util.Vector<Configurator.ProtocolConfiguration> parseConfigurations(java.lang.String configuration)
          Return a number of ProtocolConfigurations in a vector
static java.util.Vector<java.lang.String> parseProtocols(java.lang.String config_str)
          Get a string of the form "P1(config_str1):P2:P3(config_str3)" and return ProtocolConfigurations for it.
static Protocol removeProtocol(Protocol top_prot, java.lang.String prot_name)
          Removes a protocol from the stack.
static void sanityCheck(java.util.Vector<Protocol> protocols)
          Throws an exception if sanity check fails.
static Protocol setupProtocolStack(java.lang.String configuration, ProtocolStack st)
          The configuration string has a number of entries, separated by a ':' (colon).
static void startProtocolStack(java.util.List<Protocol> protocols, java.lang.String cluster_name, java.util.Map<java.lang.String,Tuple<TP,java.lang.Short>> singletons)
           
static void stopProtocolStack(java.util.List<Protocol> protocols, java.lang.String cluster_name, java.util.Map<java.lang.String,Tuple<TP,java.lang.Short>> singletons)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log
Constructor Detail

Configurator

public Configurator()
Method Detail

setupProtocolStack

public static Protocol setupProtocolStack(java.lang.String configuration,
                                          ProtocolStack st)
                                   throws java.lang.Exception
The configuration string has a number of entries, separated by a ':' (colon). Each entry consists of the name of the protocol, followed by an optional configuration of that protocol. The configuration is enclosed in parentheses, and contains entries which are name/value pairs connected with an assignment sign (=) and separated by a semicolon.
UDP(in_port=5555;out_port=4445):FRAG(frag_size=1024)

The first entry defines the bottommost layer, the string is parsed left to right and the protocol stack constructed bottom up. Example: the string "UDP(in_port=5555):FRAG(frag_size=32000):DEBUG" results is the following stack:


   -----------------------
  | DEBUG                 |
  |-----------------------|
  | FRAG frag_size=32000  |
  |-----------------------|
  | UDP in_port=32000     |
   -----------------------
 

Throws:
java.lang.Exception

initProtocolStack

public static void initProtocolStack(java.util.List<Protocol> protocols)
                              throws java.lang.Exception
Throws:
java.lang.Exception

startProtocolStack

public static void startProtocolStack(java.util.List<Protocol> protocols,
                                      java.lang.String cluster_name,
                                      java.util.Map<java.lang.String,Tuple<TP,java.lang.Short>> singletons)
                               throws java.lang.Exception
Throws:
java.lang.Exception

stopProtocolStack

public static void stopProtocolStack(java.util.List<Protocol> protocols,
                                     java.lang.String cluster_name,
                                     java.util.Map<java.lang.String,Tuple<TP,java.lang.Short>> singletons)

destroyProtocolStack

public static void destroyProtocolStack(java.util.List<Protocol> protocols)

findProtocol

public static Protocol findProtocol(Protocol prot_stack,
                                    java.lang.String name)

getBottommostProtocol

public static Protocol getBottommostProtocol(Protocol prot_stack)

createProtocol

public static Protocol createProtocol(java.lang.String prot_spec,
                                      ProtocolStack stack)
                               throws java.lang.Exception
Creates a new protocol given the protocol specification. Initializes the properties and starts the up and down handler threads.

Parameters:
prot_spec - The specification of the protocol. Same convention as for specifying a protocol stack. An exception will be thrown if the class cannot be created. Example:
"VERIFY_SUSPECT(timeout=1500)"
Note that no colons (:) have to be specified
stack - The protocol stack
Returns:
Protocol The newly created protocol
Throws:
java.lang.Exception - Will be thrown when the new protocol cannot be created

insertProtocol

public static void insertProtocol(Protocol prot,
                                  int position,
                                  java.lang.String neighbor_prot,
                                  ProtocolStack stack)
                           throws java.lang.Exception
Inserts an already created (and initialized) protocol into the protocol list. Sets the links to the protocols above and below correctly and adjusts the linked list of protocols accordingly. This should be done before starting the stack.

Parameters:
prot - The protocol to be inserted. Before insertion, a sanity check will ensure that none of the existing protocols have the same name as the new protocol.
position - Where to place the protocol with respect to the neighbor_prot (ABOVE, BELOW)
neighbor_prot - The name of the neighbor protocol. An exception will be thrown if this name is not found
stack - The protocol stack
Throws:
java.lang.Exception - Will be thrown when the new protocol cannot be created, or inserted.

insertProtocol

public static void insertProtocol(Protocol prot,
                                  int position,
                                  java.lang.Class<? extends Protocol> neighbor_prot,
                                  ProtocolStack stack)
                           throws java.lang.Exception
Throws:
java.lang.Exception

insertProtocol

protected static void insertProtocol(Protocol prot,
                                     Protocol neighbor,
                                     int position)

removeProtocol

public static Protocol removeProtocol(Protocol top_prot,
                                      java.lang.String prot_name)
                               throws java.lang.Exception
Removes a protocol from the stack. Stops the protocol and readjusts the linked lists of protocols.

Parameters:
prot_name - The name of the protocol. Since all protocol names in a stack have to be unique (otherwise the stack won't be created), the name refers to just 1 protocol.
Throws:
java.lang.Exception - Thrown if the protocol cannot be stopped correctly.

parseProtocols

public static java.util.Vector<java.lang.String> parseProtocols(java.lang.String config_str)
                                                         throws java.io.IOException
Get a string of the form "P1(config_str1):P2:P3(config_str3)" and return ProtocolConfigurations for it. That means, parse "P1(config_str1)", "P2" and "P3(config_str3)"

Parameters:
config_str - Configuration string
Returns:
Vector of strings
Throws:
java.io.IOException

parseConfigurations

public static java.util.Vector<Configurator.ProtocolConfiguration> parseConfigurations(java.lang.String configuration)
                                                                                throws java.lang.Exception
Return a number of ProtocolConfigurations in a vector

Parameters:
configuration - protocol-stack configuration string
Returns:
Vector of ProtocolConfigurations
Throws:
java.lang.Exception

sanityCheck

public static void sanityCheck(java.util.Vector<Protocol> protocols)
                        throws java.lang.Exception
Throws an exception if sanity check fails. Possible sanity check is uniqueness of all protocol names

Throws:
java.lang.Exception


Copyright ? 1998-2008 Bela Ban. All Rights Reserved.