Package org.eclipse.jetty.server.handler

Class ContextHandler.Context

java.lang.Object
org.eclipse.jetty.util.AttributesMap
org.eclipse.jetty.server.handler.ContextHandler.StaticContext
org.eclipse.jetty.server.handler.ContextHandler.Context
All Implemented Interfaces:
ServletContext, Attributes, Dumpable
Direct Known Subclasses:
ServletContextHandler.Context
Enclosing class:
ContextHandler
@Deprecated(since="2021-05-27") public class ContextHandler.Context extends ContextHandler.StaticContext
Deprecated.
The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
Context.

A partial implementation of ServletContext. A complete implementation is provided by the derived ContextHandler implementations.

  • Method Details

    • getContextHandler

      public ContextHandler getContextHandler()
      Deprecated.

    • getContext

      public ServletContext getContext(String uripath)
      Deprecated.
      Description copied from interface: ServletContext
      Returns a ServletContext 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 interface ServletContext
      Overrides:
      getContext in class ContextHandler.StaticContext
      Parameters:
      uripath - a String 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:

    • getMimeType

      public String getMimeType(String file)
      Deprecated.
      Description copied from interface: ServletContext
      Returns the MIME type of the specified file, or null 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 interface ServletContext
      Overrides:
      getMimeType in class ContextHandler.StaticContext
      Parameters:
      file - a String specifying the name of a file
      Returns:
      a String specifying the file's MIME type

    • getRequestDispatcher

      public RequestDispatcher getRequestDispatcher(String uriInContext)
      Deprecated.
      Description copied from interface: ServletContext
      Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher 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 a RequestDispatcher for resources in foreign contexts. This method returns null if the ServletContext cannot return a RequestDispatcher.

      Specified by:
      getRequestDispatcher in interface ServletContext
      Overrides:
      getRequestDispatcher in class ContextHandler.StaticContext
      Parameters:
      uriInContext - a String specifying the pathname to the resource
      Returns:
      a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the ServletContext cannot return a RequestDispatcher
      See Also:

    • getRealPath

      public String getRealPath(String path)
      Deprecated.
      Description copied from interface: ServletContext
      Returns a String 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 interface ServletContext
      Overrides:
      getRealPath in class ContextHandler.StaticContext
      Parameters:
      path - a String specifying a virtual path
      Returns:
      a String specifying the real path, or null if the translation cannot be performed

    • getResource

      public URL getResource(String path) throws MalformedURLException
      Deprecated.
      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 a RequestDispatcher 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 interface ServletContext
      Overrides:
      getResource in class ContextHandler.StaticContext
      Parameters:
      path - a String 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:
      MalformedURLException - if the pathname is not given in the correct form

    • getResourceAsStream

      public InputStream getResourceAsStream(String path)
      Deprecated.
      Description copied from interface: ServletContext
      Returns the resource located at the named path as an InputStream object.

      The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. This method returns null 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 interface ServletContext
      Overrides:
      getResourceAsStream in class ContextHandler.StaticContext
      Parameters:
      path - a String specifying the path to the resource
      Returns:
      the InputStream returned to the servlet, or null if no resource exists at the specified path

    • getResourcePaths

      public Set<String> getResourcePaths(String path)
      Deprecated.
      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 interface ServletContext
      Overrides:
      getResourcePaths in class ContextHandler.StaticContext
      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.

    • log

      public void log(Exception exception, String msg)
      Deprecated.
      Description copied from interface: ServletContext
      Do not use.
      Specified by:
      log in interface ServletContext
      Overrides:
      log in class ContextHandler.StaticContext
      Parameters:
      exception - The exception to log
      msg - The message to log with the exception

    • log

      public void log(String msg)
      Deprecated.
      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 interface ServletContext
      Overrides:
      log in class ContextHandler.StaticContext
      Parameters:
      msg - a String specifying the message to be written to the log file

    • log

      public void log(String message, Throwable throwable)
      Deprecated.
      Description copied from interface: ServletContext
      Writes an explanatory message and a stack trace for a given Throwable 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 interface ServletContext
      Overrides:
      log in class ContextHandler.StaticContext
      Parameters:
      message - a String that describes the error or exception
      throwable - the Throwable error or exception

    • getInitParameter

      public String getInitParameter(String name)
      Deprecated.
      Description copied from interface: ServletContext
      Returns a String containing the value of the named context-wide initialization parameter, or null 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 interface ServletContext
      Overrides:
      getInitParameter in class ContextHandler.StaticContext
      Parameters:
      name - a String containing the name of the parameter whose value is requested
      Returns:
      a String containing the value of the initialization parameter
      See Also:

    • getInitParameterNames

      public Enumeration<String> getInitParameterNames()
      Deprecated.
      Description copied from interface: ServletContext
      Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.
      Specified by:
      getInitParameterNames in interface ServletContext
      Overrides:
      getInitParameterNames in class ContextHandler.StaticContext
      Returns:
      an Enumeration of String objects containing the names of the context's initialization parameters
      See Also:

    • getAttribute

      public Object getAttribute(String name)
      Deprecated.
      Description copied from interface: ServletContext
      Returns the servlet container attribute with the given name, or null if 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 using getAttributeNames.

      The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

      Specified by:
      getAttribute in interface Attributes
      Specified by:
      getAttribute in interface ServletContext
      Overrides:
      getAttribute in class AttributesMap
      Parameters:
      name - a String specifying the name of the attribute
      Returns:
      an Object containing the value of the attribute, or null if no attribute exists matching the given name
      See Also:

    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Deprecated.
      Description copied from interface: ServletContext
      Returns an Enumeration containing the attribute names available within this servlet context. Use the ServletContext.getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.
      Specified by:
      getAttributeNames in interface Attributes
      Specified by:
      getAttributeNames in interface ServletContext
      Overrides:
      getAttributeNames in class AttributesMap
      Returns:
      an Enumeration of attribute names
      See Also:

    • setAttribute

      public void setAttribute(String name, Object value)
      Deprecated.
      Description copied from interface: ServletContext
      Binds 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 ServletContext the 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.*, and sun.*.

      Specified by:
      setAttribute in interface Attributes
      Specified by:
      setAttribute in interface ServletContext
      Overrides:
      setAttribute in class AttributesMap
      Parameters:
      name - a String specifying the name of the attribute
      value - an Object representing the attribute to be bound

    • removeAttribute

      public void removeAttribute(String name)
      Deprecated.
      Description copied from interface: ServletContext
      Removes the attribute with the given name from the servlet context. After removal, subsequent calls to ServletContext.getAttribute(java.lang.String) to retrieve the attribute's value will return null.

      If listeners are configured on the ServletContext the container notifies them accordingly.

      Specified by:
      removeAttribute in interface Attributes
      Specified by:
      removeAttribute in interface ServletContext
      Overrides:
      removeAttribute in class AttributesMap
      Parameters:
      name - a String specifying the name of the attribute to be removed

    • getServletContextName

      public String getServletContextName()
      Deprecated.
      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 interface ServletContext
      Overrides:
      getServletContextName in class ContextHandler.StaticContext
      Returns:
      The name of the web application or null if no name has been declared in the deployment descriptor.

    • getContextPath

      public String getContextPath()
      Deprecated.
      Description copied from interface: ServletContext
      Return the main path associated with this context.
      Specified by:
      getContextPath in interface ServletContext
      Overrides:
      getContextPath in class ContextHandler.StaticContext
      Returns:
      The main context path

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class AttributesMap

    • setInitParameter

      public boolean setInitParameter(String name, String value)
      Deprecated.
      Description copied from interface: ServletContext
      Set the given initialisation parameter to the given value.
      Specified by:
      setInitParameter in interface ServletContext
      Overrides:
      setInitParameter in class ContextHandler.StaticContext
      Parameters:
      name - Name of initialisation parameter
      value - Value for initialisation parameter
      Returns:
      true if the call succeeds or false if the call fails because an initialisation parameter with the same name has already been set

    • addListener

      public void addListener(String className)
      Deprecated.
      Description copied from interface: ServletContext
      TODO SERVLET3 - Add comments
      Specified by:
      addListener in interface ServletContext
      Overrides:
      addListener in class ContextHandler.StaticContext
      Parameters:
      className - TODO

    • addListener

      public <T extends EventListener> void addListener(T t)
      Deprecated.
      Description copied from interface: ServletContext
      TODO SERVLET3 - Add comments
      Specified by:
      addListener in interface ServletContext
      Overrides:
      addListener in class ContextHandler.StaticContext
      Type Parameters:
      T - TODO
      Parameters:
      t - TODO

    • addListener

      public void addListener(Class<? extends EventListener> listenerClass)
      Deprecated.
      Description copied from interface: ServletContext
      TODO SERVLET3 - Add comments
      Specified by:
      addListener in interface ServletContext
      Overrides:
      addListener in class ContextHandler.StaticContext
      Parameters:
      listenerClass - TODO

    • checkListener

      public void checkListener(Class<? extends EventListener> listener) throws IllegalStateException
      Deprecated.
      Throws:
      IllegalStateException

    • setExtendedListenerTypes

      public void setExtendedListenerTypes(boolean extended)
      Deprecated.

    • isExtendedListenerTypes

      public boolean isExtendedListenerTypes()
      Deprecated.

    • getClassLoader

      public ClassLoader getClassLoader()
      Deprecated.
      Description copied from interface: ServletContext
      Get the web application class loader associated with this ServletContext.
      Specified by:
      getClassLoader in interface ServletContext
      Overrides:
      getClassLoader in class ContextHandler.StaticContext
      Returns:
      The associated web application class loader

    • getJspConfigDescriptor

      public JspConfigDescriptor getJspConfigDescriptor()
      Deprecated.
      Specified by:
      getJspConfigDescriptor in interface ServletContext
      Overrides:
      getJspConfigDescriptor in class ContextHandler.StaticContext
      Returns:
      TODO

    • setJspConfigDescriptor

      public void setJspConfigDescriptor(JspConfigDescriptor d)
      Deprecated.

    • declareRoles

      public void declareRoles(String... roleNames)
      Deprecated.
      Description copied from interface: ServletContext
      Add to the declared roles for this ServletContext.
      Specified by:
      declareRoles in interface ServletContext
      Overrides:
      declareRoles in class ContextHandler.StaticContext
      Parameters:
      roleNames - The roles to add

    • setEnabled

      public void setEnabled(boolean enabled)
      Deprecated.

    • isEnabled

      public boolean isEnabled()
      Deprecated.

    • getVirtualServerName

      public String getVirtualServerName()
      Deprecated.
      Description copied from interface: ServletContext
      Get 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 interface ServletContext
      Overrides:
      getVirtualServerName in class ContextHandler.StaticContext
      Returns:
      The primary name of the virtual host on which this context is deployed