Module org.eclipse.jetty.ee9.nested

Package org.eclipse.jetty.ee9.nested

Class ContextHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.ee9.nested.AbstractHandler

org.eclipse.jetty.ee9.nested.AbstractHandlerContainer

org.eclipse.jetty.ee9.nested.HandlerWrapper

org.eclipse.jetty.ee9.nested.ScopedHandler

org.eclipse.jetty.ee9.nested.ContextHandler

All Implemented Interfaces:

Supplier<org.eclipse.jetty.server.Handler>, Handler, HandlerContainer, org.eclipse.jetty.util.Attributes, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

@ManagedObject("EE9 Context")
public class ContextHandler
extends ScopedHandler
implements org.eclipse.jetty.util.Attributes, Supplier<org.eclipse.jetty.server.Handler>

ContextHandler.

This handler wraps a call to handle by setting the context and servlet path, plus setting the context classloader.

If the context init parameter org.eclipse.jetty.server.context.ManagedAttributes is set to a comma separated list of names, then they are treated as context attribute names, which if set as attributes are passed to the servers Container so that they may be managed with JMX.

The maximum size of a form that can be processed by this context is controlled by the system properties org.eclipse.jetty.server.Request.maxFormKeys and org.eclipse.jetty.server.Request.maxFormContentSize. These can also be configured with setMaxFormContentSize(int) and setMaxFormKeys(int)

The executor is made available via a context attributed org.eclipse.jetty.server.Executor.

By default, the context is created with the AllowedResourceAliasChecker which is configured to allow symlinks. If this alias checker is not required, then clearAliasChecks() or setAliasChecks(List) should be called.

This handler can be invoked in 2 different ways:

• If this is added directly as a Handler on the Server this will supply the ContextHandler.CoreContextHandler associated with this ContextHandler. This will wrap the request to a ContextHandler.CoreContextRequest and fall through to the CoreToNestedHandler which invokes the HttpChannel and this will eventually reach ScopedHandler.handle(String, Request, HttpServletRequest, HttpServletResponse).
• If this is nested inside another ContextHandler and not added directly to the server then its ContextHandler.CoreContextHandler will never be added to the server. However it will still be created and its ContextHandler.ScopedContext will be used to enter scope.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ContextHandler.APIContext	Context.
static interface	ContextHandler.ContextScopeListener	Listener for all threads entering context scope, including async IO callbacks
static enum	ContextHandler.ContextStatus
class	ContextHandler.CoreContextHandler
static class	ContextHandler.CoreContextRequest

Nested classes/interfaces inherited from class org.eclipse.jetty.ee9.nested.AbstractHandler

AbstractHandler.ErrorDispatchHandler

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

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

org.eclipse.jetty.util.Attributes.Layer, org.eclipse.jetty.util.Attributes.Lazy, org.eclipse.jetty.util.Attributes.Mapped, org.eclipse.jetty.util.Attributes.Synthetic, org.eclipse.jetty.util.Attributes.Wrapper

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

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

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected ContextHandler.APIContext	_apiContext
protected ContextHandler.ContextStatus	_contextStatus
static final int	DEFAULT_LISTENER_TYPE_INDEX
static final int	DEFAULT_MAX_FORM_CONTENT_SIZE
static final int	DEFAULT_MAX_FORM_KEYS
static final org.eclipse.jetty.util.component.Environment	ENVIRONMENT
static final int	EXTENDED_LISTENER_TYPE_INDEX
static final String	MAX_FORM_CONTENT_SIZE_KEY
static final String	MAX_FORM_KEYS_KEY
static final Class<?>[]	SERVLET_LISTENER_TYPES
static final int	SERVLET_MAJOR_VERSION
static final int	SERVLET_MINOR_VERSION

Fields inherited from class org.eclipse.jetty.ee9.nested.ScopedHandler

_nextScope, _outerScope

Fields inherited from class org.eclipse.jetty.ee9.nested.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.Attributes

NULL

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

KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
	ContextHandler()
	ContextHandler(String contextPath)
	ContextHandler(String contextPath, Handler handler)
protected	ContextHandler(ContextHandler.APIContext context, org.eclipse.jetty.server.Handler.Container parent, String contextPath)
	ContextHandler(org.eclipse.jetty.server.Handler.Container parent)
	ContextHandler(org.eclipse.jetty.server.Handler.Container parent, String contextPath)

Method Summary

Modifier and Type	Method	Description
void	addAliasCheck(org.eclipse.jetty.server.AliasCheck check)	Add an AliasCheck instance to possibly permit aliased resources
boolean	addEventListener(EventListener listener)	Add a context event listeners.
void	addLocaleEncoding(String locale, String encoding)
protected void	addProgrammaticListener(EventListener listener)	Apply any necessary restrictions on a programmatic added listener.
void	addVirtualHosts(String[] virtualHosts)
protected void	callContextDestroyed(jakarta.servlet.ServletContextListener l, jakarta.servlet.ServletContextEvent e)
protected void	callContextInitialized(jakarta.servlet.ServletContextListener l, jakarta.servlet.ServletContextEvent e)
boolean	checkAlias(String path, org.eclipse.jetty.util.resource.Resource resource)
void	clearAliasChecks()	clear the list of AliasChecks
void	clearAttributes()
void	contextDestroyed()	Call the ServletContextListeners with contextDestroyed.
void	contextInitialized()	Call the ServletContextListeners contextInitialized methods.
void	doHandle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Do the handler work within the scope.
void	doScope(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Scope the handler
protected void	doStart()
protected void	doStartInContext()
protected void	doStop()
protected void	doStopInContext()
void	dump(Appendable out, String indent)
protected void	enterScope(Request request, Object reason)
protected void	exitScope(Request request)
org.eclipse.jetty.server.Handler	get()
List<org.eclipse.jetty.server.AliasCheck>	getAliasChecks()
boolean	getAllowNullPathInfo()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
Set<String>	getAttributeNameSet()
org.eclipse.jetty.util.Attributes	getAttributes()
org.eclipse.jetty.util.resource.Resource	getBaseResource()
ClassLoader	getClassLoader()
String	getClassPath()	Make best effort to extract a file classpath from the context classloader
static ContextHandler	getContextHandler(jakarta.servlet.ServletContext context)
String	getContextPath()
String	getContextPathEncoded()
ContextHandler.CoreContextHandler	getCoreContextHandler()
static ContextHandler.APIContext	getCurrentContext()	Get the current ServletContext implementation.
static ContextHandler	getCurrentContextHandler()
String	getDefaultRequestCharacterEncoding()
String	getDefaultResponseCharacterEncoding()
String	getDisplayName()
ErrorHandler	getErrorHandler()
String	getInitParameter(String name)
Enumeration<String>	getInitParameterNames()
Map<String,String>	getInitParams()
String	getLocaleEncoding(String locale)
String	getLocaleEncoding(Locale locale)	Get the character encoding for a locale.
Map<String,String>	getLocaleEncodings()	Get all of the locale encodings
org.slf4j.Logger	getLogger()
int	getMaxFormContentSize()
int	getMaxFormKeys()
org.eclipse.jetty.http.MimeTypes.Mutable	getMimeTypes()
org.eclipse.jetty.util.resource.Resource	getNestedResourceForTempDirName()
String[]	getProtectedTargets()
String	getRequestContextPath()	Get the context path in a form suitable to be returned from HttpServletRequest.getContextPath() or ServletContext.getContextPath().
org.eclipse.jetty.util.resource.Resource	getResource(String pathInContext)	Attempt to get a Resource from the Context.
String	getResourceBase()	Deprecated. use #getBaseResource()
Set<String>	getResourcePaths(String path)
ContextHandler.APIContext	getServletContext()
static jakarta.servlet.ServletContext	getServletContext(org.eclipse.jetty.server.Context context)
String[]	getVirtualHosts()
String[]	getWelcomeFiles()
void	handle(Runnable runnable)
void	handle(HttpChannel channel)
void	handle(Request request, Runnable runnable)	Handle a runnable in the scope of this context and a particular request
void	handleAsync(HttpChannel channel)
void	handleCrossContextAsync(HttpChannel channel)	A request has come in via an async dispatch from a different context.
protected void	handleOptions(Request request, Response response)
void	insertHandler(org.eclipse.jetty.server.Handler.Singleton coreHandler)	Insert a handler between the getCoreContextHandler() and this handler.
boolean	isAvailable()
boolean	isCompactPath()	Deprecated, for removal: This API element is subject to removal in a future version. use CompactPathRule with RewriteHandler instead.
boolean	isCrossContextDispatchSupported()	Cross context dispatch support.
boolean	isDurableListener(EventListener listener)
boolean	isProgrammaticListener(EventListener listener)
boolean	isProtectedTarget(String target)	Check the target.
boolean	isUsingSecurityManager()
Class<?>	loadClass(String className)
org.eclipse.jetty.util.resource.Resource	newResource(String uriOrPath)	Convert a URL or path to a Resource.
org.eclipse.jetty.util.resource.Resource	newResource(URI uri)	Convert URL to Resource wrapper for ResourceFactory.newResource(URL) enables extensions to provide alternate resource implementations.
org.eclipse.jetty.util.resource.Resource	newResource(URL url)	Convert URL to Resource wrapper for ResourceFactory.newResource(URL) enables extensions to provide alternate resource implementations.
Object	removeAttribute(String name)
boolean	removeEventListener(EventListener listener)
void	removeVirtualHosts(String[] virtualHosts)
protected void	requestDestroyed(Request baseRequest, jakarta.servlet.http.HttpServletRequest request)
protected void	requestInitialized(Request baseRequest, jakarta.servlet.http.HttpServletRequest request)
void	setAliasChecks(List<org.eclipse.jetty.server.AliasCheck> checks)	Set list of AliasCheck instances.
void	setAllowNullPathInfo(boolean allowNullPathInfo)	Set true if /context is not redirected to /context/.
Object	setAttribute(String name, Object value)
void	setAttributes(org.eclipse.jetty.util.Attributes attributes)
void	setAvailable(boolean available)	Set Available status.
void	setBaseResource(org.eclipse.jetty.util.resource.Resource base)	Set the base resource for this context.
void	setBaseResourceAsPath(Path base)	Set the base resource for this context.
void	setBaseResourceAsString(String base)	Set the base resource for this context.
void	setClassLoader(ClassLoader classLoader)
void	setCompactPath(boolean compactPath)	Deprecated, for removal: This API element is subject to removal in a future version. use CompactPathRule with RewriteHandler instead.
void	setContextPath(String contextPath)
void	setCrossContextDispatchSupported(boolean supported)	Cross context dispatch support.
void	setDefaultRequestCharacterEncoding(String encoding)
void	setDefaultResponseCharacterEncoding(String encoding)
void	setDisplayName(String displayName)
void	setErrorHandler(ErrorHandler errorHandler)
String	setInitParameter(String name, String value)
void	setLogger(org.slf4j.Logger logger)
void	setMaxFormContentSize(int maxSize)	Set the maximum size of a form post, to protect against DOS attacks from large forms.
void	setMaxFormKeys(int max)	Set the maximum number of form Keys to protect against DOS attack from crafted hash keys.
void	setProtectedTargets(String[] targets)
void	setResourceBase(String resourceBase)	Deprecated. use #setBaseResource
void	setServer(org.eclipse.jetty.server.Server server)
void	setUsingSecurityManager(boolean usingSecurityManager)
void	setVirtualHosts(String[] vhosts)
void	setWelcomeFiles(String[] files)
protected void	startContext()	Extensible startContext. this method is called from doStart() instead of a call to super.doStart().
protected void	stopContext()
String	toString()

Methods inherited from class org.eclipse.jetty.ee9.nested.ScopedHandler

handle, nextHandle, nextScope

Methods inherited from class org.eclipse.jetty.ee9.nested.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, getTail, insertHandler, setAsParent, setHandler

Methods inherited from class org.eclipse.jetty.ee9.nested.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

Methods inherited from class org.eclipse.jetty.ee9.nested.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, installBean, installBean, 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.Attributes

asAttributeMap, equals, hashCode

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

Field Details

ENVIRONMENT

public static final org.eclipse.jetty.util.component.Environment ENVIRONMENT

SERVLET_MAJOR_VERSION

public static final int SERVLET_MAJOR_VERSION

See Also:

• Constant Field Values

SERVLET_MINOR_VERSION

public static final int SERVLET_MINOR_VERSION

See Also:

• Constant Field Values

SERVLET_LISTENER_TYPES

public static final Class<?>[] SERVLET_LISTENER_TYPES

DEFAULT_LISTENER_TYPE_INDEX

public static final int DEFAULT_LISTENER_TYPE_INDEX

See Also:

• Constant Field Values

EXTENDED_LISTENER_TYPE_INDEX

public static final int EXTENDED_LISTENER_TYPE_INDEX

See Also:

• Constant Field Values

MAX_FORM_KEYS_KEY

public static final String MAX_FORM_KEYS_KEY

See Also:

• Constant Field Values

MAX_FORM_CONTENT_SIZE_KEY

public static final String MAX_FORM_CONTENT_SIZE_KEY

See Also:

• Constant Field Values

DEFAULT_MAX_FORM_KEYS

public static final int DEFAULT_MAX_FORM_KEYS

See Also:

• Constant Field Values

DEFAULT_MAX_FORM_CONTENT_SIZE

public static final int DEFAULT_MAX_FORM_CONTENT_SIZE

See Also:

• Constant Field Values

_contextStatus

protected ContextHandler.ContextStatus _contextStatus

_apiContext

protected ContextHandler.APIContext _apiContext

Constructor Details

ContextHandler

public ContextHandler()

ContextHandler

public ContextHandler(String contextPath)

ContextHandler

public ContextHandler(String contextPath,
 Handler handler)

ContextHandler

public ContextHandler(org.eclipse.jetty.server.Handler.Container parent)

ContextHandler

public ContextHandler(org.eclipse.jetty.server.Handler.Container parent,
 String contextPath)

ContextHandler

protected ContextHandler(ContextHandler.APIContext context,
 org.eclipse.jetty.server.Handler.Container parent,
 String contextPath)

Method Details

getCurrentContext

public static ContextHandler.APIContext getCurrentContext()

Get the current ServletContext implementation.

Returns:

ServletContext implementation

getCurrentContextHandler

public static ContextHandler getCurrentContextHandler()

getContextHandler

public static ContextHandler getContextHandler(jakarta.servlet.ServletContext context)

getServletContext

public static jakarta.servlet.ServletContext getServletContext(org.eclipse.jetty.server.Context context)

get

public org.eclipse.jetty.server.Handler get()

Specified by:

get in interface Supplier<org.eclipse.jetty.server.Handler>

getCoreContextHandler

public ContextHandler.CoreContextHandler getCoreContextHandler()

insertHandler

public void insertHandler(org.eclipse.jetty.server.Handler.Singleton coreHandler)

Insert a handler between the getCoreContextHandler() and this handler.

Parameters:

coreHandler - A core handler to insert

dump

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

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException

getServletContext

public ContextHandler.APIContext getServletContext()

getAllowNullPathInfo

@ManagedAttribute("Checks if the /context is not redirected to /context/")
public boolean getAllowNullPathInfo()

Returns:

the allowNullPathInfo true if /context is not redirected to /context/

setAllowNullPathInfo

public void setAllowNullPathInfo(boolean allowNullPathInfo)

Set true if /context is not redirected to /context/.

Parameters:

allowNullPathInfo - true if /context is not redirected to /context/

setCrossContextDispatchSupported

public void setCrossContextDispatchSupported(boolean supported)

Cross context dispatch support.

Parameters:

supported - True if cross context dispatch is supported

See Also:

• ContextHandler.setCrossContextDispatchSupported(boolean)

isCrossContextDispatchSupported

public boolean isCrossContextDispatchSupported()

Cross context dispatch support.

Returns:

True if cross context dispatch is supported

See Also:

• ContextHandler.isCrossContextDispatchSupported()

setServer

public void setServer(org.eclipse.jetty.server.Server server)

Specified by:

setServer in interface Handler

Overrides:

setServer in class AbstractHandlerContainer

isUsingSecurityManager

public boolean isUsingSecurityManager()

setUsingSecurityManager

public void setUsingSecurityManager(boolean usingSecurityManager)

setVirtualHosts

public void setVirtualHosts(String[] vhosts)

addVirtualHosts

public void addVirtualHosts(String[] virtualHosts)

removeVirtualHosts

public void removeVirtualHosts(String[] virtualHosts)

getVirtualHosts

@ManagedAttribute(value="Virtual hosts accepted by the context",
                  readonly=true)
public String[] getVirtualHosts()

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface org.eclipse.jetty.util.Attributes

getAttributeNames

public Enumeration<String> getAttributeNames()

getAttributeNameSet

public Set<String> getAttributeNameSet()

Specified by:

getAttributeNameSet in interface org.eclipse.jetty.util.Attributes

getAttributes

public org.eclipse.jetty.util.Attributes getAttributes()

Returns:

Returns the attributes.

getClassLoader

public ClassLoader getClassLoader()

Returns:

Returns the classLoader.

getClassPath

@ManagedAttribute("The file classpath")
public String getClassPath()

Make best effort to extract a file classpath from the context classloader

Returns:

Returns the classLoader.

getContextPath

@ManagedAttribute("True if URLs are compacted to replace the multiple \'/\'s with a single \'/\'")
public String getContextPath()

Returns:

Returns the contextPath.

getContextPathEncoded

public String getContextPathEncoded()

Returns:

Returns the encoded contextPath.

getRequestContextPath

public String getRequestContextPath()

Get the context path in a form suitable to be returned from HttpServletRequest.getContextPath() or ServletContext.getContextPath().

Returns:

Returns the encoded contextPath, or empty string for root context

getInitParameter

public String getInitParameter(String name)

setInitParameter

public String setInitParameter(String name,
 String value)

getInitParameterNames

public Enumeration<String> getInitParameterNames()

getInitParams

@ManagedAttribute("Initial Parameter map for the context")
public Map<String,String> getInitParams()

Returns:

Returns the initParams.

getDisplayName

@ManagedAttribute(value="Display name of the Context",
                  readonly=true)
public String getDisplayName()

addEventListener

public boolean addEventListener(EventListener listener)

Add a context event listeners.

Specified by:

addEventListener in interface org.eclipse.jetty.util.component.Container

Specified by:

addEventListener in interface org.eclipse.jetty.util.component.LifeCycle

Overrides:

addEventListener in class org.eclipse.jetty.util.component.ContainerLifeCycle

Parameters:

listener - the event listener to add

Returns:

true if the listener was added

See Also:

• ContextHandler.ContextScopeListener
• ServletContextListener
• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener

removeEventListener

public boolean removeEventListener(EventListener listener)

Specified by:

removeEventListener in interface org.eclipse.jetty.util.component.Container

Specified by:

removeEventListener in interface org.eclipse.jetty.util.component.LifeCycle

Overrides:

removeEventListener in class org.eclipse.jetty.util.component.ContainerLifeCycle

addProgrammaticListener

protected void addProgrammaticListener(EventListener listener)

Apply any necessary restrictions on a programmatic added listener.

Parameters:

listener - the programmatic listener to add

isProgrammaticListener

public boolean isProgrammaticListener(EventListener listener)

isDurableListener

public boolean isDurableListener(EventListener listener)

isAvailable

public boolean isAvailable()

Returns:

false if this context is unavailable (sends 503)

setAvailable

public void setAvailable(boolean available)

Set Available status.

Parameters:

available - true to set as enabled

getLogger

public org.slf4j.Logger getLogger()

setLogger

public void setLogger(org.slf4j.Logger logger)

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class ScopedHandler

Throws:

Exception

doStartInContext

protected void doStartInContext()
                         throws Exception

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class AbstractHandler

Throws:

Exception

doStopInContext

protected void doStopInContext()
                        throws Exception

Throws:

Exception

startContext

protected void startContext()
                     throws Exception

Extensible startContext. this method is called from doStart() instead of a call to super.doStart(). This allows derived classes to insert additional handling (Eg configuration) before the call to super.doStart by this method will start contained handlers.

Throws:

Exception - if unable to start the context

See Also:

• ContextHandler.APIContext

contextInitialized

public void contextInitialized()
                        throws Exception

Call the ServletContextListeners contextInitialized methods. This can be called from a ServletHandler during the proper sequence of initializing filters, servlets and listeners. However, if there is no ServletHandler, the ContextHandler will call this method during doStart().

Throws:

Exception

contextDestroyed

public void contextDestroyed()
                      throws Exception

Call the ServletContextListeners with contextDestroyed. This method can be called from a ServletHandler in the proper sequence of destroying filters, servlets and listeners. If there is no ServletHandler, the ContextHandler must ensure these listeners are called instead.

Throws:

Exception

stopContext

protected void stopContext()
                    throws Exception

Throws:

Exception

callContextInitialized

protected void callContextInitialized(jakarta.servlet.ServletContextListener l,
 jakarta.servlet.ServletContextEvent e)

callContextDestroyed

protected void callContextDestroyed(jakarta.servlet.ServletContextListener l,
 jakarta.servlet.ServletContextEvent e)

doScope

public void doScope(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException,
jakarta.servlet.ServletException

Description copied from class: ScopedHandler

Scope the handler

Derived implementations should call ScopedHandler.nextScope(String, Request, HttpServletRequest, HttpServletResponse)

Overrides:

doScope in class ScopedHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

jakarta.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue

requestInitialized

protected void requestInitialized(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request)

requestDestroyed

protected void requestDestroyed(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request)

doHandle

public void doHandle(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
              throws IOException,
jakarta.servlet.ServletException

Description copied from class: ScopedHandler

Do the handler work within the scope.

Derived implementations should call ScopedHandler.nextHandle(String, Request, HttpServletRequest, HttpServletResponse)

Specified by:

doHandle in class ScopedHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

jakarta.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue

enterScope

protected void enterScope(Request request,
 Object reason)

Parameters:

request - A request that is applicable to the scope, or null

reason - An object that indicates the reason the scope is being entered.

exitScope

protected void exitScope(Request request)

Parameters:

request - A request that is applicable to the scope, or null

handle

public void handle(Request request,
 Runnable runnable)

Handle a runnable in the scope of this context and a particular request

Parameters:

request - The request to scope the thread to (may be null if no particular request is in scope)

runnable - The runnable to run.

handle

public void handle(Runnable runnable)

isProtectedTarget

public boolean isProtectedTarget(String target)

Check the target. Called by ScopedHandler.handle(String, Request, HttpServletRequest, HttpServletResponse) when a target within a context is determined. If the target is protected, 404 is returned.

Parameters:

target - the target to test

Returns:

true if target is a protected target

setProtectedTargets

public void setProtectedTargets(String[] targets)

Parameters:

targets - Array of URL prefix. Each prefix is in the form /path and will match either /path exactly or /path/anything

getProtectedTargets

public String[] getProtectedTargets()

removeAttribute

public Object removeAttribute(String name)

Specified by:

removeAttribute in interface org.eclipse.jetty.util.Attributes

setAttribute

public Object setAttribute(String name,
 Object value)

Specified by:

setAttribute in interface org.eclipse.jetty.util.Attributes

setAttributes

public void setAttributes(org.eclipse.jetty.util.Attributes attributes)

Parameters:

attributes - The attributes to set.

clearAttributes

public void clearAttributes()

Specified by:

clearAttributes in interface org.eclipse.jetty.util.Attributes

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Parameters:

classLoader - The classLoader to set.

setDefaultRequestCharacterEncoding

public void setDefaultRequestCharacterEncoding(String encoding)

getDefaultRequestCharacterEncoding

public String getDefaultRequestCharacterEncoding()

setDefaultResponseCharacterEncoding

public void setDefaultResponseCharacterEncoding(String encoding)

getDefaultResponseCharacterEncoding

public String getDefaultResponseCharacterEncoding()

setContextPath

public void setContextPath(String contextPath)

Parameters:

contextPath - The _contextPath to set.

setDisplayName

public void setDisplayName(String displayName)

Parameters:

displayName - The servletContextName to set.

getBaseResource

@ManagedAttribute("document root for context")
public org.eclipse.jetty.util.resource.Resource getBaseResource()

Returns:

Returns the resourceBase.

getResourceBase

@Deprecated
public String getResourceBase()

Deprecated.

use #getBaseResource()

Returns:

Returns the base resource as a string.

setBaseResource

public void setBaseResource(org.eclipse.jetty.util.resource.Resource base)

Set the base resource for this context.

Parameters:

base - The resource used as the base for all static content of this context.

setBaseResourceAsPath

public void setBaseResourceAsPath(Path base)

Set the base resource for this context.

Parameters:

base - The resource used as the base for all static content of this context.

See Also:

• setBaseResource(Resource)

setBaseResourceAsString

public void setBaseResourceAsString(String base)

Set the base resource for this context.

Parameters:

base - The resource used as the base for all static content of this context.

See Also:

• setBaseResource(Resource)

setResourceBase

@Deprecated
public void setResourceBase(String resourceBase)

Deprecated.

use #setBaseResource

Set the base resource for this context.

Parameters:

resourceBase - A string representing the base resource for the context. Any string accepted by ResourceFactory.newResource(String) may be passed and the call is equivalent to setBaseResource(newResource(resourceBase));

getMimeTypes

public org.eclipse.jetty.http.MimeTypes.Mutable getMimeTypes()

Returns:

Returns the mimeTypes.

setWelcomeFiles

public void setWelcomeFiles(String[] files)

getWelcomeFiles

@ManagedAttribute(value="Partial URIs of directory welcome files",
                  readonly=true)
public String[] getWelcomeFiles()

Returns:

The names of the files which the server should consider to be welcome files in this context.

See Also:

• The Servlet Specification
• setWelcomeFiles(java.lang.String[])

getErrorHandler

@ManagedAttribute("The error handler to use for the context")
public ErrorHandler getErrorHandler()

Returns:

Returns the errorHandler.

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Parameters:

errorHandler - The errorHandler to set.

getMaxFormContentSize

@ManagedAttribute("The maximum content size")
public int getMaxFormContentSize()

setMaxFormContentSize

public void setMaxFormContentSize(int maxSize)

Set the maximum size of a form post, to protect against DOS attacks from large forms.

Parameters:

maxSize - the maximum size of the form content (in bytes)

getMaxFormKeys

public int getMaxFormKeys()

setMaxFormKeys

public void setMaxFormKeys(int max)

Set the maximum number of form Keys to protect against DOS attack from crafted hash keys.

Parameters:

max - the maximum number of form keys

isCompactPath

@Deprecated(since="10.0.5",
            forRemoval=true)
public boolean isCompactPath()

Deprecated, for removal: This API element is subject to removal in a future version.

use CompactPathRule with RewriteHandler instead. Will be removed from ee10 onwards.

Is a compacted path used for context-path and url-pattern matching?

Returns:

True if URLs are compacted to replace multiple '/'s with a single '/'

See Also:

• URIUtil.compactPath(String)

setCompactPath

@Deprecated(since="10.0.5",
            forRemoval=true)
public void setCompactPath(boolean compactPath)

Deprecated, for removal: This API element is subject to removal in a future version.

use CompactPathRule with RewriteHandler instead. Will be removed from ee10 onwards.

When performing context-path and url-pattern matching, do so with a compacted form of the request path.

Note: this compacted path is not exposed to the Servlet API, the original request path is used.

Parameters:

compactPath - True if URLs are compacted to replace multiple '/'s with a single '/'

See Also:

• URIUtil.compactPath(String)

toString

public String toString()

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle

loadClass

public Class<?> loadClass(String className)
                   throws ClassNotFoundException

Throws:

ClassNotFoundException

addLocaleEncoding

public void addLocaleEncoding(String locale,
 String encoding)

getLocaleEncoding

public String getLocaleEncoding(String locale)

getLocaleEncoding

public String getLocaleEncoding(Locale locale)

Get the character encoding for a locale. The full locale name is first looked up in the map of encodings. If no encoding is found, then the locale language is looked up.

Parameters:

locale - a Locale value

Returns:

a String representing the character encoding for the locale or null if none found.

getLocaleEncodings

public Map<String,String> getLocaleEncodings()

Get all of the locale encodings

Returns:

a map of all the locale encodings: key is name of the locale and value is the char encoding

getResource

public org.eclipse.jetty.util.resource.Resource getResource(String pathInContext)
                                                     throws MalformedURLException

Attempt to get a Resource from the Context.

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

checkAlias

public boolean checkAlias(String path,
 org.eclipse.jetty.util.resource.Resource resource)

Parameters:

path - the path to check the alias for

resource - the resource

Returns:

True if the alias is OK

newResource

public org.eclipse.jetty.util.resource.Resource newResource(URL url)
                                                     throws IOException

Convert URL to Resource wrapper for ResourceFactory.newResource(URL) enables extensions to provide alternate resource implementations.

Parameters:

url - the url to convert to a Resource

Returns:

the Resource for that url

Throws:

IOException - if unable to create a Resource from the URL

newResource

public org.eclipse.jetty.util.resource.Resource newResource(URI uri)
                                                     throws IOException

Convert URL to Resource wrapper for ResourceFactory.newResource(URL) enables extensions to provide alternate resource implementations.

Parameters:

uri - the URI to convert to a Resource

Returns:

the Resource for that URI

Throws:

IOException - if unable to create a Resource from the URL

newResource

public org.eclipse.jetty.util.resource.Resource newResource(String uriOrPath)
                                                     throws IOException

Convert a URL or path to a Resource. The default implementation is a wrapper for ResourceFactory.newResource(String).

Parameters:

uriOrPath - The URL or path to convert

Returns:

The Resource for the URL/path

Throws:

IOException - The Resource could not be created.

getResourcePaths

public Set<String> getResourcePaths(String path)

addAliasCheck

public void addAliasCheck(org.eclipse.jetty.server.AliasCheck check)

Add an AliasCheck instance to possibly permit aliased resources

Parameters:

check - The alias checker

getAliasChecks

public List<org.eclipse.jetty.server.AliasCheck> getAliasChecks()

Returns:

Immutable list of Alias checks

setAliasChecks

public void setAliasChecks(List<org.eclipse.jetty.server.AliasCheck> checks)

Set list of AliasCheck instances.

Parameters:

checks - list of AliasCheck instances

clearAliasChecks

public void clearAliasChecks()

clear the list of AliasChecks

handle

public void handle(HttpChannel channel)
            throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

handleOptions

protected void handleOptions(Request request,
 Response response)
                      throws IOException

Throws:

IOException

handleCrossContextAsync

public void handleCrossContextAsync(HttpChannel channel)
                             throws IOException,
jakarta.servlet.ServletException

A request has come in via an async dispatch from a different context.

Parameters:

channel - the HttpChannel associated with the request

Throws:

IOException

jakarta.servlet.ServletException

handleAsync

public void handleAsync(HttpChannel channel)
                 throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

getNestedResourceForTempDirName

public org.eclipse.jetty.util.resource.Resource getNestedResourceForTempDirName()