Package org.eclipse.jetty.server.handler

Class ContextHandler.StaticContext

  • All Implemented Interfaces:
    ServletContext, Attributes, Dumpable
    Direct Known Subclasses:
    ContextHandler.Context
    Enclosing class:
    ContextHandler
    @Deprecated(since="2021-05-27")
public static class ContextHandler.StaticContext
extends AttributesMap
implements ServletContext
    Deprecated.
    The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    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.

    • Constructor Detail

      • StaticContext

        public StaticContext()
        Deprecated.

    • Method Detail

      • getContext

        public ServletContext getContext​(java.lang.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
        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:
        RequestDispatcher

      • getMajorVersion

        public int getMajorVersion()
        Deprecated.
        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 interface ServletContext
        Returns:
        3

      • getMimeType

        public java.lang.String getMimeType​(java.lang.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
        Parameters:
        file - a String specifying the name of a file
        Returns:
        a String specifying the file's MIME type

      • getMinorVersion

        public int getMinorVersion()
        Deprecated.
        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 interface ServletContext
        Returns:
        1

      • getRequestDispatcher

        public RequestDispatcher getRequestDispatcher​(java.lang.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
        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:
        RequestDispatcher, ServletContext.getContext(java.lang.String)

      • getRealPath

        public java.lang.String getRealPath​(java.lang.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
        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 java.net.URL getResource​(java.lang.String path)
                         throws java.net.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
        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:
        java.net.MalformedURLException - if the pathname is not given in the correct form

      • getResourceAsStream

        public java.io.InputStream getResourceAsStream​(java.lang.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
        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 java.util.Set<java.lang.String> getResourcePaths​(java.lang.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
        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()
        Deprecated.
        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 interface ServletContext
        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.
        Description copied from interface: ServletContext
        Do not use. This method was originally defined to retrieve a servlet from a ServletContext. In this version, this method always returns null and 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 ServletContext class and can perform shared business logic by invoking methods on common non-servlet classes.

        Specified by:
        getServlet in interface ServletContext
        Parameters:
        name - Not used
        Returns:
        Always null
        Throws:
        ServletException - never

      • getServletNames

        @Deprecated
public java.util.Enumeration<java.lang.String> getServletNames()
        Deprecated.
        Description copied from interface: ServletContext
        Do not use. This method was originally defined to return an Enumeration of all the servlet names known to this 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:
        getServletNames in interface ServletContext
        Returns:
        Always and empty Enumeration

      • getServlets

        @Deprecated
public java.util.Enumeration<Servlet> getServlets()
        Deprecated.
        Description copied from interface: ServletContext
        Do not use. This method was originally defined to return an Enumeration of 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:
        getServlets in interface ServletContext
        Returns:
        Always and empty Enumeration

      • log

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

      • log

        public void log​(java.lang.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
        Parameters:
        msg - a String specifying the message to be written to the log file

      • log

        public void log​(java.lang.String message,
                java.lang.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
        Parameters:
        message - a String that describes the error or exception
        throwable - the Throwable error or exception

      • getInitParameter

        public java.lang.String getInitParameter​(java.lang.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
        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:
        ServletConfig.getInitParameter(java.lang.String)

      • getInitParameterNames

        public java.util.Enumeration<java.lang.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
        Returns:
        an Enumeration of String objects containing the names of the context's initialization parameters
        See Also:
        ServletConfig.getInitParameter(java.lang.String)

      • getServletContextName

        public java.lang.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
        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()
        Deprecated.
        Description copied from interface: ServletContext
        Return the main path associated with this context.
        Specified by:
        getContextPath in interface ServletContext
        Returns:
        The main context path

      • setInitParameter

        public boolean setInitParameter​(java.lang.String name,
                                java.lang.String value)
        Deprecated.
        Description copied from interface: ServletContext
        Set the given initialisation parameter to the given value.
        Specified by:
        setInitParameter in interface ServletContext
        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

      • addFilter

        public FilterRegistration.Dynamic addFilter​(java.lang.String filterName,
                                            java.lang.Class<? extends Filter> filterClass)
        Deprecated.
        Description copied from interface: ServletContext
        Add filter to context.
        Specified by:
        addFilter in interface ServletContext
        Parameters:
        filterName - Name of filter to add
        filterClass - Class of filter to add
        Returns:
        null if the filter has already been fully defined, else a FilterRegistration.Dynamic object that can be used to further configure the filter

      • addFilter

        public FilterRegistration.Dynamic addFilter​(java.lang.String filterName,
                                            java.lang.String className)
        Deprecated.
        Description copied from interface: ServletContext
        Add filter to context.
        Specified by:
        addFilter in interface ServletContext
        Parameters:
        filterName - Name of filter to add
        className - Name of filter class
        Returns:
        null if the filter has already been fully defined, else a FilterRegistration.Dynamic object that can be used to further configure the filter

      • addServlet

        public ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                              java.lang.Class<? extends Servlet> servletClass)
        Deprecated.
        Description copied from interface: ServletContext
        Add servlet to context.
        Specified by:
        addServlet in interface ServletContext
        Parameters:
        servletName - Name of servlet to add
        servletClass - Class of servlet to add
        Returns:
        null if the servlet has already been fully defined, else a ServletRegistration.Dynamic object that can be used to further configure the servlet

      • addServlet

        public ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                              Servlet servlet)
        Deprecated.
        Description copied from interface: ServletContext
        Register a servlet instance for use in this ServletContext.
        Specified by:
        addServlet in interface ServletContext
        Parameters:
        servletName - The name of the servlet to register
        servlet - The Servlet instance to register
        Returns:
        The registration object that enables further configuration

      • addServlet

        public ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                              java.lang.String className)
        Deprecated.
        Description copied from interface: ServletContext
        Register a servlet implementation for use in this ServletContext.
        Specified by:
        addServlet in interface ServletContext
        Parameters:
        servletName - The name of the servlet to register
        className - The implementation class for the servlet
        Returns:
        The registration object that enables further configuration

      • getServletRegistration

        public ServletRegistration getServletRegistration​(java.lang.String servletName)
        Deprecated.
        Description copied from interface: ServletContext
        Obtain the details of the named servlet.
        Specified by:
        getServletRegistration in interface ServletContext
        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

      • setSessionTrackingModes

        public void setSessionTrackingModes​(java.util.Set<SessionTrackingMode> sessionTrackingModes)
        Deprecated.
        Description copied from interface: ServletContext
        Configures the available session tracking modes for this web application.
        Specified by:
        setSessionTrackingModes in interface ServletContext
        Parameters:
        sessionTrackingModes - The session tracking modes to use for this web application

      • addListener

        public void addListener​(java.lang.String className)
        Deprecated.
        Description copied from interface: ServletContext
        TODO SERVLET3 - Add comments
        Specified by:
        addListener in interface ServletContext
        Parameters:
        className - TODO

      • addListener

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

      • addListener

        public void addListener​(java.lang.Class<? extends java.util.EventListener> listenerClass)
        Deprecated.
        Description copied from interface: ServletContext
        TODO SERVLET3 - Add comments
        Specified by:
        addListener in interface ServletContext
        Parameters:
        listenerClass - TODO

      • createListener

        public <T extends java.util.EventListener> T createListener​(java.lang.Class<T> clazz)
                                                     throws ServletException
        Deprecated.
        Description copied from interface: ServletContext
        TODO SERVLET3 - Add comments
        Specified by:
        createListener in interface ServletContext
        Type Parameters:
        T - TODO
        Parameters:
        clazz - TODO
        Returns:
        TODO
        Throws:
        ServletException - TODO

      • getClassLoader

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

      • setEffectiveMajorVersion

        public void setEffectiveMajorVersion​(int v)
        Deprecated.

      • setEffectiveMinorVersion

        public void setEffectiveMinorVersion​(int v)
        Deprecated.

      • declareRoles

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

      • getVirtualServerName

        public java.lang.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
        Returns:
        The primary name of the virtual host on which this context is deployed