Package org.eclipse.jetty.webapp

Class WebAppContext

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.ScopedHandler

org.eclipse.jetty.server.handler.ContextHandler

org.eclipse.jetty.servlet.ServletContextHandler

org.eclipse.jetty.webapp.WebAppContext

All Implemented Interfaces:

Handler, HandlerContainer, Attributes, ClassVisibilityChecker, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, Graceful, LifeCycle, WebAppClassLoader.Context

Direct Known Subclasses:

AntWebAppContext

@ManagedObject("Web Application ContextHandler")
public class WebAppContext
extends ServletContextHandler
implements WebAppClassLoader.Context

Web Application Context Handler.

The WebAppContext handler is an extension of ContextHandler that coordinates the construction and configuration of nested handlers: ConstraintSecurityHandler, SessionHandler and ServletHandler. The handlers are configured by pluggable configuration classes, with the default being WebXmlConfiguration and JettyWebXmlConfiguration.

The Start/Configuration of a WebAppContext is rather complex so as to allow pluggable behaviour to be added in almost arbitrary ordering. The sequence of a WebappContext start is as follows:

doStart():

• preConfigure()
  • Add all Server class inclusions from all known configurations Configurations.getKnown()
  • loadConfigurations(), which uses either explicitly set Configurations or takes the server default (which is all known Configuration.isEnabledByDefault() Configurations.
  • Sort the configurations using TopologicalSort in Configurations.sort().
  • Add all Server class exclusions from this webapps Configurations
  • Add all System classes inclusions and exclusions for this webapps Configurations
  • Instantiate the WebAppClassLoader (if one not already explicitly set)
  • Configuration.preConfigure(WebAppContext) which calls Configuration.preConfigure(WebAppContext) for this webapps Configurations
• ServletContextHandler.doStart()
  • ContextHandler.doStart()
    • Init MimeTypes
    • enterScope
      • startContext()
        • configure()
          • Call Configuration.configure(WebAppContext) on enabled Configurations
        • MetaData.resolve(WebAppContext)
        • startContext()
        • QuickStart may generate here and/or abort start
          • ServletContextHandler.startContext()
            • Decorate listeners
            • ContextHandler.startContext()
              • add ManagedAttributeListener
              • AbstractHandler.doStart()
              • ServletContextHandler.callContextInitialized(javax.servlet.ServletContextListener, javax.servlet.ServletContextEvent)
            • ServletHandler.initialize()
    • exitScope
• postConfigure()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WebAppContext.Context

Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.ServletContextHandler

ServletContextHandler.Initializer, ServletContextHandler.JspConfig, ServletContextHandler.JspPropertyGroup, ServletContextHandler.ServletContainerInitializerCaller, ServletContextHandler.ServletContainerInitializerStarter, ServletContextHandler.TagLib

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.ContextHandler

ContextHandler.AliasCheck, ContextHandler.ApproveAliases, ContextHandler.ApproveNonExistentDirectoryAliases, ContextHandler.Availability, ContextHandler.ContextScopeListener, ContextHandler.ContextStatus, ContextHandler.StaticContext

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Graceful

Graceful.Shutdown, Graceful.ThrowingRunnable

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final ClassMatcher	__dftServerClasses
static final ClassMatcher	__dftSystemClasses
static final String	BASETEMPDIR
static final String	ERROR_PAGE
static final String	SERVER_SRV_CLASSES
static final String	SERVER_SYS_CLASSES
static final String	TEMPDIR
static final String	WEB_DEFAULTS_XML

Fields inherited from class org.eclipse.jetty.servlet.ServletContextHandler

_defaultSecurityHandlerClass, _jspConfig, _objFactory, _options, _securityHandler, _servletHandler, _sessionHandler, NO_SECURITY, NO_SESSIONS, SECURITY, SESSIONS

Fields inherited from class org.eclipse.jetty.server.handler.ContextHandler

_contextStatus, _scontext, DEFAULT_LISTENER_TYPE_INDEX, DEFAULT_MAX_FORM_CONTENT_SIZE, DEFAULT_MAX_FORM_KEYS, EXTENDED_LISTENER_TYPE_INDEX, MANAGED_ATTRIBUTES, MAX_FORM_CONTENT_SIZE_KEY, MAX_FORM_KEYS_KEY, SERVLET_LISTENER_TYPES, SERVLET_MAJOR_VERSION, SERVLET_MINOR_VERSION

Fields inherited from class org.eclipse.jetty.server.handler.ScopedHandler

_nextScope, _outerScope

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
WebAppContext()
WebAppContext(String webApp, String contextPath)
WebAppContext(HandlerContainer parent, String webApp, String contextPath)
WebAppContext(HandlerContainer parent, String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler, int options)	This constructor is used in the geronimo integration.
WebAppContext(HandlerContainer parent, Resource webApp, String contextPath)
WebAppContext(SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)	This constructor is used in the geronimo integration.
WebAppContext(Resource webApp, String contextPath)

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(Configuration... configuration)
void	addOverrideDescriptor(String overrideDescriptor)	The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
static void	addServerClasses(Server server, String... pattern)
void	addServerClassMatcher(ClassMatcher serverClasses)	Add a ClassMatcher for server classes by combining with any existing matcher.
static void	addSystemClasses(Server server, String... pattern)
void	addSystemClassMatcher(ClassMatcher systemClasses)	Add a ClassMatcher for system classes by combining with any existing matcher.
boolean	configure()
void	destroy()	Destroys the managed Destroyable beans in the reverse order they were added.
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
<T> T	getConfiguration(Class<? extends T> configClass)
String[]	getConfigurationClasses()
Configurations	getConfigurations()
static WebAppContext	getCurrentWebAppContext()
String	getDefaultsDescriptor()	The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml
String	getDescriptor()
List<Resource>	getExtraClasspath()
MetaData	getMetaData()
String	getOverrideDescriptor()	The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
List<String>	getOverrideDescriptors()	An override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
PermissionCollection	getPermissions()
Resource	getResource(String pathInContext)	Attempt to get a Resource from the Context.
String	getResourceAlias(String path)
Map<String,String>	getResourceAliases()
String[]	getServerClasses()
ClassMatcher	getServerClassMatcher()
String[]	getSystemClasses()
ClassMatcher	getSystemClassMatcher()
File	getTempDirectory()
Throwable	getUnavailableException()	Get an exception that caused the webapp to be unavailable
String	getWar()
Resource	getWebInf()
boolean	isAllowDuplicateFragmentNames()
boolean	isConfigurationDiscovered()	Is the context Automatically configured.
boolean	isCopyWebDir()
boolean	isCopyWebInf()
boolean	isDistributable()
boolean	isExtractWAR()
boolean	isLogUrlOnStart()
boolean	isParentLoaderPriority()
boolean	isPersistTempDirectory()
boolean	isServerClass(Class<?> clazz)	Is the class a Server Class.
boolean	isServerResource(String name, URL url)
boolean	isSystemClass(Class<?> clazz)	Is the class a System Class.
boolean	isSystemResource(String name, URL url)
boolean	isThrowUnavailableOnStartupException()
protected void	loadConfigurations()
protected Configurations	newConfigurations()
void	postConfigure()
void	preConfigure()	Pre configure the web application.
void	removeConfiguration(Class<? extends Configuration>... configurations)
void	removeConfiguration(Configuration... configurations)
boolean	removeEventListener(EventListener listener)	Remove an event listener.
String	removeResourceAlias(String alias)
void	setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)
void	setClassLoader(ClassLoader classLoader)
void	setConfigurationClasses(String[] configurations)
void	setConfigurationClasses(List<String> configurations)
void	setConfigurationDiscovered(boolean discovered)	Set the configuration discovery mode.
void	setConfigurations(Configuration[] configurations)
void	setContextWhiteList(String... contextWhiteList)	Set the context white list In certain circumstances you want may want to deny access of one webapp from another when you may not fully trust the webapp.
void	setCopyWebDir(boolean copy)
void	setCopyWebInf(boolean copyWebInf)
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
void	setDescriptor(String descriptor)
void	setDisplayName(String servletContextName)
void	setDistributable(boolean distributable)
void	setExtraClasspath(String extraClasspath)	Set the Extra ClassPath via delimited String.
void	setExtraClasspath(List<Resource> extraClasspath)
void	setExtractWAR(boolean extractWAR)
void	setLogUrlOnStart(boolean logOnStart)	Sets whether or not the web app name and URL is logged on startup
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
void	setOverrideDescriptors(List<String> overrideDescriptors)	The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml
void	setParentLoaderPriority(boolean java2compliant)
void	setPermissions(PermissionCollection permissions)
void	setPersistTempDirectory(boolean persist)	If true the temp directory for this webapp will be kept when the webapp stops.
void	setResourceAlias(String alias, String uri)	Set Resource Alias.
void	setResourceAliases(Map<String,String> map)
void	setServer(Server server)
void	setServerClassMatcher(ClassMatcher serverClasses)	Set the server classes patterns.
Set<String>	setServletSecurity(javax.servlet.ServletRegistration.Dynamic registration, javax.servlet.ServletSecurityElement servletSecurityElement)	Delegate for ServletRegistration.Dynamic.setServletSecurity method
void	setSystemClassMatcher(ClassMatcher systemClasses)	Set the system classes patterns.
void	setTempDirectory(File dir)	Set temporary directory for context.
void	setThrowUnavailableOnStartupException(boolean throwIfStartupException)
void	setWar(String war)	Set the war of the webapp.
void	setWarResource(Resource war)	Set the war of the webapp as a Resource.
protected void	startContext()	Finish constructing handlers and link them together.
protected void	stopContext()
String	toString()

