Class ApplicationContext
- java.lang.Object
-
- org.apache.catalina.core.ApplicationContext
-
- All Implemented Interfaces:
ServletContext
- Direct Known Subclasses:
ReplicatedContext.ReplApplContext
public class ApplicationContext extends java.lang.Object implements ServletContext
Standard implementation ofServletContextthat represents a web application's execution environment. An instance of this class is associated with each instance ofStandardContext.- Author:
- Craig R. McClanahan, Remy Maucherat
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.Object>attributesThe context attributes for this context.protected static booleanGET_RESOURCE_REQUIRE_SLASHprotected static booleanSTRICT_SERVLET_COMPLIANCE-
Fields inherited from interface javax.servlet.ServletContext
ORDERED_LIBS, TEMPDIR
-
-
Constructor Summary
Constructors Constructor Description ApplicationContext(StandardContext context)Construct a new instance of this class, associated with the specified Context instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)Add filter to context.FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.String className)Add filter to context.FilterRegistration.DynamicaddFilter(java.lang.String filterName, Filter filter)Add filter to context.ServletRegistration.DynamicaddJspFile(java.lang.String jspName, java.lang.String jspFile)voidaddListener(java.lang.Class<? extends java.util.EventListener> listenerClass)TODO SERVLET3 - Add commentsvoidaddListener(java.lang.String className)TODO SERVLET3 - Add comments<T extends java.util.EventListener>
voidaddListener(T t)TODO SERVLET3 - Add commentsServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)Add servlet to context.ServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.String className)Register a servlet implementation for use in this ServletContext.ServletRegistration.DynamicaddServlet(java.lang.String servletName, Servlet servlet)Register a servlet instance for use in this ServletContext.protected voidclearAttributes()Clear all application-created attributes.<T extends Filter>
TcreateFilter(java.lang.Class<T> c)Create a Filter instance using the given class.<T extends java.util.EventListener>
TcreateListener(java.lang.Class<T> c)TODO SERVLET3 - Add comments<T extends Servlet>
TcreateServlet(java.lang.Class<T> c)Create an Servlet instance using the given class.voiddeclareRoles(java.lang.String... roleNames)Add to the declared roles for this ServletContext.java.lang.ObjectgetAttribute(java.lang.String name)Returns the servlet container attribute with the given name, ornullif there is no attribute by that name.java.util.Enumeration<java.lang.String>getAttributeNames()Returns anEnumerationcontaining the attribute names available within this servlet context.java.lang.ClassLoadergetClassLoader()Get the web application class loader associated with this ServletContext.protected StandardContextgetContext()ServletContextgetContext(java.lang.String uri)Returns aServletContextobject that corresponds to a specified URL on the server.java.lang.StringgetContextPath()Return the main path associated with this context.java.util.Set<SessionTrackingMode>getDefaultSessionTrackingModes()Obtains the default session tracking modes for this web application.intgetEffectiveMajorVersion()Obtain the major version of the servlet specification for which this web application is implemented.intgetEffectiveMinorVersion()Obtain the minor version of the servlet specification for which this web application is implemented.java.util.Set<SessionTrackingMode>getEffectiveSessionTrackingModes()Obtains the currently enabled session tracking modes for this web application.protected ServletContextgetFacade()FilterRegistrationgetFilterRegistration(java.lang.String filterName)TODO SERVLET3 - Add commentsjava.util.Map<java.lang.String,? extends FilterRegistration>getFilterRegistrations()java.lang.StringgetInitParameter(java.lang.String name)Returns aStringcontaining the value of the named context-wide initialization parameter, ornullif the parameter does not exist.java.util.Enumeration<java.lang.String>getInitParameterNames()Returns the names of the context's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the context has no initialization parameters.JspConfigDescriptorgetJspConfigDescriptor()intgetMajorVersion()Returns the major version of the Java Servlet API that this servlet container supports.java.lang.StringgetMimeType(java.lang.String file)Return the MIME type of the specified file, ornullif the MIME type cannot be determined.intgetMinorVersion()Returns the minor version of the Servlet API that this servlet container supports.RequestDispatchergetNamedDispatcher(java.lang.String name)Return aRequestDispatcherobject that acts as a wrapper for the named servlet.java.lang.StringgetRealPath(java.lang.String path)Returns aStringcontaining the real path for a given virtual path.java.lang.StringgetRequestCharacterEncoding()RequestDispatchergetRequestDispatcher(java.lang.String path)Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path.java.net.URLgetResource(java.lang.String path)Returns a URL to the resource that is mapped to a specified path.java.io.InputStreamgetResourceAsStream(java.lang.String path)Returns the resource located at the named path as anInputStreamobject.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.StringgetResponseCharacterEncoding()java.lang.StringgetServerInfo()Returns the name and version of the servlet container on which the servlet is running.ServletgetServlet(java.lang.String name)Deprecated.java.lang.StringgetServletContextName()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.ServletRegistrationgetServletRegistration(java.lang.String servletName)Obtain the details of the named servlet.java.util.Map<java.lang.String,? extends ServletRegistration>getServletRegistrations()Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.java.util.Enumeration<Servlet>getServlets()Deprecated.SessionCookieConfiggetSessionCookieConfig()intgetSessionTimeout()java.lang.StringgetVirtualServerName()Get the primary name of the virtual host on which this context is deployed.voidlog(java.lang.Exception exception, java.lang.String message)Deprecated.voidlog(java.lang.String message)Writes the specified message to a servlet log file, usually an event log.voidlog(java.lang.String message, java.lang.Throwable throwable)Writes an explanatory message and a stack trace for a givenThrowableexception to the servlet log file.voidremoveAttribute(java.lang.String name)Removes the attribute with the given name from the servlet context.voidsetAttribute(java.lang.String name, java.lang.Object value)Binds an object to a given attribute name in this servlet context.booleansetInitParameter(java.lang.String name, java.lang.String value)Set the given initialisation parameter to the given value.protected voidsetNewServletContextListenerAllowed(boolean allowed)voidsetRequestCharacterEncoding(java.lang.String encoding)voidsetResponseCharacterEncoding(java.lang.String encoding)voidsetSessionTimeout(int sessionTimeout)voidsetSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)Configures the available session tracking modes for this web application.
-
-
-
Field Detail
-
STRICT_SERVLET_COMPLIANCE
protected static final boolean STRICT_SERVLET_COMPLIANCE
-
GET_RESOURCE_REQUIRE_SLASH
protected static final boolean GET_RESOURCE_REQUIRE_SLASH
-
attributes
protected java.util.Map<java.lang.String,java.lang.Object> attributes
The context attributes for this context.
-
-
Constructor Detail
-
ApplicationContext
public ApplicationContext(StandardContext context)
Construct a new instance of this class, associated with the specified Context instance.- Parameters:
context- The associated Context instance
-
-
Method Detail
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
Description copied from interface:javax.servlet.ServletContextReturns the servlet container attribute with the given name, ornullif there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved usinggetAttributeNames.The attribute is returned as a
java.lang.Objector some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matchingjava.*,javax.*, andsun.*.- Specified by:
getAttributein interfaceServletContext- Parameters:
name- aStringspecifying the name of the attribute- Returns:
- an
Objectcontaining the value of the attribute, ornullif no attribute exists matching the given name - See Also:
ServletContext.getAttributeNames()
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
Description copied from interface:javax.servlet.ServletContextReturns anEnumerationcontaining the attribute names available within this servlet context. Use theServletContext.getAttribute(java.lang.String)method with an attribute name to get the value of an attribute.- Specified by:
getAttributeNamesin interfaceServletContext- Returns:
- an
Enumerationof attribute names - See Also:
ServletContext.getAttribute(java.lang.String)
-
getContext
public ServletContext getContext(java.lang.String uri)
Description copied from interface:javax.servlet.ServletContextReturns aServletContextobject 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
RequestDispatcherobjects 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
nullfor a given URL.- Specified by:
getContextin interfaceServletContext- Parameters:
uri- aStringspecifying the context path of another web application in the container.- Returns:
- the
ServletContextobject that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access. - See Also:
RequestDispatcher
-
getContextPath
public java.lang.String getContextPath()
Description copied from interface:javax.servlet.ServletContextReturn the main path associated with this context.- Specified by:
getContextPathin interfaceServletContext- Returns:
- The main context path
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
Description copied from interface:javax.servlet.ServletContextReturns aStringcontaining the value of the named context-wide initialization parameter, ornullif the parameter does not exist.This method can make available configuration information useful to an entire "web application". For example, it can provide a web site administrator's email address or the name of a system that holds critical data.
- Specified by:
getInitParameterin interfaceServletContext- Parameters:
name- aStringcontaining the name of the parameter whose value is requested- Returns:
- a
Stringcontaining 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:javax.servlet.ServletContextReturns the names of the context's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the context has no initialization parameters.- Specified by:
getInitParameterNamesin interfaceServletContext- Returns:
- an
EnumerationofStringobjects containing the names of the context's initialization parameters - See Also:
ServletConfig.getInitParameter(java.lang.String)
-
getMajorVersion
public int getMajorVersion()
Description copied from interface:javax.servlet.ServletContextReturns 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:
getMajorVersionin interfaceServletContext- Returns:
- 3
-
getMinorVersion
public int getMinorVersion()
Description copied from interface:javax.servlet.ServletContextReturns 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:
getMinorVersionin interfaceServletContext- Returns:
- 1
-
getMimeType
public java.lang.String getMimeType(java.lang.String file)
Return the MIME type of the specified file, ornullif the MIME type cannot be determined.- Specified by:
getMimeTypein interfaceServletContext- Parameters:
file- Filename for which to identify a MIME type- Returns:
- a
Stringspecifying the file's MIME type
-
getNamedDispatcher
public RequestDispatcher getNamedDispatcher(java.lang.String name)
Return aRequestDispatcherobject that acts as a wrapper for the named servlet.- Specified by:
getNamedDispatcherin interfaceServletContext- Parameters:
name- Name of the servlet for which a dispatcher is requested- Returns:
- a
RequestDispatcherobject that acts as a wrapper for the named servlet, ornullif theServletContextcannot return aRequestDispatcher - See Also:
RequestDispatcher,ServletContext.getContext(java.lang.String),ServletConfig.getServletName()
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Description copied from interface:javax.servlet.ServletContextReturns aStringcontaining 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
nullif 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.wararchive).- Specified by:
getRealPathin interfaceServletContext- Parameters:
path- aStringspecifying a virtual path- Returns:
- a
Stringspecifying the real path, or null if the translation cannot be performed
-
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(java.lang.String path)
Description copied from interface:javax.servlet.ServletContextReturns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path. ARequestDispatcherobject 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
getContextto obtain aRequestDispatcherfor resources in foreign contexts. This method returnsnullif theServletContextcannot return aRequestDispatcher.- Specified by:
getRequestDispatcherin interfaceServletContext- Parameters:
path- aStringspecifying the pathname to the resource- Returns:
- a
RequestDispatcherobject that acts as a wrapper for the resource at the specified path, ornullif theServletContextcannot return aRequestDispatcher - See Also:
RequestDispatcher,ServletContext.getContext(java.lang.String)
-
getResource
public java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLExceptionDescription copied from interface:javax.servlet.ServletContextReturns 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
.warfile.The servlet container must implement the URL handlers and
URLConnectionobjects that are necessary to access the resource.This method returns
nullif 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
.jsppage returns the JSP source code. Use aRequestDispatcherinstead 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:
getResourcein interfaceServletContext- Parameters:
path- aStringspecifying the path to the resource- Returns:
- the resource located at the named path, or
nullif 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:javax.servlet.ServletContextReturns the resource located at the named path as anInputStreamobject.The data in the
InputStreamcan be of any type or length. The path must be specified according to the rules given ingetResource. This method returnsnullif no resource exists at the specified path.Meta-information such as content length and content type that is available via
getResourcemethod is lost when using this method.The servlet container must implement the URL handlers and
URLConnectionobjects 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:
getResourceAsStreamin interfaceServletContext- Parameters:
path- aStringspecifying the path to the resource- Returns:
- the
InputStreamreturned to the servlet, ornullif no resource exists at the specified path
-
getResourcePaths
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
Description copied from interface:javax.servlet.ServletContextReturns 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:
getResourcePathsin 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:javax.servlet.ServletContextReturns 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:
getServerInfoin interfaceServletContext- Returns:
- a
Stringcontaining at least the servlet container name and version number
-
getServlet
@Deprecated public Servlet getServlet(java.lang.String name)
Deprecated.Description copied from interface:javax.servlet.ServletContextDo not use. This method was originally defined to retrieve a servlet from aServletContext. In this version, this method always returnsnulland remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.In lieu of this method, servlets can share information using the
ServletContextclass and can perform shared business logic by invoking methods on common non-servlet classes.- Specified by:
getServletin interfaceServletContext- Parameters:
name- Not used- Returns:
- Always
null
-
getServletContextName
public java.lang.String getServletContextName()
Description copied from interface:javax.servlet.ServletContextReturns 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:
getServletContextNamein interfaceServletContext- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
-
getServletNames
@Deprecated public java.util.Enumeration<java.lang.String> getServletNames()
Deprecated.Description copied from interface:javax.servlet.ServletContextDo not use. This method was originally defined to return anEnumerationof all the servlet names known to this context. In this version, this method always returns an emptyEnumerationand remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.- Specified by:
getServletNamesin interfaceServletContext- Returns:
- Always and empty Enumeration
-
getServlets
@Deprecated public java.util.Enumeration<Servlet> getServlets()
Deprecated.Description copied from interface:javax.servlet.ServletContextDo not use. This method was originally defined to return anEnumerationof all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.- Specified by:
getServletsin interfaceServletContext- Returns:
- Always and empty Enumeration
-
log
public void log(java.lang.String message)
Description copied from interface:javax.servlet.ServletContextWrites 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:
login interfaceServletContext- Parameters:
message- aStringspecifying the message to be written to the log file
-
log
@Deprecated public void log(java.lang.Exception exception, java.lang.String message)Deprecated.Description copied from interface:javax.servlet.ServletContextDo not use.- Specified by:
login interfaceServletContext- Parameters:
exception- The exception to logmessage- The message to log with the exception
-
log
public void log(java.lang.String message, java.lang.Throwable throwable)Description copied from interface:javax.servlet.ServletContextWrites an explanatory message and a stack trace for a givenThrowableexception 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:
login interfaceServletContext- Parameters:
message- aStringthat describes the error or exceptionthrowable- theThrowableerror or exception
-
removeAttribute
public void removeAttribute(java.lang.String name)
Description copied from interface:javax.servlet.ServletContextRemoves the attribute with the given name from the servlet context. After removal, subsequent calls toServletContext.getAttribute(java.lang.String)to retrieve the attribute's value will returnnull.If listeners are configured on the
ServletContextthe container notifies them accordingly.- Specified by:
removeAttributein interfaceServletContext- Parameters:
name- aStringspecifying the name of the attribute to be removed
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)Description copied from interface:javax.servlet.ServletContextBinds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.If listeners are configured on the
ServletContextthe container notifies them accordingly.If a null value is passed, the effect is the same as calling
removeAttribute().Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching
java.*,javax.*, andsun.*.- Specified by:
setAttributein interfaceServletContext- Parameters:
name- aStringspecifying the name of the attributevalue- anObjectrepresenting the attribute to be bound
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)
Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
addFilterin interfaceServletContext- Parameters:
filterName- Name of filter to addclassName- Name of filter class- Returns:
nullif the filter has already been fully defined, else aFilterRegistration.Dynamicobject that can be used to further configure the filter
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter)
Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
addFilterin interfaceServletContext- Parameters:
filterName- Name of filter to addfilter- Filter to add- Returns:
nullif the filter has already been fully defined, else aFilterRegistration.Dynamicobject that can be used to further configure the filter
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
addFilterin interfaceServletContext- Parameters:
filterName- Name of filter to addfilterClass- Class of filter to add- Returns:
nullif the filter has already been fully defined, else aFilterRegistration.Dynamicobject that can be used to further configure the filter
-
createFilter
public <T extends Filter> T createFilter(java.lang.Class<T> c) throws ServletException
Description copied from interface:javax.servlet.ServletContextCreate a Filter instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
createFilterin interfaceServletContext- Type Parameters:
T- The type for the given class- Parameters:
c- The the class for which an instance should be created- Returns:
- The created Filter instance.
- Throws:
ServletException- If the Filter instance cannot be created
-
getFilterRegistration
public FilterRegistration getFilterRegistration(java.lang.String filterName)
Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
getFilterRegistrationin interfaceServletContext- Parameters:
filterName- TODO- Returns:
- TODO
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)
Description copied from interface:javax.servlet.ServletContextRegister a servlet implementation for use in this ServletContext.- Specified by:
addServletin interfaceServletContext- Parameters:
servletName- The name of the servlet to registerclassName- The implementation class for the servlet- Returns:
- The registration object that enables further configuration
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet)
Description copied from interface:javax.servlet.ServletContextRegister a servlet instance for use in this ServletContext.- Specified by:
addServletin interfaceServletContext- Parameters:
servletName- The name of the servlet to registerservlet- The Servlet instance to register- Returns:
- The registration object that enables further configuration
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
Description copied from interface:javax.servlet.ServletContextAdd servlet to context.- Specified by:
addServletin interfaceServletContext- Parameters:
servletName- Name of servlet to addservletClass- Class of servlet to add- Returns:
nullif the servlet has already been fully defined, else aServletRegistration.Dynamicobject that can be used to further configure the servlet
-
addJspFile
public ServletRegistration.Dynamic addJspFile(java.lang.String jspName, java.lang.String jspFile)
-
createServlet
public <T extends Servlet> T createServlet(java.lang.Class<T> c) throws ServletException
Description copied from interface:javax.servlet.ServletContextCreate an Servlet instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
createServletin interfaceServletContext- Type Parameters:
T- The type for the given class- Parameters:
c- The the class for which an instance should be created- Returns:
- The created Servlet instance.
- Throws:
ServletException- If the servlet instance cannot be created.
-
getServletRegistration
public ServletRegistration getServletRegistration(java.lang.String servletName)
Description copied from interface:javax.servlet.ServletContextObtain the details of the named servlet.- Specified by:
getServletRegistrationin interfaceServletContext- Parameters:
servletName- The name of the Servlet of interest- Returns:
- The registration details for the named Servlet or
nullif no Servlet has been registered with the given name
-
getDefaultSessionTrackingModes
public java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()
Description copied from interface:javax.servlet.ServletContextObtains the default session tracking modes for this web application. By defaultSessionTrackingMode.URLis always supported,SessionTrackingMode.COOKIEis supported unless thecookiesattribute has been set tofalsefor the context andSessionTrackingMode.SSLis supported if at least one of the connectors used by this context has the attributesecureset totrue.- Specified by:
getDefaultSessionTrackingModesin interfaceServletContext- Returns:
- The set of default session tracking modes for this web application
-
getEffectiveSessionTrackingModes
public java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
Description copied from interface:javax.servlet.ServletContextObtains the currently enabled session tracking modes for this web application.- Specified by:
getEffectiveSessionTrackingModesin interfaceServletContext- Returns:
- The value supplied via
ServletContext.setSessionTrackingModes(Set)if one was previously set, else return the defaults
-
getSessionCookieConfig
public SessionCookieConfig getSessionCookieConfig()
- Specified by:
getSessionCookieConfigin interfaceServletContext- Returns:
- TODO
-
setSessionTrackingModes
public void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
Description copied from interface:javax.servlet.ServletContextConfigures the available session tracking modes for this web application.- Specified by:
setSessionTrackingModesin interfaceServletContext- Parameters:
sessionTrackingModes- The session tracking modes to use for this web application
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)Description copied from interface:javax.servlet.ServletContextSet the given initialisation parameter to the given value.- Specified by:
setInitParameterin interfaceServletContext- Parameters:
name- Name of initialisation parametervalue- Value for initialisation parameter- Returns:
trueif the call succeeds orfalseif the call fails because an initialisation parameter with the same name has already been set
-
addListener
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
addListenerin interfaceServletContext- Parameters:
listenerClass- TODO
-
addListener
public void addListener(java.lang.String className)
Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
addListenerin interfaceServletContext- Parameters:
className- TODO
-
addListener
public <T extends java.util.EventListener> void addListener(T t)
Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
addListenerin interfaceServletContext- Type Parameters:
T- TODO- Parameters:
t- TODO
-
createListener
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> c) throws ServletExceptionDescription copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
createListenerin interfaceServletContext- Type Parameters:
T- TODO- Parameters:
c- TODO- Returns:
- TODO
- Throws:
ServletException- TODO
-
declareRoles
public void declareRoles(java.lang.String... roleNames)
Description copied from interface:javax.servlet.ServletContextAdd to the declared roles for this ServletContext.- Specified by:
declareRolesin interfaceServletContext- Parameters:
roleNames- The roles to add
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
Description copied from interface:javax.servlet.ServletContextGet the web application class loader associated with this ServletContext.- Specified by:
getClassLoaderin interfaceServletContext- Returns:
- The associated web application class loader
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()
Description copied from interface:javax.servlet.ServletContextObtain the major version of the servlet specification for which this web application is implemented.- Specified by:
getEffectiveMajorVersionin interfaceServletContext- Returns:
- The major version declared in web.xml
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()
Description copied from interface:javax.servlet.ServletContextObtain the minor version of the servlet specification for which this web application is implemented.- Specified by:
getEffectiveMinorVersionin interfaceServletContext- Returns:
- The minor version declared in web.xml
-
getFilterRegistrations
public java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations()
- Specified by:
getFilterRegistrationsin interfaceServletContext- Returns:
- TODO
-
getJspConfigDescriptor
public JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptorin interfaceServletContext- Returns:
- TODO
-
getServletRegistrations
public java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations()
Description copied from interface:javax.servlet.ServletContextObtain a Map of servlet names to servlet registrations for all servlets registered with this context.- Specified by:
getServletRegistrationsin interfaceServletContext- Returns:
- A Map of servlet names to servlet registrations for all servlets registered with this context
-
getVirtualServerName
public java.lang.String getVirtualServerName()
Description copied from interface:javax.servlet.ServletContextGet 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:
getVirtualServerNamein interfaceServletContext- Returns:
- The primary name of the virtual host on which this context is deployed
-
getSessionTimeout
public int getSessionTimeout()
-
setSessionTimeout
public void setSessionTimeout(int sessionTimeout)
-
getRequestCharacterEncoding
public java.lang.String getRequestCharacterEncoding()
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(java.lang.String encoding)
-
getResponseCharacterEncoding
public java.lang.String getResponseCharacterEncoding()
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(java.lang.String encoding)
-
getContext
protected StandardContext getContext()
-
clearAttributes
protected void clearAttributes()
Clear all application-created attributes.
-
getFacade
protected ServletContext getFacade()
- Returns:
- the facade associated with this ApplicationContext.
-
setNewServletContextListenerAllowed
protected void setNewServletContextListenerAllowed(boolean allowed)
-
-