org.mortbay.jetty.servlet

Class WebApplicationContext

public class WebApplicationContext extends ServletHttpContext implements Externalizable

Standard web.xml configured HttpContext. This specialization of HttpContext uses the standardized web.xml to describe a web application and configure the handlers for the HttpContext. If a file named web-jetty.xml or jetty-web.xml is found in the WEB-INF directory it is applied to the context using the XmlConfiguration format. A single WebApplicationHandler instance is used to provide security, filter, sevlet and resource handling.

Version: $Id: WebApplicationContext.java,v 1.136 2005/10/26 08:11:04 gregwilkins Exp $

Author: Greg Wilkins (gregw)

See Also: WebApplicationHandler

Nested Class Summary
static interface	WebApplicationContext.Configuration Base Class for WebApplicationContext Configuration.

Constructor Summary
	WebApplicationContext() Constructor.
	WebApplicationContext(String webApp) Constructor.

Method Summary
void	addEventListener(EventListener listener)
protected void	configureClassPath()
protected void	configureDefaults()
protected void	configureWebApp()
void	destroy()
protected void	doStart() Start the Web Application.
protected void	doStop() Stop the web application.
String[]	getConfigurationClassNames()
WebApplicationContext.Configuration[]	getConfigurations()
String	getDefaultsDescriptor()
String	getDisplayName()
String	getErrorPage(String error) get error page URI.
boolean	getExtractWAR()
Resource	getResource(String uriInContext)
String	getResourceAlias(String alias)
Map	getResourceAliases()
ServletHandler	getServletHandler() Get the context ServletHandler.
protected UserRealm	getUserRealm(String name)
String	getWAR()
WebApplicationHandler	getWebApplicationHandler()
Resource	getWebInf()
void	handle(String pathInContext, String pathParams, HttpRequest httpRequest, HttpResponse httpResponse)
protected void	initialize() Initialize is called by the start method after the contexts classloader has been initialied, but before the defaults descriptor has been applied.
boolean	isDistributable()
boolean	isIgnoreWebJetty()
protected WebApplicationContext.Configuration[]	loadConfigurations()
void	readExternal(ObjectInput in)
String	removeErrorPage(String error)
void	removeEventListener(EventListener listener)
String	removeResourceAlias(String alias)
void	setConfigurationClassNames(String[] configurationClassNames)
void	setDefaultsDescriptor(String defaults) Set the defaults web.xml file.
void	setDisplayName(String name)
void	setDistributable(boolean distributable)
void	setErrorPage(String error, String uriInContext) set error page URI.
void	setExtractWAR(boolean extract)
void	setIgnoreWebJetty(boolean b)
void	setPermissions(PermissionCollection permissions)
void	setResourceAlias(String alias, String uri) Set Resource Alias.
void	setWAR(String war)
String	toString()
void	writeExternal(ObjectOutput out)

Constructor Detail

WebApplicationContext

public WebApplicationContext()

Constructor.

WebApplicationContext

public WebApplicationContext(String webApp)

Constructor.

Parameters: webApp The Web application directory or WAR file.

Method Detail

addEventListener

public void addEventListener(EventListener listener)

configureClassPath

protected void configureClassPath()

configureDefaults

protected void configureDefaults()

configureWebApp

protected void configureWebApp()

destroy

public void destroy()

doStart

protected void doStart()

Start the Web Application.

Throws: IOException

doStop

protected void doStop()

Stop the web application. Handlers for resource, servlet, filter and security are removed as they are recreated and configured by any subsequent call to start().

Throws: InterruptedException

getConfigurationClassNames

public String[] getConfigurationClassNames()

getConfigurations

public WebApplicationContext.Configuration[] getConfigurations()

getDefaultsDescriptor

public String getDefaultsDescriptor()

getDisplayName

public String getDisplayName()

getErrorPage

public String getErrorPage(String error)

get error page URI.

Parameters: error A string representing an error code or a exception classname

Returns: URI within context

getExtractWAR

public boolean getExtractWAR()

getResource

public Resource getResource(String uriInContext)

getResourceAlias

public String getResourceAlias(String alias)

getResourceAliases

public Map getResourceAliases()

getServletHandler

public ServletHandler getServletHandler()

Get the context ServletHandler. Conveniance method. If no ServletHandler exists, a new one is added to the context. This derivation of the method creates a WebApplicationHandler extension of ServletHandler.

Returns: WebApplicationHandler

getUserRealm

protected UserRealm getUserRealm(String name)

getWAR

public String getWAR()

getWebApplicationHandler

public WebApplicationHandler getWebApplicationHandler()

getWebInf

public Resource getWebInf()

handle

public void handle(String pathInContext, String pathParams, HttpRequest httpRequest, HttpResponse httpResponse)

initialize

protected void initialize()

Initialize is called by the start method after the contexts classloader has been initialied, but before the defaults descriptor has been applied. The default implementation does nothing.

Throws: Exception if an error occurs

Parameters: defaults File, Resource, URL or null.

Parameters: error A string representing an error code or a exception classname uriInContext

Parameters: alias uri