Methods inherited from class org.eclipse.jetty.servlet.ServletContextHandler

addEventListener, addFilter, addFilter, addFilter, addRoles, addServlet, addServlet, addServlet, addServletContainerInitializer, addServletContainerInitializer, addServletContainerInitializer, callContextDestroyed, callContextInitialized, doStop, dynamicHolderAdded, getDefaultSecurityHandlerClass, getObjectFactory, getSecurityHandler, getServletContextHandler, getServletContextHandler, getServletHandler, getSessionHandler, insertHandler, newSecurityHandler, newServletHandler, newSessionHandler, setDefaultSecurityHandlerClass, setGzipHandler, setHandler, setParent, setSecurityHandler, setServletHandler, setSessionHandler

Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler

addAliasCheck, addLocaleEncoding, addProgrammaticListener, addVirtualHosts, checkAlias, checkContext, checkContextPath, checkVirtualHost, clearAliasChecks, clearAttributes, contextDestroyed, contextInitialized, doHandle, doScope, enterScope, exitScope, getAliasChecks, getAllowNullPathInfo, getAttribute, getAttributeNames, getAttributeNameSet, getAttributes, getBaseResource, getClassLoader, getClassPath, getContextHandler, getContextPath, getContextPathEncoded, getCurrentContext, getDefaultRequestCharacterEncoding, getDefaultResponseCharacterEncoding, getDisplayName, getErrorHandler, getInitParameter, getInitParameterNames, getInitParams, getLocaleEncoding, getLocaleEncoding, getLocaleEncodings, getLogger, getMaxFormContentSize, getMaxFormKeys, getMimeTypes, getProtectedTargets, getRequestContextPath, getResourceBase, getResourcePaths, getServerInfo, getServletContext, getVirtualHosts, getWelcomeFiles, handle, handle, isAvailable, isCompactPath, isContextPathDefault, isDurableListener, isProgrammaticListener, isProtectedTarget, isShutdown, isUsingSecurityManager, loadClass, newResource, newResource, newResource, removeAttribute, removeVirtualHosts, requestDestroyed, requestInitialized, setAliasChecks, setAllowNullPathInfo, setAttribute, setAttributes, setAvailable, setBaseResource, setCompactPath, setContextPath, setDefaultContextPath, setDefaultRequestCharacterEncoding, setDefaultResponseCharacterEncoding, setErrorHandler, setInitParameter, setLogger, setMaxFormContentSize, setMaxFormKeys, setMimeTypes, setProtectedTargets, setResourceBase, setServerInfo, setUsingSecurityManager, setVirtualHosts, setWelcomeFiles, shutdown

