org.davesag.generica.servlet.util
Class Pipe.Factory

java.lang.Object
  extended byorg.davesag.generica.servlet.util.Pipe.Factory
All Implemented Interfaces:
Serializable
Enclosing class:
Pipe

public static class Pipe.Factory
extends Object
implements Serializable

Use this Factory class to create or retrieve a named Pipe for the session.

See Also:
Serialized Form

Field Summary
protected static String PIPE_CLASS
          the name of the implementation to use.
 
Constructor Summary
Pipe.Factory()
           
 
Method Summary
static Pipe getPipe(HttpSession session, String name)
          Gets the current Pipe from the session with the name provided, or if one does not yet exist it creates one.
static void setPipeClass(String classname)
          Sets the static Pipe implementation class name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PIPE_CLASS

protected static String PIPE_CLASS
the name of the implementation to use.

Constructor Detail

Pipe.Factory

public Pipe.Factory()
Method Detail

setPipeClass

public static void setPipeClass(String classname)
Sets the static Pipe implementation class name. use this if you wish to override the default with your own Pipe.

Parameters:
classname - The name of the Pipe Implementation to use.

getPipe

public static Pipe getPipe(HttpSession session,
                           String name)
Gets the current Pipe from the session with the name provided, or if one does not yet exist it creates one.

Parameters:
session - The session that will carry the Pipe.
name - The name to use as the name of the Pipe. This name will usually come from the struts-config.xml file where it will be specified as an action parameter called name.
Returns:
the pipe.


Dave Sag Generica API version 0.5.9 - (prerelease) Copyright 2003 - 2004 Dave Sag.