Class ContextHandler.StaticContext
- java.lang.Object
-
- org.eclipse.jetty.util.AttributesMap
-
- org.eclipse.jetty.server.handler.ContextHandler.StaticContext
-
- All Implemented Interfaces:
ServletContext
,Attributes
,Dumpable
- Direct Known Subclasses:
ContextHandler.Context
- Enclosing class:
- ContextHandler
public static class ContextHandler.StaticContext extends AttributesMap implements ServletContext
A simple implementation of ServletContext that is used when there is no ContextHandler. This is also used as the base for all other ServletContext implementations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes
Attributes.Wrapper
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
-
Field Summary
-
Fields inherited from interface javax.servlet.ServletContext
ORDERED_LIBS, TEMPDIR
-
-
Constructor Summary
Constructors Constructor Description StaticContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.String className)
FilterRegistration.Dynamic
addFilter(java.lang.String filterName, Filter filter)
void
addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
void
addListener(java.lang.String className)
<T extends java.util.EventListener>
voidaddListener(T t)
ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.String className)
ServletRegistration.Dynamic
addServlet(java.lang.String servletName, Servlet servlet)
<T extends Filter>
TcreateFilter(java.lang.Class<T> clazz)
<T extends java.util.EventListener>
TcreateListener(java.lang.Class<T> clazz)
<T extends Servlet>
TcreateServlet(java.lang.Class<T> clazz)
void
declareRoles(java.lang.String... roleNames)
java.lang.ClassLoader
getClassLoader()
ServletContext
getContext(java.lang.String uripath)
Returns aServletContext
object that corresponds to a specified URL on the server.java.lang.String
getContextPath()
java.util.Set<SessionTrackingMode>
getDefaultSessionTrackingModes()
int
getEffectiveMajorVersion()
int
getEffectiveMinorVersion()
java.util.Set<SessionTrackingMode>
getEffectiveSessionTrackingModes()
FilterRegistration
getFilterRegistration(java.lang.String filterName)
java.util.Map<java.lang.String,? extends FilterRegistration>
getFilterRegistrations()
java.lang.String
getInitParameter(java.lang.String name)
Returns aString
containing the value of the named context-wide initialization parameter, ornull
if the parameter does not exist.java.util.Enumeration<java.lang.String>
getInitParameterNames()
Returns the names of the context's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the context has no initialization parameters.JspConfigDescriptor
getJspConfigDescriptor()
int
getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports.java.lang.String
getMimeType(java.lang.String file)
Returns the MIME type of the specified file, ornull
if the MIME type is not known.int
getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports.RequestDispatcher
getNamedDispatcher(java.lang.String name)
Returns aRequestDispatcher
object that acts as a wrapper for the named servlet.java.lang.String
getRealPath(java.lang.String path)
Returns aString
containing the real path for a given virtual path.RequestDispatcher
getRequestDispatcher(java.lang.String uriInContext)
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path.java.net.URL
getResource(java.lang.String path)
Returns a URL to the resource that is mapped to a specified path.java.io.InputStream
getResourceAsStream(java.lang.String path)
Returns the resource located at the named path as anInputStream
object.java.util.Set<java.lang.String>
getResourcePaths(java.lang.String path)
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.java.lang.String
getServerInfo()
Returns the name and version of the servlet container on which the servlet is running.Servlet
getServlet(java.lang.String name)
Deprecated.java.lang.String
getServletContextName()
Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.java.util.Enumeration<java.lang.String>
getServletNames()
Deprecated.ServletRegistration
getServletRegistration(java.lang.String servletName)
Obtain the details of the named servlet.java.util.Map<java.lang.String,? extends ServletRegistration>
getServletRegistrations()
java.util.Enumeration<Servlet>
getServlets()
Deprecated.SessionCookieConfig
getSessionCookieConfig()
java.lang.String
getVirtualServerName()
Returns the primary name of the virtual host on which this context is deployed.void
log(java.lang.Exception exception, java.lang.String msg)
void
log(java.lang.String msg)
Writes the specified message to a servlet log file, usually an event log.void
log(java.lang.String message, java.lang.Throwable throwable)
Writes an explanatory message and a stack trace for a givenThrowable
exception to the servlet log file.void
setEffectiveMajorVersion(int v)
void
setEffectiveMinorVersion(int v)
boolean
setInitParameter(java.lang.String name, java.lang.String value)
void
setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
-
Methods inherited from class org.eclipse.jetty.util.AttributesMap
addAll, clearAttributes, dump, dump, getAttribute, getAttributeEntrySet, getAttributeNames, getAttributeNamesCopy, getAttributeNameSet, removeAttribute, setAttribute, size, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javax.servlet.ServletContext
getAttribute, getAttributeNames, removeAttribute, setAttribute
-
-
-
-
Method Detail
-
getContext
public ServletContext getContext(java.lang.String uripath)
Description copied from interface:ServletContext
Returns aServletContext
object that corresponds to a specified URL on the server.This method allows servlets to gain access to the context for various parts of the server, and as needed obtain
RequestDispatcher
objects from the context. The given path must be begin with "/", is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container.In a security conscious environment, the servlet container may return
null
for a given URL.- Specified by:
getContext
in interfaceServletContext
- Parameters:
uripath
- aString
specifying the context path of another web application in the container.- Returns:
- the
ServletContext
object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access. - See Also:
RequestDispatcher
-
getMajorVersion
public int getMajorVersion()
Description copied from interface:ServletContext
Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 3.1 must have this method return the integer 3.- Specified by:
getMajorVersion
in interfaceServletContext
- Returns:
- 3
-
getMimeType
public java.lang.String getMimeType(java.lang.String file)
Description copied from interface:ServletContext
Returns the MIME type of the specified file, ornull
if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are"text/html"
and"image/gif"
.- Specified by:
getMimeType
in interfaceServletContext
- Parameters:
file
- aString
specifying the name of a file- Returns:
- a
String
specifying the file's MIME type
-
getMinorVersion
public int getMinorVersion()
Description copied from interface:ServletContext
Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 3.1 must have this method return the integer 1.- Specified by:
getMinorVersion
in interfaceServletContext
- Returns:
- 1
-
getNamedDispatcher
public RequestDispatcher getNamedDispatcher(java.lang.String name)
Description copied from interface:ServletContext
Returns aRequestDispatcher
object that acts as a wrapper for the named servlet.Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using
ServletConfig.getServletName()
.This method returns
null
if theServletContext
cannot return aRequestDispatcher
for any reason.- Specified by:
getNamedDispatcher
in interfaceServletContext
- Parameters:
name
- aString
specifying the name of a servlet to wrap- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the named servlet, ornull
if theServletContext
cannot return aRequestDispatcher
- See Also:
RequestDispatcher
,ServletContext.getContext(java.lang.String)
,ServletConfig.getServletName()
-
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(java.lang.String uriInContext)
Description copied from interface:ServletContext
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.The pathname must begin with a "/" and is interpreted as relative to the current context root. Use
getContext
to obtain aRequestDispatcher
for resources in foreign contexts. This method returnsnull
if theServletContext
cannot return aRequestDispatcher
.- Specified by:
getRequestDispatcher
in interfaceServletContext
- Parameters:
uriInContext
- aString
specifying the pathname to the resource- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if theServletContext
cannot return aRequestDispatcher
- See Also:
RequestDispatcher
,ServletContext.getContext(java.lang.String)
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Description copied from interface:ServletContext
Returns aString
containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext..The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. This method returns
null
if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a.war
archive).- Specified by:
getRealPath
in interfaceServletContext
- Parameters:
path
- aString
specifying a virtual path- Returns:
- a
String
specifying the real path, or null if the translation cannot be performed
-
getResource
public java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLException
Description copied from interface:ServletContext
Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root.This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a
.war
file.The servlet container must implement the URL handlers and
URLConnection
objects that are necessary to access the resource.This method returns
null
if no resource is mapped to the pathname.Some containers may allow writing to the URL returned by this method using the methods of the URL class.
The resource content is returned directly, so be aware that requesting a
.jsp
page returns the JSP source code. Use aRequestDispatcher
instead to include results of an execution.This method has a different purpose than
java.lang.Class.getResource
, which looks up resources based on a class loader. This method does not use class loaders.- Specified by:
getResource
in interfaceServletContext
- Parameters:
path
- aString
specifying the path to the resource- Returns:
- the resource located at the named path, or
null
if there is no resource at that path - Throws:
java.net.MalformedURLException
- if the pathname is not given in the correct form
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String path)
Description copied from interface:ServletContext
Returns the resource located at the named path as anInputStream
object.The data in the
InputStream
can be of any type or length. The path must be specified according to the rules given ingetResource
. This method returnsnull
if no resource exists at the specified path.Meta-information such as content length and content type that is available via
getResource
method is lost when using this method.The servlet container must implement the URL handlers and
URLConnection
objects necessary to access the resource.This method is different from
java.lang.Class.getResourceAsStream
, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader.- Specified by:
getResourceAsStream
in interfaceServletContext
- Parameters:
path
- aString
specifying the path to the resource- Returns:
- the
InputStream
returned to the servlet, ornull
if no resource exists at the specified path
-
getResourcePaths
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
Description copied from interface:ServletContext
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. For example, for a web application containing
/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/music.html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class,
getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}
getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.- Specified by:
getResourcePaths
in interfaceServletContext
- Parameters:
path
- the partial path used to match the resources, which must start with a /- Returns:
- a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.
-
getServerInfo
public java.lang.String getServerInfo()
Description copied from interface:ServletContext
Returns the name and version of the servlet container on which the servlet is running.The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string
JavaServer Web Dev Kit/1.0
.The servlet container may return other optional information after the primary string in parentheses, for example,
JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)
.- Specified by:
getServerInfo
in interfaceServletContext
- Returns:
- a
String
containing at least the servlet container name and version number
-
getServlet
@Deprecated public Servlet getServlet(java.lang.String name) throws ServletException
Deprecated.- Specified by:
getServlet
in interfaceServletContext
- Throws:
ServletException
-
getServletNames
@Deprecated public java.util.Enumeration<java.lang.String> getServletNames()
Deprecated.- Specified by:
getServletNames
in interfaceServletContext
-
getServlets
@Deprecated public java.util.Enumeration<Servlet> getServlets()
Deprecated.- Specified by:
getServlets
in interfaceServletContext
-
log
public void log(java.lang.Exception exception, java.lang.String msg)
- Specified by:
log
in interfaceServletContext
-
log
public void log(java.lang.String msg)
Description copied from interface:ServletContext
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.- Specified by:
log
in interfaceServletContext
- Parameters:
msg
- aString
specifying the message to be written to the log file
-
log
public void log(java.lang.String message, java.lang.Throwable throwable)
Description copied from interface:ServletContext
Writes an explanatory message and a stack trace for a givenThrowable
exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.- Specified by:
log
in interfaceServletContext
- Parameters:
message
- aString
that describes the error or exceptionthrowable
- theThrowable
error or exception
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
Description copied from interface:ServletContext
Returns aString
containing the value of the named context-wide initialization parameter, ornull
if the parameter does not exist.This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data.
- Specified by:
getInitParameter
in interfaceServletContext
- Parameters:
name
- aString
containing the name of the parameter whose value is requested- Returns:
- a
String
containing the value of the initialization parameter - See Also:
ServletConfig.getInitParameter(java.lang.String)
-
getInitParameterNames
public java.util.Enumeration<java.lang.String> getInitParameterNames()
Description copied from interface:ServletContext
Returns the names of the context's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the context has no initialization parameters.- Specified by:
getInitParameterNames
in interfaceServletContext
- Returns:
- an
Enumeration
ofString
objects containing the names of the context's initialization parameters - See Also:
ServletConfig.getInitParameter(java.lang.String)
-
getServletContextName
public java.lang.String getServletContextName()
Description copied from interface:ServletContext
Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.- Specified by:
getServletContextName
in interfaceServletContext
- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
-
getContextPath
public java.lang.String getContextPath()
- Specified by:
getContextPath
in interfaceServletContext
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)
- Specified by:
setInitParameter
in interfaceServletContext
- Returns:
- TODO
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
- Specified by:
addFilter
in interfaceServletContext
- Returns:
- TODO
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter)
- Specified by:
addFilter
in interfaceServletContext
- Returns:
- TODO
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)
- Specified by:
addFilter
in interfaceServletContext
- Returns:
- TODO
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
- Specified by:
addServlet
in interfaceServletContext
- Returns:
- TODO
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet)
- Specified by:
addServlet
in interfaceServletContext
- Returns:
- TODO
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)
- Specified by:
addServlet
in interfaceServletContext
- Returns:
- TODO
-
getDefaultSessionTrackingModes
public java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()
- Specified by:
getDefaultSessionTrackingModes
in interfaceServletContext
- Returns:
- TODO
-
getEffectiveSessionTrackingModes
public java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
- Specified by:
getEffectiveSessionTrackingModes
in interfaceServletContext
- Returns:
- TODO
-
getFilterRegistration
public FilterRegistration getFilterRegistration(java.lang.String filterName)
- Specified by:
getFilterRegistration
in interfaceServletContext
- Returns:
- TODO
-
getFilterRegistrations
public java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations()
- Specified by:
getFilterRegistrations
in interfaceServletContext
- Returns:
- TODO
-
getServletRegistration
public ServletRegistration getServletRegistration(java.lang.String servletName)
Description copied from interface:ServletContext
Obtain the details of the named servlet.- Specified by:
getServletRegistration
in interfaceServletContext
- Parameters:
servletName
- The name of the Servlet of interest- Returns:
- The registration details for the named Servlet or
null
if no Servlet has been registered with the given name
-
getServletRegistrations
public java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations()
- Specified by:
getServletRegistrations
in interfaceServletContext
- Returns:
- TODO
-
getSessionCookieConfig
public SessionCookieConfig getSessionCookieConfig()
- Specified by:
getSessionCookieConfig
in interfaceServletContext
- Returns:
- TODO
-
setSessionTrackingModes
public void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
- Specified by:
setSessionTrackingModes
in interfaceServletContext
-
addListener
public void addListener(java.lang.String className)
- Specified by:
addListener
in interfaceServletContext
-
addListener
public <T extends java.util.EventListener> void addListener(T t)
- Specified by:
addListener
in interfaceServletContext
-
addListener
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
- Specified by:
addListener
in interfaceServletContext
-
createListener
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz) throws ServletException
- Specified by:
createListener
in interfaceServletContext
- Returns:
- TODO
- Throws:
ServletException
-
createServlet
public <T extends Servlet> T createServlet(java.lang.Class<T> clazz) throws ServletException
- Specified by:
createServlet
in interfaceServletContext
- Returns:
- TODO
- Throws:
ServletException
-
createFilter
public <T extends Filter> T createFilter(java.lang.Class<T> clazz) throws ServletException
- Specified by:
createFilter
in interfaceServletContext
- Returns:
- TODO
- Throws:
ServletException
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
- Specified by:
getClassLoader
in interfaceServletContext
- Returns:
- TODO
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()
- Specified by:
getEffectiveMajorVersion
in interfaceServletContext
- Returns:
- TODO
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()
- Specified by:
getEffectiveMinorVersion
in interfaceServletContext
- Returns:
- TODO
-
setEffectiveMajorVersion
public void setEffectiveMajorVersion(int v)
-
setEffectiveMinorVersion
public void setEffectiveMinorVersion(int v)
-
getJspConfigDescriptor
public JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptor
in interfaceServletContext
- Returns:
- TODO
-
declareRoles
public void declareRoles(java.lang.String... roleNames)
- Specified by:
declareRoles
in interfaceServletContext
-
getVirtualServerName
public java.lang.String getVirtualServerName()
Description copied from interface:ServletContext
Returns the primary name of the virtual host on which this context is deployed. The name may or may not be a valid host name.- Specified by:
getVirtualServerName
in interfaceServletContext
-
-