Methods inherited from class org.eclipse.jetty.server.handler.ScopedHandler

handle, nextHandle, nextScope

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

expandChildren, getHandler, getHandlers

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop

Methods inherited from interface org.eclipse.jetty.webapp.WebAppClassLoader.Context

newResource

Field Details

TEMPDIR

public static final String TEMPDIR

See Also:

• Constant Field Values

BASETEMPDIR

public static final String BASETEMPDIR

See Also:

• Constant Field Values

WEB_DEFAULTS_XML

public static final String WEB_DEFAULTS_XML

See Also:

• Constant Field Values

ERROR_PAGE

public static final String ERROR_PAGE

See Also:

• Constant Field Values

SERVER_SYS_CLASSES

public static final String SERVER_SYS_CLASSES

See Also:

• Constant Field Values

SERVER_SRV_CLASSES

public static final String SERVER_SRV_CLASSES

See Also:

• Constant Field Values

__dftSystemClasses

public static final ClassMatcher __dftSystemClasses

__dftServerClasses

public static final ClassMatcher __dftServerClasses

Constructor Details

WebAppContext

public WebAppContext()

WebAppContext

public WebAppContext(String webApp,
 String contextPath)

Parameters:

webApp - The URL or filename of the webapp directory or war file.

contextPath - The context path

