WebAppConfiguration (Winstone 0.9.10-jenkins-47 API)

java.lang.Object
- winstone.WebAppConfiguration

All Implemented Interfaces:

Comparator, ServletContext
```
public class WebAppConfiguration
extends Object
implements ServletContext, Comparator
```
Models the web.xml file's details ... basically just a bunch of configuration details, plus the actual instances of mounted servlets.

Version:

$Id: WebAppConfiguration.java,v 1.55 2007/11/13 01:42:47 rickknowles Exp $

Author:

Rick Knowles

Constructor Summary

Constructors
Constructor and Description
`WebAppConfiguration(HostConfiguration ownerHostConfig, Cluster cluster, String webRoot, String prefix, ObjectPool objectPool, Map startupArgs, Node elm, ClassLoader parentClassLoader, File[] parentClassPaths, String contextName)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addJspServletParams(Map jspParams)`
`static boolean`	`booleanArg(Map args, String name, boolean defaultTrue)`
`int`	`compare(Object one, Object two)`
`void`	`destroy()` Iterates through each of the servlets/filters and calls destroy on them
`AccessLogger`	`getAccessLogger()`
`Object`	`getAttribute(String name)` OK ...
`Enumeration`	`getAttributeNames()`
`ServletContext`	`getContext(String uri)`
`String`	`getContextName()`
`String`	`getContextPath()`
`RequestDispatcher`	`getErrorDispatcherByClass(Throwable exception)` Gets a dispatcher, set up for error dispatch.
`RequestDispatcher`	`getErrorDispatcherByCode(String requestURI, int statusCode, String summaryMessage, Throwable exception)`
`Class[]`	`getErrorPageExceptions()`
`Map`	`getErrorPagesByCode()`
`Map`	`getErrorPagesByException()`
`Map`	`getFilterMatchCache()`
`Map`	`getFilters()`
`RequestDispatcher`	`getInitialDispatcher(String uriInsideWebapp, WinstoneRequest request, WinstoneResponse response)` Creates the dispatcher that corresponds to a request level dispatch (ie the initial entry point).
`String`	`getInitParameter(String name)`
`Enumeration`	`getInitParameterNames()`
`ClassLoader`	`getLoader()`
`Map`	`getLocaleEncodingMap()`
`int`	`getMajorVersion()`
`String`	`getMimeType(String fileName)` Look up the map of mimeType extensions, and return the type that matches
`int`	`getMinorVersion()`
`RequestDispatcher`	`getNamedDispatcher(String name)` Named dispatcher - this basically gets us a simple exact dispatcher (no url matching, no request attributes and no security)
`String`	`getOwnerHostname()`
`String`	`getRealPath(String path)`
`ServletRequestAttributeListener[]`	`getRequestAttributeListeners()`
`RequestDispatcher`	`getRequestDispatcher(String uriInsideWebapp)` Gets a dispatcher, which sets the request attributes, etc on a forward/include.
`ServletRequestListener[]`	`getRequestListeners()`
`URL`	`getResource(String path)`
`InputStream`	`getResourceAsStream(String path)`
`Set`	`getResourcePaths(String path)`
`String`	`getServerInfo()`
`Servlet`	`getServlet(String name)` Deprecated.
`String`	`getServletContextName()`
`Enumeration`	`getServletNames()` Deprecated.
`Enumeration`	`getServlets()` Deprecated.
`String`	`getServletURIFromRequestURI(String requestURI)`
`WinstoneSession`	`getSessionById(String sessionId, boolean localOnly)` Retrieves the session by id.
`static String`	`getTextFromNode(Node node)`
`String`	`getWebroot()`
`String[]`	`getWelcomeFiles()`
`static int`	`intArg(Map args, String name, int defaultValue)`
`void`	`invalidateExpiredSessions()`
`boolean`	`isDistributable()`
`void`	`log(Exception exception, String msg)` Deprecated.
`void`	`log(String message)`
`void`	`log(String message, Throwable throwable)`
`WinstoneSession`	`makeNewSession(String sessionId)` Constructs a session instance with the given sessionId
`void`	`removeAttribute(String name)`
`void`	`removeServletConfigurationAndMappings(ServletConfiguration config)`
`void`	`resetClassLoader()` Triggered by the admin thread on the reloading class loader.
`void`	`setAttribute(String name, Object object)`
`void`	`setSessionListeners(WinstoneSession session)`
`static String`	`stringArg(Map args, String name, String defaultValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator
equals

Constructor Detail

WebAppConfiguration

public WebAppConfiguration(HostConfiguration ownerHostConfig,
                   Cluster cluster,
                   String webRoot,
                   String prefix,
                   ObjectPool objectPool,
                   Map startupArgs,
                   Node elm,
                   ClassLoader parentClassLoader,
                   File[] parentClassPaths,
                   String contextName)

Constructor. This parses the xml and sets up for basic routing

Method Detail
- booleanArg
```
public static boolean booleanArg(Map args,
                 String name,
                 boolean defaultTrue)
