All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.jigsaw.servlet.ServletWrapper 

java.lang.Object
   |
   +----w3c.tools.store.AttributeHolder
           |
           +----w3c.tools.store.Resource
                   |
                   +----w3c.jigsaw.resources.HTTPResource
                           |
                           +----w3c.jigsaw.resources.FilteredResource
                                   |
                                   +----w3c.jigsaw.servlet.ServletWrapper
public class ServletWrapper
extends FilteredResource

Variable Index

o ATTR_PARAMETERS
Attribute index - The init parameters for that servlet.
o ATTR_SERVLET_CLASS
Attributes index - The servlet class name.
o ATTR_SERVLET_CONTEXT
Attribute index - Our parent-inherited servlet context.
o inited
Is out servler initialized ?
o servlet
The servlet wrapped within that Jigsaw resource.
o STATE_EXTRA_PATH

Constructor Index

o ServletWrapper()

Method Index

o destroyServlet()
Destroy the servlet we are wrapping.
o getInitParameter(String)
Servlet stub implementation - Get an init parameter value.
o getInitParameterNames()
Servlet stub implementation - Get all init parameters.
o getServlet()
Get the servlet we are wrapping.
o getServletClass()
Get the class name of the wrapped servlet.
o getServletContext()
Servlet stub implementation - Get that servlet context.
o getServletDirectory()
The Path where we can find the servlet class file.
o getServletParameters()
Get the init parameters for our wrapped servlet.
o initialize(Object[])
Initialize this servlet wrapper resource.
o launchServlet()
Launch the servlet we are wrapping.
o launchServlet(Class)
Initialize our servlet from the given (loaded) class.
o lookup(LookupState, LookupResult)
Jigsaw's lookup on servlets.
o notifyUnload()
This resource is being unloaded.
o perform(Request)
Dispatch the give request to our servlet.
o setValue(int, Object)
Catch assignements to the servlet class name attribute.

Variables

o STATE_EXTRA_PATH 
 public static final String STATE_EXTRA_PATH
o ATTR_SERVLET_CLASS 
 protected static int ATTR_SERVLET_CLASS
Attributes index - The servlet class name.

o ATTR_PARAMETERS 
 protected static int ATTR_PARAMETERS
Attribute index - The init parameters for that servlet.

o ATTR_SERVLET_CONTEXT 
 protected static int ATTR_SERVLET_CONTEXT
Attribute index - Our parent-inherited servlet context.

o servlet 
 protected Servlet servlet
The servlet wrapped within that Jigsaw resource.

o inited 
 protected boolean inited
Is out servler initialized ?

Constructors

o ServletWrapper 
 public ServletWrapper()

Methods

o getServletDirectory 
 public File getServletDirectory()
The Path where we can find the servlet class file.

o getInitParameter 
 public synchronized String getInitParameter(String string)
Servlet stub implementation - Get an init parameter value.

o getInitParameterNames 
 public synchronized Enumeration getInitParameterNames()
Servlet stub implementation - Get all init parameters.

o getServletContext 
 public ServletContext getServletContext()
Servlet stub implementation - Get that servlet context.

o getServletClass 
 public String getServletClass()
Get the class name of the wrapped servlet.

Returns:
The class name for the servlet if attribute is defined. Otherwise the class name is deduced from the resource identifier.
o getServletParameters 
 public ArrayDictionary getServletParameters()
Get the init parameters for our wrapped servlet.

Returns:
An ArrayDictionary instance if the attribute is defined, false otherwise.
o setValue 
 public void setValue(int idx,
                      Object value)
Catch assignements to the servlet class name attribute.

When a change to that attribute is detected, the servlet is automatically reinitialized.

Overrides:
setValue in class HTTPResource
o destroyServlet 
 protected synchronized void destroyServlet()
Destroy the servlet we are wrapping.

o getServlet 
 public Servlet getServlet()
Get the servlet we are wrapping.

Returns:
A servlet instance, if the servlet is alredy running, null otherwise.
o launchServlet 
 protected boolean launchServlet(Class cls)
Initialize our servlet from the given (loaded) class.

Parameters:
cls - The servlet loaded main class.
Returns:
A boolean, true if servlet was successfully initialised, false otherwise.
o launchServlet 
 protected boolean launchServlet()
Launch the servlet we are wrapping.

This method either succeed, or the wrapper resource itself will fail to initialize, acting as transparently as possible (in some sense).

Returns:
A boolean, true if servlet launched.
o perform 
 public Reply perform(Request request) throws HTTPException
Dispatch the give request to our servlet.

If the servlet cannot be inititalized, we just throw an error message otherwise, we just delegate that request processing to the underlying servlet instance.

Parameters:
request - The request to be processed.
Throws: HTTPException
If the wrapped servlet is not initialized.
Overrides:
perform in class HTTPResource
o lookup 
 public boolean lookup(LookupState ls,
                       LookupResult lr) throws HTTPException
Jigsaw's lookup on servlets. Once here, we have reached a leaf servlet (or at least the remaining lookup is to be done at the servlet itself). We keep track of the path info and mark that servlet as the target of request.

Parameters:
ls - The lookup state.
lr - The lookup result.
Throws: HTTPException
If some error occurs.
Overrides:
lookup in class FilteredResource
o notifyUnload 
 public void notifyUnload()
This resource is being unloaded.

Overrides:
notifyUnload in class Resource
o initialize 
 public void initialize(Object values[])
Initialize this servlet wrapper resource. After the wrapper itself is inited, it performs the servlet initialzation.

Parameters:
values - The default attribute values.
Overrides:
initialize in class FilteredResource 
All Packages  Class Hierarchy  This Package  Previous  Next  Index