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:

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)

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

By default, the context is created with alias checkers for AllowSymLinkAliasChecker (unix only) and ContextHandler.ApproveNonExistentDirectoryAliases. If these alias checkers are not required, then clearAliasChecks() or setAliasChecks(List) should be called.

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.Availability
class	ContextHandler.Context Context.
static interface	ContextHandler.ContextScopeListener Listener for all threads entering context scope, including async IO callbacks
static class	ContextHandler.ContextStatus
static class	ContextHandler.StaticContext A simple implementation of ServletContext that is used when there is no ContextHandler.

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.Graceful

Graceful.Shutdown

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
static int	DEFAULT_LISTENER_TYPE_INDEX
static int	DEFAULT_MAX_FORM_CONTENT_SIZE
static int	DEFAULT_MAX_FORM_KEYS
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 String	MAX_FORM_CONTENT_SIZE_KEY
static String	MAX_FORM_KEYS_KEY
static Class<?>[]	SERVLET_LISTENER_TYPES
static int	SERVLET_MAJOR_VERSION
static int	SERVLET_MINOR_VERSION

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor and Description
ContextHandler()
ContextHandler(HandlerContainer parent, String contextPath)
ContextHandler(String contextPath)

Method Summary

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)
void	addVirtualHosts(String[] virtualHosts) Either set virtual hosts or add to an existing set of virtual hosts.
boolean	checkAlias(String path, Resource resource)
boolean	checkContext(String target, Request baseRequest, HttpServletResponse response)
boolean	checkContextPath(String uri)
boolean	checkVirtualHost(Request baseRequest)
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, HttpServletRequest request, HttpServletResponse response) Do the handler work within the scope.
void	doScope(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) Scope the handler
void	dump(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.
List<ContextHandler.AliasCheck>	getAliasChecks()
boolean	getAllowNullPathInfo()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
Set<String>	getAttributeNameSet()
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()
String	getContextPathEncoded()
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)
static String	getServerInfo()
ContextHandler.Context	getServletContext()
String[]	getVirtualHosts() Get the virtual hosts for the context.
String[]	getWelcomeFiles()
void	handle(Request request, Runnable runnable) Handle a runnable in the scope of this context and a particular request
void	handle(Runnable runnable)
boolean	isAvailable()
boolean	isCompactPath()
boolean	isDurableListener(EventListener listener)
boolean	isProgrammaticListener(EventListener listener)
boolean	isProtectedTarget(String target) Check the target.
boolean	isShutdown()
boolean	isUsingSecurityManager()
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) Deprecated.
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)
static void	setServerInfo(String serverInfo)
void	setUsingSecurityManager(boolean usingSecurityManager)
void	setVirtualHosts(String[] vhosts) Set the virtual hosts for the context.
void	setWelcomeFiles(String[] files)
Future<Void>	shutdown() Set shutdown status.
String	toString()

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

handle, nextHandle, nextScope

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

destroy, getHandler, getHandlers, insertHandler, setHandler

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

findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

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

getServer

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

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.Attributes

unwrap

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

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

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

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

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

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

Constructor Detail

ContextHandler

public ContextHandler()

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)

getServerInfo

public static String getServerInfo()

setServerInfo

public static void setServerInfo(String serverInfo)

dump

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

Description copied from interface: Dumpable

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

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

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 AbstractHandlerContainer

isUsingSecurityManager

public boolean isUsingSecurityManager()

setUsingSecurityManager

public void setUsingSecurityManager(boolean usingSecurityManager)

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/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 and wildcard hosts may be followed with '@connectorname', in which case they will match only if the the Connector.getName() for the request also matches. If an entry is just '@connectorname' it will match any host if that connector was used. Note - In previous versions if one or more connectorname only entries existed and non of the connectors matched the handler would not match regardless of any hostname entries. If there is one or more connectorname only entries and one or more host only entries but no hostname and connector entries we assume the old behavior and will log a warning. The warning can be removed by removing the host entries that were previously being ignored, or modifying to include a hostname and connectorname entry.

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/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 and wildcard hosts may be followed with '@connectorname', in which case they will match only if the the Connector.getName() for the request also matches. If an entry is just '@connectorname' it will match any host if that connector was used. Note - In previous versions if one or more connectorname only entries existed and non of the connectors matched the handler would not match regardless of any hostname entries. If there is one or more connectorname only entries and one or more host only entries but no hostname and connector entries we assume the old behavior and will log a warning. The warning can be removed by removing the host entries that were previously being ignored, or modifying to include a hostname and connectorname entry.

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/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 and wildcard hosts may be followed with '@connectorname', in which case they will match only if the the Connector.getName() for the request also matches. If an entry is just '@connectorname' it will match any host if that connector was used. Note - In previous versions if one or more connectorname only entries existed and non of the connectors matched the handler would not match regardless of any hostname entries. If there is one or more connectorname only entries and one or more host only entries but no hostname and connector entries we assume the old behavior and will log a warning. The warning can be removed by removing the host entries that were previously being ignored, or modifying to include a hostname and connectorname entry.

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/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 and wildcard hosts may be followed with '@connectorname', in which case they will match only if the the Connector.getName() for the request also matches. If an entry is just '@connectorname' it will match any host if that connector was used. Note - In previous versions if one or more connectorname only entries existed and non of the connectors matched the handler would not match regardless of any hostname entries. If there is one or more connectorname only entries and one or more host only entries but no hostname and connector entries we assume the old behavior and will log a warning. The warning can be removed by removing the host entries that were previously being ignored, or modifying to include a hostname and connectorname entry.

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Attributes

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface Attributes

getAttributeNameSet

public Set<String> getAttributeNameSet()

Specified by:

getAttributeNameSet 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.

getContextPathEncoded

public String getContextPathEncoded()

Returns:

Returns the encoded 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.

Parameters:

listener - the event listener to add

See Also:

ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener

removeEventListener

public void removeEventListener(EventListener listener)

Remove a context event listeners.

Parameters:

listener - the event listener to remove

See Also:

ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener

isProgrammaticListener

public boolean isProgrammaticListener(EventListener listener)

isDurableListener

public boolean isDurableListener(EventListener listener)

isShutdown

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

Specified by:

isShutdown in interface Graceful

Returns:

true if this context is shutting down

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.

Parameters:

available - true to set as enabled

getLogger

public Logger getLogger()

setLogger

public void setLogger(Logger logger)

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

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

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. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

IOException - if unable to handle the request or response processing

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

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

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. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

IOException - if unable to handle the request or response processing

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

See Also:

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

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 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

setManagedAttribute

@Deprecated
public void setManagedAttribute(String name,
                                            Object value)

Deprecated.

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 - 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

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

Throws:

MalformedURLException

checkAlias

public boolean checkAlias(String path,
                          Resource resource)

Parameters:

path - the path to check the alias for

resource - the 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.

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 Resource newResource(URI uri)
                     throws IOException

Convert URL to Resource wrapper for Resource.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 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

clearAliasChecks

public void clearAliasChecks()

clear the list of AliasChecks