```
- stringArg
```
public static String stringArg(Map args,
               String name,
               String defaultValue)
```
- intArg
```
public static int intArg(Map args,
         String name,
         int defaultValue)
```
- getTextFromNode
```
public static String getTextFromNode(Node node)
```
- getContextPath
```
public String getContextPath()
```
  Specified by:
  
  getContextPath in interface ServletContext
- getWebroot
```
public String getWebroot()
```
- getLoader
```
public ClassLoader getLoader()
```
- getAccessLogger
```
public AccessLogger getAccessLogger()
```
- getFilters
```
public Map getFilters()
```
- getContextName
```
public String getContextName()
```
- getErrorPageExceptions
```
public Class[] getErrorPageExceptions()
```
- getErrorPagesByException
```
public Map getErrorPagesByException()
```
- getErrorPagesByCode
```
public Map getErrorPagesByCode()
```
- getLocaleEncodingMap
```
public Map getLocaleEncodingMap()
```
- getWelcomeFiles
```
public String[] getWelcomeFiles()
```
- isDistributable
```
public boolean isDistributable()
```
- getFilterMatchCache
```
public Map getFilterMatchCache()
```
- getOwnerHostname
```
public String getOwnerHostname()
```
- getRequestListeners
```
public ServletRequestListener[] getRequestListeners()
```
- getRequestAttributeListeners
```
public ServletRequestAttributeListener[] getRequestAttributeListeners()
```
- addJspServletParams
```
public static void addJspServletParams(Map jspParams)
```
- compare
```
public int compare(Object one,
          Object two)
```
  Specified by:
  
  compare in interface Comparator
- getServletURIFromRequestURI
```
public String getServletURIFromRequestURI(String requestURI)
```
- destroy
```
public void destroy()
```
  Iterates through each of the servlets/filters and calls destroy on them
- resetClassLoader
```
public void resetClassLoader()
                      throws IOException
```
  Triggered by the admin thread on the reloading class loader. This will cause a full shutdown and reinstantiation of the web app - not real graceful, but you shouldn't have reloading turned on in high load environments.
  
  Throws:
  
  IOException
- makeNewSession
```
public WinstoneSession makeNewSession(String sessionId)
```
  Constructs a session instance with the given sessionId
  
  Parameters:
  sessionId - The sessionID for the new session
  
  Returns:
  A valid session object
- getSessionById
```
public WinstoneSession getSessionById(String sessionId,
                             boolean localOnly)
```
  Retrieves the session by id. If the web app is distributable, it asks the other members of the cluster if it doesn't have it itself.
  
  Parameters:
  sessionId - The id of the session we want
  
  Returns:
  A valid session instance
- invalidateExpiredSessions
```
public void invalidateExpiredSessions()
```
- setSessionListeners
```
public void setSessionListeners(WinstoneSession session)
```
- removeServletConfigurationAndMappings
```
public void removeServletConfigurationAndMappings(ServletConfiguration config)
```
- getAttribute
```
public Object getAttribute(String name)
```
  OK ... from here to the end is the interface implementation methods for the servletContext interface.
  
  Specified by:
  
  getAttribute in interface ServletContext
- getAttributeNames
```
public Enumeration getAttributeNames()
```
  Specified by:
  
  getAttributeNames in interface ServletContext
- removeAttribute
```
public void removeAttribute(String name)
```
  Specified by:
  
  removeAttribute in interface ServletContext
- setAttribute
```
public void setAttribute(String name,
                Object object)
```
  Specified by:
  
  setAttribute in interface ServletContext
- getInitParameter
```
public String getInitParameter(String name)
```
  Specified by:
  
  getInitParameter in interface ServletContext
- getInitParameterNames
```
public Enumeration getInitParameterNames()
```
  Specified by:
  
  getInitParameterNames in interface ServletContext
- getServerInfo
```
public String getServerInfo()
```
  Specified by:
  
  getServerInfo in interface ServletContext
- getMajorVersion
```
public int getMajorVersion()
```
  Specified by:
  
  getMajorVersion in interface ServletContext
- getMinorVersion
```
public int getMinorVersion()
```
  Specified by:
  
  getMinorVersion in interface ServletContext
- getContext
```
public ServletContext getContext(String uri)
```
  Specified by:
  
  getContext in interface ServletContext
- getServletContextName
```
public String getServletContextName()
```
  Specified by:
  
  getServletContextName in interface ServletContext
- getMimeType
```
public String getMimeType(String fileName)
```
  Look up the map of mimeType extensions, and return the type that matches
  
  Specified by:
  
  getMimeType in interface ServletContext
- log
```
public void log(String message)
```
  Specified by:
  
  log in interface ServletContext
- log
```
public void log(String message,
       Throwable throwable)
