    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.jigsaw.servlet.ServletWrapper

    java.lang.Object
       |
       +----org.w3c.tools.resources.AttributeHolder
               |
               +----org.w3c.tools.resources.Resource
                       |
                       +----org.w3c.tools.resources.FramedResource
                               |
                               +----org.w3c.jigsaw.servlet.ServletWrapper

public class ServletWrapper
extends FramedResource
implements ServletConfig

##

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

##

ServletWrapper()

##

checkServlet()
  Check the servlet class, ans try to initialize it.
createNewLocalServletLoader(boolean)
destroyServlet()
  Destroy the servlet we are wrapping.
getInitParameter(String)
  Servlet stub implementation - Get an init parameter value.
getInitParameterNames()
  Servlet stub implementation - Get all init parameters.
getLocalServletLoader()
  Get or create a suitable LocalServletLoader instance to load that servlet.
getServlet()
  Get the servlet we are wrapping.
getServletClass()
  Get the class name of the wrapped servlet.
getServletContext()
  Servlet stub implementation - Get that servlet context.
getServletDirectory()
  The Path where we can find the servlet class file.
getServletParameters()
  Get the init parameters for our wrapped servlet.
getSessionContext()
initialize(Object[])
  Initialize this servlet wrapper resource.
invalidateAllSession()
isInited()
isWrappingAServlet()
  Check if the Servletclass wrapped is a Servlet class without initializing it.
launchServlet()
  Launch the servlet we are wrapping.
launchServlet(Class)
  Initialize our servlet from the given (loaded) class.
notifyUnload()
  This resource is being unloaded.
service(Request, Reply)
setValue(int, Object)
  Catch assignements to the servlet class name attribute.
setValueOfSuperClass(int, Object)

##

debug

     protected static final boolean debug

ATTR_SERVLET_CLASS

     protected static int ATTR_SERVLET_CLASS

  Attributes index - The servlet class name.

ATTR_PARAMETERS

     protected static int ATTR_PARAMETERS

  Attribute index - The init parameters for that servlet.

ATTR_SERVLET_CONTEXT

     protected static int ATTR_SERVLET_CONTEXT

  Attribute index - Our parent-inherited servlet context.

ATTR_SESSION_CONTEXT

     protected static int ATTR_SESSION_CONTEXT

  Attribute index - Our parent-inherited session context.

servlet

     protected Servlet servlet

  The servlet wrapped within that Jigsaw resource.

inited

     protected boolean inited

  Is out servler initialized ?

##

ServletWrapper

     public ServletWrapper()

##

getServletDirectory

     public File getServletDirectory()

  The Path where we can find the servlet class file.

getInitParameter

     public synchronized String getInitParameter(String string)

  Servlet stub implementation - Get an init parameter value.

getInitParameterNames

     public synchronized Enumeration getInitParameterNames()

  Servlet stub implementation - Get all init parameters.

getServletContext

     public ServletContext getServletContext()

  Servlet stub implementation - Get that servlet context.

getSessionContext

     public JigsawHttpSessionContext getSessionContext()

invalidateAllSession

     protected void invalidateAllSession()

checkServlet

     protected void checkServlet() throws ClassNotFoundException, ServletException

  Check the servlet class, ans try to initialize it.

  Throws: ClassNotFoundException
    if servlet class can't be found.
  Throws: ServletException
    if servlet can't be initialized.

isInited

     protected boolean isInited()

service

     protected void service(Request request,
                            Reply reply) throws ServletException, IOException

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.

getServletParameters

     public ArrayDictionary getServletParameters()

  Get the init parameters for our wrapped servlet.

  Returns:
    An ArrayDictionary instance if the attribute is defined, false otherwise.

setValueOfSuperClass

     protected void setValueOfSuperClass(int idx,
                                         Object value)

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 FramedResource

destroyServlet

     protected synchronized void destroyServlet()

  Destroy the servlet we are wrapping.

getServlet

     public synchronized Servlet getServlet()

  Get the servlet we are wrapping.

  Returns:
    A servlet instance, if the servlet is alredy running, null otherwise.

launchServlet

     protected boolean launchServlet(Class cls) throws ServletException

  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.
  Throws: ServletException
    if servlet can't be initialized.

isWrappingAServlet

     protected boolean isWrappingAServlet()

  Check if the Servletclass wrapped is a Servlet class without initializing it. (not the same than checkServlet). used by the ServletIndexer.

  Returns:
    A boolean.
  See Also:
    ServletIndexer

launchServlet

     protected boolean launchServlet() throws ClassNotFoundException, ServletException

  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.
  Throws: ClassNotFoundException
    if servlet class can't be found.
  Throws: ServletException
    if servlet can't be initialized.

notifyUnload

     public void notifyUnload()

  This resource is being unloaded.

  Overrides:
    notifyUnload in class FramedResource

getLocalServletLoader

     protected synchronized AutoReloadServletLoader getLocalServletLoader()

  Get or create a suitable LocalServletLoader instance to load that servlet.

  Returns:
    A LocalServletLoader instance.

createNewLocalServletLoader

     protected AutoReloadServletLoader createNewLocalServletLoader(boolean keepold)

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 FramedResource

    All Packages  Class Hierarchy  This Package  Previous  Next  Index