WebAppContext

public WebAppContext(Resource webApp,
 String contextPath)

Parameters:

webApp - The URL or filename of the webapp directory or war file.

contextPath - The context path

WebAppContext

public WebAppContext(HandlerContainer parent,
 String webApp,
 String contextPath)

Parameters:

parent - The parent HandlerContainer.

webApp - The URL or filename of the webapp directory or war file.

contextPath - The context path

WebAppContext

public WebAppContext(HandlerContainer parent,
 Resource webApp,
 String contextPath)

Parameters:

parent - The parent HandlerContainer.

webApp - The webapp directory or war file.

contextPath - The context path

WebAppContext

public WebAppContext(SessionHandler sessionHandler,
 SecurityHandler securityHandler,
 ServletHandler servletHandler,
 ErrorHandler errorHandler)

This constructor is used in the geronimo integration.

Parameters:

sessionHandler - SessionHandler for this web app

securityHandler - SecurityHandler for this web app

servletHandler - ServletHandler for this web app

errorHandler - ErrorHandler for this web app

WebAppContext

public WebAppContext(HandlerContainer parent,
 String contextPath,
 SessionHandler sessionHandler,
 SecurityHandler securityHandler,
 ServletHandler servletHandler,
 ErrorHandler errorHandler,
 int options)

This constructor is used in the geronimo integration.

Parameters:

parent - the parent handler

contextPath - the context path

sessionHandler - SessionHandler for this web app

securityHandler - SecurityHandler for this web app

servletHandler - ServletHandler for this web app

errorHandler - ErrorHandler for this web app

options - the options (ServletContextHandler.SESSIONS and/or ServletContextHandler.SECURITY)

Method Details

getCurrentWebAppContext

public static WebAppContext getCurrentWebAppContext()

setDisplayName

public void setDisplayName(String servletContextName)

Overrides:

setDisplayName in class ContextHandler

Parameters:

servletContextName - The servletContextName to set.

getUnavailableException

public Throwable getUnavailableException()

Get an exception that caused the webapp to be unavailable

Returns:

A throwable if the webapp is unavailable or null

setResourceAlias

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.

Parameters:

alias - the alias for a resource

uri - the uri for the resource

getResourceAliases

public Map<String,String> getResourceAliases()

setResourceAliases

public void setResourceAliases(Map<String,String> map)

getResourceAlias

public String getResourceAlias(String path)

removeResourceAlias

public String removeResourceAlias(String alias)

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Overrides:

setClassLoader in class ContextHandler

Parameters:

classLoader - The classLoader to set.

getResource

public Resource getResource(String pathInContext)
                     throws MalformedURLException

Description copied from class: ContextHandler

Attempt to get a Resource from the Context.

Overrides:

getResource in class ContextHandler

Parameters:

pathInContext - the path within the base resource to attempt to get

Returns:

the resource, or null if not available.

Throws:

MalformedURLException - if unable to form a Resource from the provided path

isConfigurationDiscovered

public boolean isConfigurationDiscovered()

Is the context Automatically configured.

Returns:

true if configuration discovery.

setConfigurationDiscovered

public void setConfigurationDiscovered(boolean discovered)

Set the configuration discovery mode. If configuration discovery is set to true, then the JSR315 servlet 3.0 discovered configuration features are enabled. These are:

• Web Fragments
• META-INF/resource directories

Parameters:

discovered - true if configuration discovery is enabled for automatic configuration from the context

preConfigure

public void preConfigure()
                  throws Exception

Pre configure the web application.

The method is normally called from AbstractLifeCycle.start(). It performs the discovery of the configurations to be applied to this context, specifically:

• Instantiate the Configuration instances with a call to loadConfigurations().
• Instantiates a classloader (if one is not already set)
• Calls the Configuration.preConfigure(WebAppContext) method of all Configuration instances.

Throws:

Exception - if unable to pre configure

configure

public boolean configure()
                  throws Exception

Throws:

Exception

postConfigure

public void postConfigure()
                   throws Exception

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ServletContextHandler

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state

destroy

public void destroy()

Description copied from class: ContainerLifeCycle

Destroys the managed Destroyable beans in the reverse order they were added.

Specified by:

destroy in interface Destroyable

Specified by:

destroy in interface Handler

Overrides:

destroy in class HandlerWrapper

getConfigurationClasses

@ManagedAttribute(value="configuration classes used to configure webapp",
                  readonly=true)
public String[] getConfigurationClasses()

Returns:

Returns the configurations.

getConfigurations

public Configurations getConfigurations()

Returns:

Returns the configurations.

getDefaultsDescriptor

@ManagedAttribute(value="default web.xml deascriptor applied before standard web.xml",
                  readonly=true)
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:

Returns the defaultsDescriptor.

getOverrideDescriptor

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:

Returns the Override Descriptor.

getOverrideDescriptors

@ManagedAttribute(value="web.xml deascriptors applied after standard web.xml",
                  readonly=true)
public List<String> getOverrideDescriptors()

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

Returns:

Returns the Override Descriptor list

getPermissions

public PermissionCollection getPermissions()

Specified by:

getPermissions in interface WebAppClassLoader.Context

Returns:

Returns the permissions.

setServerClassMatcher

public void setServerClassMatcher(ClassMatcher 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.

Parameters:

serverClasses - the server classes pattern

setSystemClassMatcher

public void setSystemClassMatcher(ClassMatcher 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).

Parameters:

systemClasses - the system classes pattern

addServerClassMatcher

public void addServerClassMatcher(ClassMatcher serverClasses)

Add a ClassMatcher for server classes by combining with any existing matcher.

Parameters:

serverClasses - The class matcher of patterns to add to the server ClassMatcher

addSystemClassMatcher

public void addSystemClassMatcher(ClassMatcher systemClasses)

Add a ClassMatcher for system classes by combining with any existing matcher.

Parameters:

systemClasses - The class matcher of patterns to add to the system ClassMatcher

getSystemClassMatcher

public ClassMatcher getSystemClassMatcher()

Returns:

The ClassMatcher used to match System (protected) classes

getServerClassMatcher

public ClassMatcher getServerClassMatcher()

Returns:

The ClassMatcher used to match Server (hidden) classes

getSystemClasses

@ManagedAttribute(value="classes and packages protected by context classloader",
                  readonly=true)
public String[] getSystemClasses()

getServerClasses

@ManagedAttribute(value="classes and packages hidden by the context classloader",
                  readonly=true)
public String[] getServerClasses()

isServerClass

public boolean isServerClass(Class<?> clazz)

Description copied from interface: ClassVisibilityChecker

Is the class a Server Class. A Server class is a class that is part of the implementation of the server and is NIT visible to a webapplication. The web application may provide it's own implementation of the class, to be loaded from WEB-INF/lib or WEB-INF/classes

Specified by:

isServerClass in interface ClassVisibilityChecker

Parameters:

clazz - The fully qualified name of the class.

Returns:

True if the class is a server class.

isSystemClass

public boolean isSystemClass(Class<?> clazz)

Description copied from interface: ClassVisibilityChecker

Is the class a System Class. A System class is a class that is visible to a webapplication, but that cannot be overridden by the contents of WEB-INF/lib or WEB-INF/classes

Specified by:

isSystemClass in interface ClassVisibilityChecker

Parameters:

clazz - The fully qualified name of the class.

Returns:

True if the class is a system class.

isServerResource

public boolean isServerResource(String name,
 URL url)

Specified by:

isServerResource in interface WebAppClassLoader.Context

isSystemResource

public boolean isSystemResource(String name,
 URL url)

Specified by:

isSystemResource in interface WebAppClassLoader.Context

setServer

public void setServer(Server server)

Specified by:

setServer in interface Handler

Overrides:

setServer in class ContextHandler

getWar

@ManagedAttribute(value="war file location",
                  readonly=true)
public String getWar()

Returns:

Returns the war as a file or URL string (Resource). The war may be different to the @link ContextHandler.getResourceBase() if the war has been expanded and/or copied.

getWebInf

public Resource getWebInf()
                   throws IOException

Throws:

IOException

isDistributable

@ManagedAttribute("web application distributable")
public boolean isDistributable()

Returns:

Returns the distributable.

isExtractWAR

@ManagedAttribute(value="extract war",
                  readonly=true)
public boolean isExtractWAR()

Returns:

Returns the extractWAR.

isCopyWebDir

@ManagedAttribute(value="webdir copied on deploy (allows hot replacement on windows)",
                  readonly=true)
public boolean isCopyWebDir()

Returns:

True if the webdir is copied (to allow hot replacement of jars on windows)

isCopyWebInf

public boolean isCopyWebInf()

Returns:

True if the web-inf lib and classes directories are copied (to allow hot replacement of jars on windows)

isParentLoaderPriority

@ManagedAttribute(value="parent classloader given priority",
                  readonly=true)
public boolean isParentLoaderPriority()

Specified by:

isParentLoaderPriority in interface WebAppClassLoader.Context

Returns:

True if the classloader should delegate first to the parent classloader (standard java behaviour) or false if the classloader should first try to load from WEB-INF/lib or WEB-INF/classes (servlet spec recommendation). Default is false or can be set by the system property org.eclipse.jetty.server.webapp.parentLoaderPriority

loadConfigurations

protected void loadConfigurations()

newConfigurations

protected Configurations newConfigurations()

toString

public String toString()

Overrides:

toString in class ContextHandler

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContextHandler

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

setConfigurationClasses

public void setConfigurationClasses(String[] configurations)

Parameters:

configurations - The configuration class names. If setConfigurations is not called these classes are used to create a configurations array.

setConfigurationClasses

public void setConfigurationClasses(List<String> configurations)

setConfigurations

public void setConfigurations(Configuration[] configurations)

Parameters:

configurations - The configurations to set.

addConfiguration

public void addConfiguration(Configuration... configuration)

getConfiguration

public <T> T getConfiguration(Class<? extends T> configClass)

removeConfiguration

public void removeConfiguration(Configuration... configurations)

removeConfiguration

public void removeConfiguration(Class<? extends Configuration>... configurations)

setDefaultsDescriptor

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 - The defaultsDescriptor to set.

setOverrideDescriptor

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 - The overrideDescritpor to set.

setOverrideDescriptors

public void setOverrideDescriptors(List<String> overrideDescriptors)

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

Parameters:

overrideDescriptors - The overrideDescriptors (file or URL) to set.

addOverrideDescriptor

public void addOverrideDescriptor(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 - The overrideDescriptor (file or URL) to add.

getDescriptor

@ManagedAttribute(value="standard web.xml descriptor",
                  readonly=true)
public String getDescriptor()

Returns:

the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists.

setDescriptor

public void setDescriptor(String descriptor)

Parameters:

descriptor - the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists.

setDistributable

public void setDistributable(boolean distributable)

Parameters:

distributable - The distributable to set.

removeEventListener

public boolean removeEventListener(EventListener listener)

Description copied from interface: Container

Remove an event listener.

Specified by:

removeEventListener in interface Container

Specified by:

removeEventListener in interface LifeCycle

Overrides:

removeEventListener in class ContextHandler

Parameters:

listener - the listener to remove

Returns:

true if the listener was removed

See Also:

• Container.removeBean(Object)

setExtractWAR

public void setExtractWAR(boolean extractWAR)

Parameters:

extractWAR - True if war files are extracted

setCopyWebDir

public void setCopyWebDir(boolean copy)

Parameters:

copy - True if the webdir is copied (to allow hot replacement of jars)

setCopyWebInf

public void setCopyWebInf(boolean copyWebInf)

Parameters:

copyWebInf - True if the web-inf lib and classes directories are copied (to allow hot replacement of jars on windows)

setParentLoaderPriority

public void setParentLoaderPriority(boolean java2compliant)

Parameters:

java2compliant - True if the classloader should delegate first to the parent classloader (standard java behaviour) or false if the classloader should first try to load from WEB-INF/lib or WEB-INF/classes (servlet spec recommendation). Default is false or can be set by the system property org.eclipse.jetty.server.webapp.parentLoaderPriority

setPermissions

public void setPermissions(PermissionCollection permissions)

Parameters:

permissions - The permissions to set.

setContextWhiteList

public void setContextWhiteList(String... contextWhiteList)

Set the context white list In certain circumstances you want may want to deny access of one webapp from another when you may not fully trust the webapp. Setting this white list will enable a check when a servlet called ContextHandler.Context.getContext(String), validating that the uriInPath for the given webapp has been declaratively allows access to the context.

Parameters:

contextWhiteList - the whitelist of contexts for ContextHandler.Context.getContext(String)

setTempDirectory

public void setTempDirectory(File dir)

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

Parameters:

dir - Writable temporary directory.

getTempDirectory

@ManagedAttribute(value="temporary directory location",
                  readonly=true)
public File getTempDirectory()

setPersistTempDirectory

public void setPersistTempDirectory(boolean persist)

If true the temp directory for this webapp will be kept when the webapp stops. Otherwise, it will be deleted.

Parameters:

persist - true to persist the temp directory on shutdown / exit of the webapp

isPersistTempDirectory

public boolean isPersistTempDirectory()

Returns:

true if tmp directory will persist between startups of the webapp

setWar

public void setWar(String war)

Set the war of the webapp. From this value a ContextHandler.setResourceBase(String) value is computed by WebInfConfiguration, which may be changed from the war URI by unpacking and/or copying.

Parameters:

war - The war to set as a file name or URL.

setWarResource

public void setWarResource(Resource war)

Set the war of the webapp as a Resource.

Parameters:

war - The war to set as a Resource.

See Also:

• setWar(String)

getExtraClasspath

@ManagedAttribute(value="extra classpath for context classloader",
                  readonly=true)
public List<Resource> getExtraClasspath()

Specified by:

getExtraClasspath in interface WebAppClassLoader.Context

Returns:

Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.

setExtraClasspath

public void setExtraClasspath(String extraClasspath)
                       throws IOException

Set the Extra ClassPath via delimited String.

This is a convenience method for setExtraClasspath(List)

Parameters:

extraClasspath - Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.

Throws:

IOException - if unable to resolve the resources referenced

See Also:

• setExtraClasspath(List)

setExtraClasspath

public void setExtraClasspath(List<Resource> extraClasspath)

isLogUrlOnStart

public boolean isLogUrlOnStart()

setLogUrlOnStart

public void setLogUrlOnStart(boolean logOnStart)

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

Parameters:

logOnStart - whether or not the log message is created

isAllowDuplicateFragmentNames

public boolean isAllowDuplicateFragmentNames()

setAllowDuplicateFragmentNames

public void setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)

setThrowUnavailableOnStartupException

public void setThrowUnavailableOnStartupException(boolean throwIfStartupException)

isThrowUnavailableOnStartupException

public boolean isThrowUnavailableOnStartupException()

startContext

protected void startContext()
                     throws Exception

Description copied from class: ServletContextHandler

Finish constructing handlers and link them together.

Overrides:

startContext in class ServletContextHandler

Throws:

Exception - if unable to start the context

See Also:

• ContextHandler.Context

stopContext

protected void stopContext()
                    throws Exception

Overrides:

stopContext in class ServletContextHandler

Throws:

Exception

setServletSecurity

public Set<String> setServletSecurity(javax.servlet.ServletRegistration.Dynamic registration,
 javax.servlet.ServletSecurityElement servletSecurityElement)

Description copied from class: ServletContextHandler

Delegate for ServletRegistration.Dynamic.setServletSecurity method

Overrides:

setServletSecurity in class ServletContextHandler

Parameters:

registration - ServletRegistration.Dynamic instance that setServletSecurity was called on

servletSecurityElement - new security info

Returns:

the set of exact URL mappings currently associated with the registration that are also present in the web.xml security constraints and thus will be unaffected by this call.

getMetaData

public MetaData getMetaData()

addServerClasses

public static void addServerClasses(Server server,
 String... pattern)

addSystemClasses

public static void addSystemClasses(Server server,
 String... pattern)