```
  Specified by:
  
  log in interface ServletContext
- getNamedDispatcher
```
public RequestDispatcher getNamedDispatcher(String name)
```
  Named dispatcher - this basically gets us a simple exact dispatcher (no url matching, no request attributes and no security)
  
  Specified by:
  
  getNamedDispatcher in interface ServletContext
- getRequestDispatcher
```
public RequestDispatcher getRequestDispatcher(String uriInsideWebapp)
```
  Gets a dispatcher, which sets the request attributes, etc on a forward/include. Doesn't execute security though.
  
  Specified by:
  
  getRequestDispatcher in interface ServletContext
- getInitialDispatcher
```
public RequestDispatcher getInitialDispatcher(String uriInsideWebapp,
                                     WinstoneRequest request,
                                     WinstoneResponse response)
                                       throws IOException
```
  Creates the dispatcher that corresponds to a request level dispatch (ie the initial entry point). The difference here is that we need to set up the dispatcher so that on a forward, it executes the security checks and the request filters, while not setting any of the request attributes for a forward. Also, we can't return a null dispatcher in error case - instead we have to return a dispatcher pre-init'd for showing an error page (eg 404). A null dispatcher is interpreted to mean a successful 302 has occurred.
  
  Throws:
  
  IOException
- getErrorDispatcherByClass
```
public RequestDispatcher getErrorDispatcherByClass(Throwable exception)
```
  Gets a dispatcher, set up for error dispatch.
- getErrorDispatcherByCode
```
public RequestDispatcher getErrorDispatcherByCode(String requestURI,
                                         int statusCode,
                                         String summaryMessage,
                                         Throwable exception)
```
- getResource
```
public URL getResource(String path)
                throws MalformedURLException
```
  Specified by:
  
  getResource in interface ServletContext
  
  Throws:
  
  MalformedURLException
- getResourceAsStream
```
public InputStream getResourceAsStream(String path)
```
  Specified by:
  
  getResourceAsStream in interface ServletContext
- getRealPath
```
public String getRealPath(String path)
```
  Specified by:
  
  getRealPath in interface ServletContext
- getResourcePaths
```
public Set getResourcePaths(String path)
```
  Specified by:
  
  getResourcePaths in interface ServletContext
- getServlet
```
public Servlet getServlet(String name)
```
  Deprecated.
  
  Specified by:
  
  getServlet in interface ServletContext
- getServletNames
```
public Enumeration getServletNames()
```
  Deprecated.
  
  Specified by:
  
  getServletNames in interface ServletContext
- getServlets
```
public Enumeration getServlets()
```
  Deprecated.
  
  Specified by:
  
  getServlets in interface ServletContext
- log
```
public void log(Exception exception,
       String msg)
```
  Deprecated.
  
  Specified by:
  
  log in interface ServletContext

Class WebAppConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Constructor Detail

WebAppConfiguration

Method Detail

booleanArg

stringArg

intArg

getTextFromNode

getContextPath

getWebroot

getLoader

getAccessLogger

getFilters

getContextName

getErrorPageExceptions

getErrorPagesByException

getErrorPagesByCode

getLocaleEncodingMap

getWelcomeFiles

isDistributable

getFilterMatchCache

getOwnerHostname

getRequestListeners

getRequestAttributeListeners

addJspServletParams

compare

getServletURIFromRequestURI

destroy

resetClassLoader

makeNewSession

getSessionById

invalidateExpiredSessions

setSessionListeners

removeServletConfigurationAndMappings

getAttribute

getAttributeNames

removeAttribute

setAttribute

getInitParameter

getInitParameterNames

getServerInfo

getMajorVersion

getMinorVersion

getContext

getServletContextName

getMimeType

log

log

getNamedDispatcher

getRequestDispatcher

getInitialDispatcher

getErrorDispatcherByClass

getErrorDispatcherByCode

getResource

getResourceAsStream

getRealPath

getResourcePaths

getServlet

getServletNames

getServlets

log