Jetty 7.0.0.pre5 · org.mortbay.jetty.webapp.WebAppContext

Modifier and Type	Field and Description
private static String[]	__dftConfigurationClasses
private String[]	_configurationClasses
private Configuration[]	_configurations
private boolean	_copyDir
private String	_defaultsDescriptor
private String	_descriptor
private boolean	_distributable
private String	_extraClasspath
private boolean	_extractWAR
private boolean	_isExistingTmpDir
private boolean	_logUrlOnStart
private String	_overrideDescriptor
private transient boolean	_ownClassLoader
private boolean	_parentLoaderPriority
private PermissionCollection	_permissions
private transient Map<K, V>	_resourceAliases
private String[]	_serverClasses
private String[]	_systemClasses
private File	_tmpDir
private transient boolean	_unavailable
private Throwable	_unavailableException
private String	_war
public static final String	ERROR_PAGE
public static final String	WEB_DEFAULTS_XML

Access	Constructor and Description
public	WebAppContext()
public	WebAppContext(String The URL or filename of the webapp directory or war file. webApp, String The context path contextPath)
public	WebAppContext(HandlerContainer The parent HandlerContainer. parent, String The URL or filename of the webapp directory or war file. webApp, String The context path contextPath)
public	WebAppContext(ConstraintsSecurityHandler securityHandler, SessionHandler sessionHandler, ServletHandler servletHandler, ErrorHandler errorHandler)

Method Summary

