Class WebAppContext
- All Implemented Interfaces:
Handler
,HandlerContainer
,Attributes
,ClassVisibilityChecker
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,Graceful
,LifeCycle
,WebAppClassLoader.Context
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
.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.eclipse.jetty.servlet.ServletContextHandler
ServletContextHandler.Decorator, ServletContextHandler.Initializer, ServletContextHandler.JspConfig, ServletContextHandler.JspPropertyGroup, ServletContextHandler.ServletContainerInitializerCaller, 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
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
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String[]
static final String[]
private boolean
private boolean
private final List
<Configuration> private String[]
private boolean
private boolean
private String
private String
private boolean
private String
private boolean
private boolean
private MetaData
private boolean
private boolean
private PermissionCollection
private boolean
private ClasspathPattern
private ClasspathPattern
private boolean
private File
private Throwable
private String
static final String
static final String[]
private static final String[]
static final String
(package private) static final Logger
static final String
static final String
static final String
static final String
Fields inherited from class org.eclipse.jetty.servlet.ServletContextHandler
_defaultSecurityHandlerClass, _gzipHandler, _jspConfig, _objFactory, _options, _securityHandler, _servletHandler, _sessionHandler, GZIP, 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
-
Constructor Summary
ConstructorsConstructorDescriptionWebAppContext
(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 TypeMethodDescriptionvoid
addOverrideDescriptor
(String overrideDescriptor) The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xmlvoid
addServerClass
(String classOrPackageOrLocation) Deprecated.static void
addServerClasses
(Server server, String... pattern) void
addSystemClass
(String classOrPackage) Deprecated.static void
addSystemClasses
(Server server, String... pattern) void
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.protected void
doStop()
Stops the managed lifecycle beans in the reverse 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.private void
dumpUrl()
String[]
static WebAppContext
static String[]
The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xmlString[]
String[]
The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xmlAn override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xmlgetResource
(String uriInContext) getResourceAlias
(String path) String[]
String[]
Get an exception that caused the webapp to be unavailablegetWar()
boolean
boolean
Is the context Automatically configured.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isServerClass
(Class<?> clazz) Is the class a Server Class.boolean
isServerClass
(String name) Deprecated.boolean
isServerResource
(String name, URL parentUrl) boolean
isSystemClass
(Class<?> clazz) Is the class a System Class.boolean
isSystemClass
(String name) Deprecated.boolean
isSystemResource
(String name, URL webappUrl) boolean
protected void
protected void
protected void
void
void
Pre configure the web application.void
prependServerClass
(String classOrPackage) Deprecated.void
prependSystemClass
(String classOrPackage) Deprecated.void
removeEventListener
(EventListener listener) Remove a context event listeners.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.xmlvoid
setDescriptor
(String descriptor) void
setDisplayName
(String servletContextName) void
setDistributable
(boolean distributable) void
setEventListeners
(EventListener[] eventListeners) Set the context event listeners.void
setExtraClasspath
(String extraClasspath) void
setExtractWAR
(boolean extractWAR) void
setLogUrlOnStart
(boolean logOnStart) Sets whether or not the web app name and URL is logged on startupvoid
setOverrideDescriptor
(String overrideDescriptor) The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xmlvoid
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.xmlvoid
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
void
setServerClasses
(String[] serverClasses) Set the server classes patterns.setServletSecurity
(javax.servlet.ServletRegistration.Dynamic registration, javax.servlet.ServletSecurityElement servletSecurityElement) Delegate for ServletRegistration.Dynamic.setServletSecurity methodvoid
setSystemClasses
(String[] systemClasses) Set the system classes patterns.void
setTempDirectory
(File dir) Set temporary directory for context.void
setThrowUnavailableOnStartupException
(boolean throwIfStartupException) void
Set the war of the webapp.void
setWarResource
(Resource war) Set the war of the webapp as aResource
.protected void
Finish constructing handlers and link them together.protected void
protected void
protected void
toString()
private Configuration
wrap
(Configuration configuration) Methods inherited from class org.eclipse.jetty.servlet.ServletContextHandler
addDecorator, addEventListener, addFilter, addFilter, addFilter, addRoles, addServlet, addServlet, addServlet, callContextDestroyed, callContextInitialized, dynamicHolderAdded, getDecorators, getDefaultSecurityHandlerClass, getGzipHandler, getObjectFactory, getSecurityHandler, getServletContextHandler, getServletHandler, getSessionHandler, insertHandler, newSecurityHandler, newServletHandler, newSessionHandler, setDecorators, setDefaultSecurityHandlerClass, setGzipHandler, setHandler, 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, getDisplayName, getErrorHandler, getEventListeners, getInitParameter, getInitParameterNames, getInitParams, getLocaleEncoding, getLocaleEncoding, getLocaleEncodings, getLogger, getMaxFormContentSize, getMaxFormKeys, getMimeTypes, getProtectedTargets, getRequestContextPath, getResourceBase, getResourcePaths, getServerInfo, getServletContext, getVirtualHosts, getWelcomeFiles, handle, handle, isAvailable, isCompactPath, isDurableListener, isProgrammaticListener, isProtectedTarget, isShutdown, isUsingSecurityManager, loadClass, newResource, newResource, newResource, removeAttribute, removeVirtualHosts, requestDestroyed, requestInitialized, setAliasChecks, setAllowNullPathInfo, setAttribute, setAttributes, setAvailable, setBaseResource, setCompactPath, setContextPath, setErrorHandler, setInitParameter, setLogger, setManagedAttribute, 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
doShutdown, 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, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, 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.Dumpable.DumpableContainer
isDumpable
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
Methods inherited from interface org.eclipse.jetty.webapp.WebAppClassLoader.Context
newResource
-
Field Details
-
LOG
-
TEMPDIR
- See Also:
-
BASETEMPDIR
- See Also:
-
WEB_DEFAULTS_XML
- See Also:
-
ERROR_PAGE
- See Also:
-
SERVER_SYS_CLASSES
- See Also:
-
SERVER_SRV_CLASSES
- See Also:
-
DEFAULT_PROTECTED_TARGETS
-
DEFAULT_CONFIGURATION_CLASSES
-
__dftSystemClasses
-
__dftServerClasses
-
_configurationClasses
-
_systemClasses
-
_serverClasses
-
_configurations
-
_defaultsDescriptor
-
_descriptor
-
_overrideDescriptors
-
_distributable
private boolean _distributable -
_extractWAR
private boolean _extractWAR -
_copyDir
private boolean _copyDir -
_copyWebInf
private boolean _copyWebInf -
_logUrlOnStart
private boolean _logUrlOnStart -
_parentLoaderPriority
private boolean _parentLoaderPriority -
_permissions
-
_contextWhiteList
-
_tmpDir
-
_persistTmpDir
private boolean _persistTmpDir -
_war
-
_extraClasspath
-
_resourceAliases
-
_ownClassLoader
private boolean _ownClassLoader -
_configurationDiscovered
private boolean _configurationDiscovered -
_allowDuplicateFragmentNames
private boolean _allowDuplicateFragmentNames -
_metadata
-
-
Constructor Details
-
WebAppContext
public WebAppContext() -
WebAppContext
- Parameters:
webApp
- The URL or filename of the webapp directory or war file.contextPath
- The context path
-
WebAppContext
- Parameters:
webApp
- The URL or filename of the webapp directory or war file.contextPath
- The context path
-
WebAppContext
- Parameters:
parent
- The parent HandlerContainer.webApp
- The URL or filename of the webapp directory or war file.contextPath
- The context path
-
WebAppContext
- 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 appsecurityHandler
- SecurityHandler for this web appservletHandler
- ServletHandler for this web apperrorHandler
- 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 handlercontextPath
- the context pathsessionHandler
- SessionHandler for this web appsecurityHandler
- SecurityHandler for this web appservletHandler
- ServletHandler for this web apperrorHandler
- ErrorHandler for this web appoptions
- the options (ServletContextHandler.SESSIONS
and/orServletContextHandler.SECURITY
)
-
-
Method Details
-
getCurrentWebAppContext
-
setDisplayName
- Overrides:
setDisplayName
in classContextHandler
- Parameters:
servletContextName
- The servletContextName to set.
-
setResourceAlias
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 resourceuri
- the uri for the resource
-
getResourceAliases
-
setResourceAliases
-
getResourceAlias
-
removeResourceAlias
-
setClassLoader
- Overrides:
setClassLoader
in classContextHandler
- Parameters:
classLoader
- The classLoader to set.
-
getResource
- Overrides:
getResource
in classContextHandler
- Throws:
MalformedURLException
-
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
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 toloadConfigurations()
. - Setup the default System classes by calling
loadSystemClasses()
- Setup the default Server classes by calling
loadServerClasses()
- Instantiates a classload (if one is not already set)
- Calls the
Configuration.preConfigure(WebAppContext)
method of all Configuration instances.
- Throws:
Exception
- if unable to pre configure
- Instantiate the
-
configure
- Throws:
Exception
-
postConfigure
- Throws:
Exception
-
doStart
Description copied from class:ContainerLifeCycle
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classServletContextHandler
- Throws:
Exception
- See Also:
-
doStop
Description copied from class:ContainerLifeCycle
Stops the managed lifecycle beans in the reverse order they were added.- Overrides:
doStop
in classServletContextHandler
- Throws:
Exception
- See Also:
-
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 interfaceDestroyable
- Specified by:
destroy
in interfaceHandler
- Overrides:
destroy
in classHandlerWrapper
-
dumpUrl
private void dumpUrl() -
getConfigurationClasses
@ManagedAttribute(value="configuration classes used to configure webapp", readonly=true) public String[] getConfigurationClasses()- Returns:
- Returns the 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
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
- Specified by:
getPermissions
in interfaceWebAppClassLoader.Context
- Returns:
- Returns the permissions.
-
getServerClasses
@ManagedAttribute(value="classes and packages hidden by the context classloader", readonly=true) public String[] getServerClasses()- Returns:
- Returns the serverClasses.
- See Also:
-
getServerClasspathPattern
- Returns:
- The ClasspathPattern used to match Server (hidden) classes
-
addServerClass
Deprecated.- Parameters:
classOrPackageOrLocation
- pattern (seeClasspathPattern
-
prependServerClass
Deprecated.Prepend to the list of Server classes.- Parameters:
classOrPackage
- A pattern.- See Also:
-
getSystemClasses
@ManagedAttribute(value="classes and packages given priority by context classloader", readonly=true) public String[] getSystemClasses()- Returns:
- Returns the systemClasses.
- See Also:
-
getSystemClasspathPattern
- Returns:
- The ClasspathPattern used to match System (protected) classes
-
addSystemClass
Deprecated.- Parameters:
classOrPackage
- pattern
-
prependSystemClass
Deprecated.Prepend to the list of System classes.- Parameters:
classOrPackage
- A pattern.- See Also:
-
isServerClass
Deprecated.- Parameters:
name
- class name- Returns:
- true if matched by
getServerClasspathPattern()
-
isSystemClass
Deprecated.- Parameters:
name
- class name- Returns:
- true if matched by
getServerClasspathPattern()
-
isServerClass
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 interfaceClassVisibilityChecker
- Parameters:
clazz
- The fully qualified name of the class.- Returns:
- True if the class is a server class.
-
isSystemClass
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 interfaceClassVisibilityChecker
- Parameters:
clazz
- The fully qualified name of the class.- Returns:
- True if the class is a system class.
-
isServerResource
- Specified by:
isServerResource
in interfaceWebAppClassLoader.Context
-
isSystemResource
- Specified by:
isSystemResource
in interfaceWebAppClassLoader.Context
-
loadSystemClasses
protected void loadSystemClasses() -
loadServerClasses
protected void loadServerClasses() -
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
- Throws:
IOException
-
isDistributable
- Returns:
- Returns the distributable.
-
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 interfaceWebAppClassLoader.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
-
getDefaultConfigurationClasses
-
getDefaultServerClasses
-
getDefaultSystemClasses
-
loadConfigurations
- Throws:
Exception
-
wrap
-
toString
- Overrides:
toString
in classContextHandler
-
dump
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 interfaceDumpable
- Overrides:
dump
in classContextHandler
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
IOException
- if unable to write to Appendable
-
setConfigurationClasses
- Parameters:
configurations
- The configuration class names. If setConfigurations is not called these classes are used to create a configurations array.
-
setConfigurationClasses
-
setConfigurations
- Parameters:
configurations
- The configurations to set.
-
setDefaultsDescriptor
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
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
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
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
- Returns:
- the web.xml descriptor to use. If set to null, WEB-INF/web.xml is used if it exists.
-
setDescriptor
- 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.
-
setEventListeners
Description copied from class:ContextHandler
Set the context event listeners.- Overrides:
setEventListeners
in classContextHandler
- Parameters:
eventListeners
- the event listeners- See Also:
-
removeEventListener
Description copied from class:ContextHandler
Remove a context event listeners.- Overrides:
removeEventListener
in classContextHandler
- Parameters:
listener
- the event listener to remove- See Also:
-
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
- Parameters:
permissions
- The permissions to set.
-
setContextWhiteList
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 calledContextHandler.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 forContextHandler.Context.getContext(String)
-
setServerClasses
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
ClasspathPattern
is used to match the server classes.- Parameters:
serverClasses
- The serverClasses to set.
-
setSystemClasses
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)
. AClasspathPattern
is used to match the system classes.- Parameters:
systemClasses
- The systemClasses to set.
-
setTempDirectory
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
Set the war of the webapp. From this value aContextHandler.setResourceBase(String)
value is computed byWebInfConfiguration
, 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
Set the war of the webapp as aResource
.- Parameters:
war
- The war to set as a Resource.- See Also:
-
getExtraClasspath
@ManagedAttribute(value="extra classpath for context classloader", readonly=true) public String getExtraClasspath()- Specified by:
getExtraClasspath
in interfaceWebAppClassLoader.Context
- Returns:
- Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.
-
setExtraClasspath
- Parameters:
extraClasspath
- Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.
-
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
-
setServer
- Specified by:
setServer
in interfaceHandler
- Overrides:
setServer
in classContextHandler
-
isAllowDuplicateFragmentNames
public boolean isAllowDuplicateFragmentNames() -
setAllowDuplicateFragmentNames
public void setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames) -
startContext
Description copied from class:ServletContextHandler
Finish constructing handlers and link them together.- Overrides:
startContext
in classServletContextHandler
- Throws:
Exception
- if unable to start the context- See Also:
-
stopContext
- Overrides:
stopContext
in classServletContextHandler
- Throws:
Exception
-
startWebapp
- Throws:
Exception
-
stopWebapp
- 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 classServletContextHandler
- Parameters:
registration
- ServletRegistration.Dynamic instance that setServletSecurity was called onservletSecurityElement
- 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
-
addServerClasses
-
addSystemClasses
-
getServerClasspathPattern()
.ClasspathPattern.add(String)