org.eclipse.jetty.server.handler

Class ContextHandler

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

All Implemented Interfaces:

Handler, HandlerContainer, Attributes, Container, Destroyable, Dumpable, Graceful, LifeCycle

Direct Known Subclasses:

HttpSpiContextHandler, MovedContextHandler, ServletContextHandler

@ManagedObject(value="URI Context")
public class ContextHandler
extends ScopedHandler
implements Attributes, Graceful

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)

This servers executore is made available via a context attributed "org.eclipse.jetty.server.Executor".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContextHandler.AliasCheck Interface to check aliases
static class	ContextHandler.ApproveAliases Approve all aliases.
static class	ContextHandler.ApproveNonExistentDirectoryAliases Approve Aliases of a non existent directory.
static class	ContextHandler.ApprovePathPrefixAliases Deprecated.
static class	ContextHandler.ApproveSameSuffixAliases Deprecated.
static class	ContextHandler.Availability
class	ContextHandler.Context Context.
static class	ContextHandler.NoContext

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

AbstractLifeCycle.AbstractLifeCycleListener

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

LifeCycle.Listener

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

Container.InheritedListener, Container.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected ContextHandler.Context	_scontext
static int	DEFAULT_LISTENER_TYPE_INDEX
static int	EXTENDED_LISTENER_TYPE_INDEX
static String	MANAGED_ATTRIBUTES If a context attribute with this name is set, it is interpreted as a comma separated list of attribute name.
static Class<?>[]	SERVLET_LISTENER_TYPES
static int	SERVLET_MAJOR_VERSION
static int	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, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Modifier	Constructor and Description
	ContextHandler()
protected	ContextHandler(ContextHandler.Context context)
	ContextHandler(HandlerContainer parent, String contextPath)
	ContextHandler(String contextPath)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAliasCheck(ContextHandler.AliasCheck check) Add an AliasCheck instance to possibly permit aliased resources
void	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) Either set virtual hosts or add to an existing set of virtual hosts.
protected void	callContextDestroyed(ServletContextListener l, ServletContextEvent e)
protected void	callContextInitialized(ServletContextListener l, ServletContextEvent e)
boolean	checkAlias(String path, Resource resource)
boolean	checkContext(String target, Request baseRequest, HttpServletResponse response)
boolean	checkContextPath(String uri)
void	checkManagedAttribute(String name, Object value)
boolean	checkVirtualHost(Request baseRequest)
void	clearAttributes()
void	doHandle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
void	doScope(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
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)
List<ContextHandler.AliasCheck>	getAliasChecks()
boolean	getAllowNullPathInfo()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
Attributes	getAttributes()
Resource	getBaseResource()
ClassLoader	getClassLoader()
String	getClassPath() Make best effort to extract a file classpath from the context classloader
static ContextHandler	getContextHandler(ServletContext context)
String	getContextPath()
static ContextHandler.Context	getCurrentContext() Get the current ServletContext implementation.
String	getDisplayName()
ErrorHandler	getErrorHandler()
EventListener[]	getEventListeners()
String	getInitParameter(String name)
Enumeration<String>	getInitParameterNames()
Map<String,String>	getInitParams()
String	getLocaleEncoding(Locale locale) Get the character encoding for a locale.
String	getLocaleEncoding(String locale)
Map<String,String>	getLocaleEncodings() Get all of the locale encodings
Logger	getLogger()
int	getMaxFormContentSize()
int	getMaxFormKeys()
MimeTypes	getMimeTypes()
String[]	getProtectedTargets()
Resource	getResource(String path)
String	getResourceBase()
Set<String>	getResourcePaths(String path)
ContextHandler.Context	getServletContext()
String[]	getVirtualHosts() Get the virtual hosts for the context.
String[]	getWelcomeFiles()
void	handle(Runnable runnable)
boolean	isAvailable()
boolean	isCompactPath()
protected boolean	isProgrammaticListener(EventListener listener)
boolean	isProtectedTarget(String target) Check the target.
boolean	isShutdown()
Class<?>	loadClass(String className)
Resource	newResource(String urlOrPath) Convert a URL or path to a Resource.
Resource	newResource(URI uri) Convert URL to Resource wrapper for Resource.newResource(URL) enables extensions to provide alternate resource implementations.
Resource	newResource(URL url) Convert URL to Resource wrapper for Resource.newResource(URL) enables extensions to provide alternate resource implementations.
void	removeAttribute(String name)
void	removeEventListener(EventListener listener) Remove a context event listeners.
void	removeVirtualHosts(String[] virtualHosts) Removes an array of virtual host entries, if this removes all entries the _vhosts will be set to null
void	setAliasChecks(List<ContextHandler.AliasCheck> checks)
void	setAllowNullPathInfo(boolean allowNullPathInfo)
void	setAttribute(String name, Object value)
void	setAttributes(Attributes attributes)
void	setAvailable(boolean available) Set Available status.
void	setBaseResource(Resource base) Set the base resource for this context.
void	setClassLoader(ClassLoader classLoader)
void	setCompactPath(boolean compactPath)
void	setContextPath(String contextPath)
void	setDisplayName(String servletContextName)
void	setErrorHandler(ErrorHandler errorHandler)
void	setEventListeners(EventListener[] eventListeners) Set the context event listeners.
String	setInitParameter(String name, String value)
void	setLogger(Logger logger)
void	setManagedAttribute(String name, Object value)
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	setMimeTypes(MimeTypes mimeTypes)
void	setProtectedTargets(String[] targets)
void	setResourceBase(String resourceBase) Set the base resource for this context.
void	setServer(Server server)
void	setVirtualHosts(String[] vhosts) Set the virtual hosts for the context.
void	setWelcomeFiles(String[] files)
Future<Void>	shutdown() Set shutdown status.
protected void	startContext() Extensible startContext.
String	toString()

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

handle, never, nextHandle, nextScope

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

destroy, expandChildren, getHandler, getHandlers, setHandler

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

dumpThis, getServer

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

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, 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.LifeCycle

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

Field Detail

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

MANAGED_ATTRIBUTES

public static final String MANAGED_ATTRIBUTES

If a context attribute with this name is set, it is interpreted as a comma separated list of attribute name. Any other context attributes that are set with a name from this list will result in a call to setManagedAttribute(String, Object), which typically initiates the creation of a JMX MBean for the attribute value.

See Also:

Constant Field Values

_scontext

protected ContextHandler.Context _scontext

Constructor Detail

ContextHandler

public ContextHandler()

ContextHandler

protected ContextHandler(ContextHandler.Context context)

ContextHandler

public ContextHandler(String contextPath)

ContextHandler

public ContextHandler(HandlerContainer parent,
              String contextPath)

Method Detail

getCurrentContext

public static ContextHandler.Context getCurrentContext()

Get the current ServletContext implementation.

Returns:

ServletContext implementation

getContextHandler

public static ContextHandler getContextHandler(ServletContext context)

dump

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

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

getServletContext

public ContextHandler.Context getServletContext()

getAllowNullPathInfo

@ManagedAttribute(value="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)

Parameters:

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

setServer

public void setServer(Server server)

Specified by:

setServer in interface Handler

Overrides:

setServer in class HandlerWrapper

setVirtualHosts

public void setVirtualHosts(String[] vhosts)

Set the virtual hosts for the context. Only requests that have a matching host header or fully qualified URL will be passed to that context with a virtual host name. A context with no virtual host names or a null virtual host name is available to all requests that are not served by a context with a matching virtual host name.

Parameters:

vhosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names. Hosts may start with '@', in which case they will match the Connector#getName() for the request.

addVirtualHosts

public void addVirtualHosts(String[] virtualHosts)

Either set virtual hosts or add to an existing set of virtual hosts.

Parameters:

virtualHosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names. Host names may start with '@', in which case they will match the Connector#getName() for the request.

removeVirtualHosts

public void removeVirtualHosts(String[] virtualHosts)

Removes an array of virtual host entries, if this removes all entries the _vhosts will be set to null

Parameters:

virtualHosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.

getVirtualHosts

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

Get the virtual hosts for the context. Only requests that have a matching host header or fully qualified URL will be passed to that context with a virtual host name. A context with no virtual host names or a null virtual host name is available to all requests that are not served by a context with a matching virtual host name.

Returns:

Array of virtual hosts that this context responds to. A null host name or empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Attributes

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface Attributes

getAttributes

public Attributes getAttributes()

Returns:

Returns the attributes.

getClassLoader

public ClassLoader getClassLoader()

Returns:

Returns the classLoader.

getClassPath

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

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

Returns:

Returns the classLoader.

getContextPath

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

Returns:

Returns the _contextPath.

getInitParameter

public String getInitParameter(String name)

setInitParameter

public String setInitParameter(String name,
                      String value)

getInitParameterNames

public Enumeration<String> getInitParameterNames()

getInitParams

@ManagedAttribute(value="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()

getEventListeners

public EventListener[] getEventListeners()

setEventListeners

public void setEventListeners(EventListener[] eventListeners)

Set the context event listeners.

Parameters:

eventListeners - the event listeners

See Also:

ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener

addEventListener

public void addEventListener(EventListener listener)

Add a context event listeners.

See Also:

ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener

removeEventListener

public void removeEventListener(EventListener listener)

Remove a context event listeners.

See Also:

ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener

addProgrammaticListener

protected void addProgrammaticListener(EventListener listener)

Apply any necessary restrictions on a programmatic added listener.

Parameters:

listener -

isProgrammaticListener

protected boolean isProgrammaticListener(EventListener listener)

isShutdown

@ManagedAttribute(value="true for graceful shutdown, which allows existing requests to complete")
public boolean isShutdown()

Returns:

true if this context is accepting new requests

shutdown

public Future<Void> shutdown()

Set shutdown status. This field allows for graceful shutdown of a context. A started context may be put into non accepting state so that existing requests can complete, but no new requests are accepted.

Specified by:

shutdown in interface Graceful

isAvailable

public boolean isAvailable()

Returns:

false if this context is unavailable (sends 503)

setAvailable

public void setAvailable(boolean available)

Set Available status.

getLogger

public Logger getLogger()

setLogger

public void setLogger(Logger logger)

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 ScopedHandler

Throws:

Exception

See Also:

AbstractHandler.doStart()

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

See Also:

ContextHandler.Context

callContextInitialized

protected void callContextInitialized(ServletContextListener l,
                          ServletContextEvent e)

callContextDestroyed

protected void callContextDestroyed(ServletContextListener l,
                        ServletContextEvent e)

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class AbstractHandler

Throws:

Exception

checkVirtualHost

public boolean checkVirtualHost(Request baseRequest)

checkContextPath

public boolean checkContextPath(String uri)

checkContext

public boolean checkContext(String target,
                   Request baseRequest,
                   HttpServletResponse response)
                     throws IOException

Throws:

IOException

doScope

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

Specified by:

doScope in class ScopedHandler

Throws:

IOException

ServletException

See Also:

ScopedHandler.doScope(java.lang.String, org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doHandle

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

Specified by:

doHandle in class ScopedHandler

Throws:

IOException

ServletException

See Also:

ScopedHandler.doHandle(java.lang.String, org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

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.

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 void removeAttribute(String name)

Specified by:

removeAttribute in interface Attributes

setAttribute

public void setAttribute(String name,
                Object value)

Specified by:

setAttribute in interface Attributes

setAttributes

public void setAttributes(Attributes attributes)

Parameters:

attributes - The attributes to set.

clearAttributes

public void clearAttributes()

Specified by:

clearAttributes in interface Attributes

checkManagedAttribute

public void checkManagedAttribute(String name,
                         Object value)

setManagedAttribute

public void setManagedAttribute(String name,
                       Object value)

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Parameters:

classLoader - The classLoader to set.

setContextPath

public void setContextPath(String contextPath)

Parameters:

contextPath - The _contextPath to set.

setDisplayName

public void setDisplayName(String servletContextName)

Parameters:

servletContextName - The servletContextName to set.

getBaseResource

public Resource getBaseResource()

Returns:

Returns the resourceBase.

getResourceBase

@ManagedAttribute(value="document root for context")
public String getResourceBase()

Returns:

Returns the base resource as a string.

setBaseResource

public void setBaseResource(Resource 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:

setResourceBase(String)

setResourceBase

public void setResourceBase(String resourceBase)

Set the base resource for this context.

Parameters:

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

getMimeTypes

public MimeTypes getMimeTypes()

Returns:

Returns the mimeTypes.

setMimeTypes

public void setMimeTypes(MimeTypes mimeTypes)

Parameters:

mimeTypes - The mimeTypes to set.

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(value="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(value="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 -

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 -

isCompactPath

public boolean isCompactPath()

Returns:

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

setCompactPath

public void setCompactPath(boolean compactPath)

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

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 Resource getResource(String path)
                     throws MalformedURLException

Throws:

MalformedURLException

checkAlias

public boolean checkAlias(String path,
                 Resource resource)

Parameters:

path -

resource -

Returns:

True if the alias is OK

newResource

public Resource newResource(URL url)
                     throws IOException

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

Throws:

IOException

newResource

public Resource newResource(URI uri)
                     throws IOException

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

Throws:

IOException

newResource

public Resource newResource(String urlOrPath)
                     throws IOException

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

Parameters:

urlOrPath - 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(ContextHandler.AliasCheck check)

Add an AliasCheck instance to possibly permit aliased resources

Parameters:

check - The alias checker

getAliasChecks

public List<ContextHandler.AliasCheck> getAliasChecks()

Returns:

Mutable list of Alias checks

setAliasChecks

public void setAliasChecks(List<ContextHandler.AliasCheck> checks)

Parameters:

checks - list of AliasCheck instances