Modifier and Type	Method and Description
public void	addEventListener(EventListener listener) Overrides org.mortbay.jetty.handler.ContextHandler.addEventListener. Add EventListener Conveniance method that calls `setEventListeners(EventListener[])`
protected void	doStart() Overrides org.mortbay.jetty.handler.ContextHandler.doStart.
protected void	doStop() Overrides org.mortbay.jetty.handler.ContextHandler.doStop.
public void	dumpUrl()
private String	getCanonicalNameForWebAppTmpDir() Create a canonical name for a webapp tmp directory.
public String[]	Returns: Returns the configurations. getConfigurationClasses()
public Configuration[]	Returns: Returns the configurations. getConfigurations()
public ConstraintsSecurityHandler	getConstraintsSecurityHandler()
public static ContextHandler	getCurrentWebAppContext()
public String	Returns: Returns the defaultsDescriptor. getDefaultsDescriptor() The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml
public String	Returns: the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists. getDescriptor()
public String	Returns: Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'. getExtraClasspath()
public String	Returns: Returns the Override Descriptor. getOverrideDescriptor() The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
public PermissionCollection	Returns: Returns the permissions. getPermissions()
public Resource	getResource(String uriInContext) Overrides org.mortbay.jetty.handler.ContextHandler.getResource.
public String	getResourceAlias(String alias)
public Map<K, V>	getResourceAliases()
public String[]	Returns: Returns the serverClasses. getServerClasses()
public String[]	Returns: Returns the systemClasses. getSystemClasses()
public File	getTempDirectory() Get a temporary directory in which to unpack the war etc etc. The algorithm for determining this is to check these alternatives in the order shown: A.
public Throwable	Returns: A throwable if the webapp is unavailable or null getUnavailableException() Get an exception that caused the webapp to be unavailable
public String	Returns: Returns the war as a file or URL string (Resource) getWar()
public Resource	getWebInf()
public void	handle(String The target of the request - either a URI or a name. target, HttpServletRequest The request either as the `Request` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Request object if required. request, HttpServletResponse The response as the `Response` object or a wrapper of that request. The `HttpConnection#getCurrentConnection()` method can be used access the Response object if required. response, int The dispatch mode: `REQUEST`, `FORWARD`, `INCLUDE`, `ERROR` dispatch) Overrides org.mortbay.jetty.handler.ContextHandler.handle. Implements org.mortbay.jetty.Handler.handle. Handle a request.
public boolean	Returns: True if the webdir is copied (to allow hot replacement of jars) isCopyWebDir()
public boolean	Returns: Returns the distributable. isDistributable()
public boolean	Returns: Returns the extractWAR. isExtractWAR()
public boolean	isLogUrlOnStart()
public boolean	Returns: Returns the java2compliant. isParentLoaderPriority()
protected boolean	isProtectedTarget(String target) Overrides org.mortbay.jetty.handler.ContextHandler.isProtectedTarget. Check the target.
public boolean	isServerClass(String name)
public boolean	isSystemClass(String name)
public boolean	isTempWorkDirectory() Check if the _tmpDir itself is called "work", or if the _tmpDir is in a directory called "work".
protected void	loadConfigurations()
public String	removeResourceAlias(String alias)
protected void	resolveWebApp() Resolve Web App directory If the BaseResource has not been set, use the war resource to derive a webapp resource (expanding WAR if required).
public void	setClassLoader(ClassLoader The classLoader to set. classLoader) Overrides org.mortbay.jetty.handler.ContextHandler.setClassLoader.
public void	setConfigurationClasses(String[] The configuration class names. If setConfigurations is not called these classes are used to create a configurations array. configurations)
public void	setConfigurations(Configuration[] The configurations to set. configurations)
public void	setCopyWebDir(boolean True if the webdir is copied (to allow hot replacement of jars) copy)
public void	setDefaultsDescriptor(String The defaultsDescriptor to set. defaultsDescriptor) The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml
public void	setDescriptor(String the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists. descriptor)
public void	setDisplayName(String The servletContextName to set. servletContextName) Overrides org.mortbay.jetty.handler.ContextHandler.setDisplayName.
public void	setDistributable(boolean The distributable to set. distributable)
public void	setEventListeners(EventListener[] eventListeners) Overrides org.mortbay.jetty.handler.ContextHandler.setEventListeners. Set the context event listeners.
public void	setExtraClasspath(String Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'. extraClasspath)
public void	setExtractWAR(boolean True if war files are extracted extractWAR)
public void	setLogUrlOnStart(boolean whether or not the log message is created logOnStart) Sets whether or not the web app name and URL is logged on startup
public void	setOverrideDescriptor(String The overrideDescritpor to set. overrideDescriptor) The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
public void	setParentLoaderPriority(boolean The java2compliant to set. java2compliant)
public void	setPermissions(PermissionCollection The permissions to set. permissions)
public void	setResourceAlias(String alias, String uri) Set Resource Alias.
public void	setResourceAliases(Map<K, V> map)
public void	setServerClasses(String[] The serverClasses to set. serverClasses) Set the server classes patterns.
public void	setSystemClasses(String[] The systemClasses to set. systemClasses) Set the system classes patterns.
public void	setTempDirectory(File Writable temporary directory. dir) Set temporary directory for context.
public void	setWar(String The war to set as a file name or URL war)
protected void	startContext() Overrides org.mortbay.jetty.servlet.Context.startContext.
public String	toString() Overrides org.mortbay.jetty.handler.ContextHandler.toString. Returns a string representation of the object.

Inherited from org.mortbay.jetty.servlet.Context:: addFilter addFilter addFilter addServlet addServlet addServlet getSecurityHandler getServletHandler getSessionHandler setSecurityHandler setServletHandler setSessionHandler

__dftConfigurationClasses	back to summary
private static String[] __dftConfigurationClasses

_configurationClasses	back to summary
private String[] _configurationClasses

_configurations	back to summary
private Configuration[] _configurations

_copyDir	back to summary
private boolean _copyDir

_defaultsDescriptor	back to summary
private String _defaultsDescriptor

_descriptor	back to summary
private String _descriptor

_distributable	back to summary
private boolean _distributable

_extraClasspath	back to summary
private String _extraClasspath

_extractWAR	back to summary
private boolean _extractWAR

_isExistingTmpDir	back to summary
private boolean _isExistingTmpDir

_logUrlOnStart	back to summary
private boolean _logUrlOnStart

_overrideDescriptor	back to summary
private String _overrideDescriptor

_ownClassLoader	back to summary
private transient boolean _ownClassLoader

_parentLoaderPriority	back to summary
private boolean _parentLoaderPriority

_permissions	back to summary
private PermissionCollection _permissions

_resourceAliases	back to summary
private transient Map<K, V> _resourceAliases

_serverClasses	back to summary
private String[] _serverClasses

_systemClasses	back to summary
private String[] _systemClasses

_tmpDir	back to summary
private File _tmpDir

_unavailable	back to summary
private transient boolean _unavailable

_unavailableException	back to summary
private Throwable _unavailableException

_war	back to summary
private String _war

ERROR_PAGE	back to summary
public static final String ERROR_PAGE

WEB_DEFAULTS_XML	back to summary
public static final String WEB_DEFAULTS_XML

WebAppContext	back to summary
public WebAppContext()

WebAppContext	back to summary
public WebAppContext(String webApp, String contextPath) Parameters webApp:String The URL or filename of the webapp directory or war file. contextPath:String The context path

WebAppContext	back to summary
public WebAppContext(HandlerContainer parent, String webApp, String contextPath) Parameters parent:HandlerContainer The parent HandlerContainer. webApp:String The URL or filename of the webapp directory or war file. contextPath:String The context path

WebAppContext	back to summary
public WebAppContext(ConstraintsSecurityHandler securityHandler, SessionHandler sessionHandler, ServletHandler servletHandler, ErrorHandler errorHandler)

Method Detail

addEventListener back to summary

addEventListener	back to summary
public void addEventListener(EventListener listener) Overrides org.mortbay.jetty.handler.ContextHandler.addEventListener. Add EventListener Conveniance method that calls `setEventListeners(EventListener[])`

public void addEventListener(EventListener listener)

Overrides org.mortbay.jetty.handler.ContextHandler.addEventListener.

Add EventListener Conveniance method that calls setEventListeners(EventListener[])

doStart	back to summary
protected void doStart() throws Exception Overrides org.mortbay.jetty.handler.ContextHandler.doStart.

doStop	back to summary
protected void doStop() throws Exception Overrides org.mortbay.jetty.handler.ContextHandler.doStop.

dumpUrl	back to summary
public void dumpUrl()

getCanonicalNameForWebAppTmpDir	back to summary
private String getCanonicalNameForWebAppTmpDir() Create a canonical name for a webapp tmp directory. The form of the name is: "Jetty_"+host+"_"+port+"__"+resourceBase+"_"+context+"_"+virtualhost+base36 hashcode of whole string host and port uniquely identify the server context and virtual host uniquely identify the webapp

getConfigurationClasses	back to summary
public String[] getConfigurationClasses() Returns:String[] Returns the configurations.

getConfigurations	back to summary
public Configuration[] getConfigurations() Returns:Configuration[] Returns the configurations.

getConstraintsSecurityHandler	back to summary
public ConstraintsSecurityHandler getConstraintsSecurityHandler()

getCurrentWebAppContext	back to summary
public static ContextHandler getCurrentWebAppContext()

getDefaultsDescriptor	back to summary
public String getDefaultsDescriptor() The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml Returns:String Returns the defaultsDescriptor.

getDefaultsDescriptor

back to summary

public String getDefaultsDescriptor()

The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml

Returns:String: Returns the defaultsDescriptor.

getDescriptor	back to summary
public String getDescriptor() Returns:String the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists.

getExtraClasspath	back to summary
public String getExtraClasspath() Returns:String Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.

getOverrideDescriptor	back to summary
public String getOverrideDescriptor() The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml Returns:String Returns the Override Descriptor.

getOverrideDescriptor

back to summary

public String getOverrideDescriptor()

The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml

Returns:String: Returns the Override Descriptor.

getPermissions	back to summary
public PermissionCollection getPermissions() Returns:PermissionCollection Returns the permissions.

getResource	back to summary
public Resource getResource(String uriInContext) throws MalformedURLException Overrides org.mortbay.jetty.handler.ContextHandler.getResource.

getResourceAlias	back to summary
public String getResourceAlias(String alias)

getResourceAliases	back to summary
public Map<K, V> getResourceAliases()

getServerClasses	back to summary
public String[] getServerClasses() Returns:String[] Returns the serverClasses. See Also `setServerClasses(String[])`

getSystemClasses	back to summary
public String[] getSystemClasses() Returns:String[] Returns the systemClasses. See Also `setSystemClasses(String[])`

getTempDirectory

back to summary

public File getTempDirectory()

Get a temporary directory in which to unpack the war etc etc. The algorithm for determining this is to check these alternatives in the order shown:

A. Try to use an explicit directory specifically for this webapp:

Iff an explicit directory is set for this webapp, use it. Do NOT set delete on exit.
Iff javax.servlet.context.tempdir context attribute is set for this webapp && exists && writeable, then use it. Do NOT set delete on exit.

B. Create a directory based on global settings. The new directory will be called "Jetty_"+host+"_"+port+"__"+context+"_"+virtualhost Work out where to create this directory:

Iff $(jetty.home)/work exists create the directory there. Do NOT set delete on exit. Do NOT delete contents if dir already exists.
Iff WEB-INF/work exists create the directory there. Do NOT set delete on exit. Do NOT delete contents if dir already exists.
Else create dir in $(java.io.tmpdir). Set delete on exit. Delete contents if dir already exists.

getUnavailableException

back to summary

public Throwable getUnavailableException()

Get an exception that caused the webapp to be unavailable

Returns:Throwable: A throwable if the webapp is unavailable or null

getWar	back to summary
public String getWar() Returns:String Returns the war as a file or URL string (Resource)

getWebInf	back to summary
public Resource getWebInf() throws IOException

handle back to summary

public void handle(String target, HttpServletRequest request, HttpServletResponse response, int dispatch) throws IOException, ServletException

Overrides org.mortbay.jetty.handler.ContextHandler.handle.

Implements org.mortbay.jetty.Handler.handle.

Doc from org.mortbay.jetty.Handler.handle.

Handle a request.

Parameters

target:String: The target of the request - either a URI or a name.
request:HttpServletRequest: The request either as the Request object or a wrapper of that request. The HttpConnection#getCurrentConnection() method can be used access the Request object if required.
response:HttpServletResponse: The response as the Response object or a wrapper of that request. The HttpConnection#getCurrentConnection() method can be used access the Response object if required.
dispatch:int: The dispatch mode: REQUEST, FORWARD, INCLUDE, ERROR

See Also

org.mortbay.jetty.handler.ContextHandler#handle(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)

isCopyWebDir	back to summary
public boolean isCopyWebDir() Returns:boolean True if the webdir is copied (to allow hot replacement of jars)

isDistributable	back to summary
public boolean isDistributable() Returns:boolean Returns the distributable.

isExtractWAR	back to summary
public boolean isExtractWAR() Returns:boolean Returns the extractWAR.

isLogUrlOnStart	back to summary
public boolean isLogUrlOnStart()

isParentLoaderPriority	back to summary
public boolean isParentLoaderPriority() Returns:boolean Returns the java2compliant.

isProtectedTarget back to summary

protected boolean isProtectedTarget(String target)

Overrides org.mortbay.jetty.handler.ContextHandler.isProtectedTarget.

Doc from org.mortbay.jetty.handler.ContextHandler.isProtectedTarget.

Check the target. Called by handle(String, HttpServletRequest, HttpServletResponse, int) when a target within a context is determined. If the target is protected, 404 is returned. The default implementation always returns false.

isServerClass	back to summary
public boolean isServerClass(String name)

isSystemClass	back to summary
public boolean isSystemClass(String name)

isTempWorkDirectory	back to summary
public boolean isTempWorkDirectory() Check if the _tmpDir itself is called "work", or if the _tmpDir is in a directory called "work".

loadConfigurations	back to summary
protected void loadConfigurations() throws Exception

removeResourceAlias	back to summary
public String removeResourceAlias(String alias)

resolveWebApp	back to summary
protected void resolveWebApp() throws IOException Resolve Web App directory If the BaseResource has not been set, use the war resource to derive a webapp resource (expanding WAR if required).

setClassLoader

back to summary

public void setClassLoader(ClassLoader classLoader)

Overrides org.mortbay.jetty.handler.ContextHandler.setClassLoader.

Parameters

classLoader:ClassLoader

Doc from org.mortbay.jetty.handler.ContextHandler.setClassLoader.

The classLoader to set.

setConfigurationClasses	back to summary
public void setConfigurationClasses(String[] configurations) Parameters configurations:String[] The configuration class names. If setConfigurations is not called these classes are used to create a configurations array.

setConfigurations	back to summary
public void setConfigurations(Configuration[] configurations) Parameters configurations:Configuration[] The configurations to set.

setCopyWebDir	back to summary
public void setCopyWebDir(boolean copy) Parameters copy:boolean True if the webdir is copied (to allow hot replacement of jars)

setDefaultsDescriptor

back to summary

public void setDefaultsDescriptor(String defaultsDescriptor)

The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml

Parameters

defaultsDescriptor:String: The defaultsDescriptor to set.

setDescriptor	back to summary
public void setDescriptor(String descriptor) Parameters descriptor:String the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists.

setDisplayName

back to summary

public void setDisplayName(String servletContextName)

Overrides org.mortbay.jetty.handler.ContextHandler.setDisplayName.

Parameters

servletContextName:String: The servletContextName to set.

setDistributable	back to summary
public void setDistributable(boolean distributable) Parameters distributable:boolean The distributable to set.

setEventListeners

back to summary

public void setEventListeners(EventListener[] eventListeners)

Overrides org.mortbay.jetty.handler.ContextHandler.setEventListeners.

Doc from org.mortbay.jetty.handler.ContextHandler.setEventListeners.

Set the context event listeners.

setExtraClasspath	back to summary
public void setExtraClasspath(String extraClasspath) Parameters extraClasspath:String Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.

setExtractWAR	back to summary
public void setExtractWAR(boolean extractWAR) Parameters extractWAR:boolean True if war files are extracted

setLogUrlOnStart

back to summary

public void setLogUrlOnStart(boolean logOnStart)

Sets whether or not the web app name and URL is logged on startup

Parameters

logOnStart:boolean: whether or not the log message is created

setOverrideDescriptor

back to summary

public void setOverrideDescriptor(String overrideDescriptor)

The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml

Parameters

overrideDescriptor:String: The overrideDescritpor to set.

setParentLoaderPriority	back to summary
public void setParentLoaderPriority(boolean java2compliant) Parameters java2compliant:boolean The java2compliant to set.

setPermissions	back to summary
public void setPermissions(PermissionCollection permissions) Parameters permissions:PermissionCollection The permissions to set.

setResourceAlias	back to summary
public void setResourceAlias(String alias, String uri) Set Resource Alias. Resource aliases map resource uri's within a context. They may optionally be used by a handler when looking for a resource.

setResourceAliases	back to summary
public void setResourceAliases(Map<K, V> map)

setServerClasses

back to summary

public void setServerClasses(String[] serverClasses)

Set the server classes patterns.

Server classes/packages are classes used to implement the server and are hidden from the context. If the context needs to load these classes, it must have its own copy of them in WEB-INF/lib or WEB-INF/classes. A class pattern is a string of one of the forms:

org.package.Classname: Match a specific class
org.package.: Match a specific package hierarchy
-org.package.Classname: Exclude a specific class
-org.package.: Exclude a specific package hierarchy

Parameters

serverClasses:String[]: The serverClasses to set.

setSystemClasses back to summary

public void setSystemClasses(String[] systemClasses)

Set the system classes patterns.

System classes/packages are classes provided by the JVM and that cannot be replaced by classes of the same name from WEB-INF, regardless of the value of setParentLoaderPriority(boolean). A class pattern is a string of one of the forms:

org.package.Classname: Match a specific class
org.package.: Match a specific package hierarchy
-org.package.Classname: Exclude a specific class
-org.package.: Exclude a specific package hierarchy

Parameters

systemClasses:String[]: The systemClasses to set.

setTempDirectory

back to summary

public void setTempDirectory(File dir)

Set temporary directory for context. The javax.servlet.context.tempdir attribute is also set.

Parameters

dir:File: Writable temporary directory.

setWar	back to summary
public void setWar(String war) Parameters war:String The war to set as a file name or URL

startContext	back to summary
protected void startContext() throws Exception Overrides org.mortbay.jetty.servlet.Context.startContext.

toString

back to summary

public String toString()

Overrides org.mortbay.jetty.handler.ContextHandler.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

public Class WebAppContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail