org.apache.struts2.jasper.servlet

## Class JspCServletContext

- java.lang.Object
- - org.apache.struts2.jasper.servlet.JspCServletContext

- All Implemented Interfaces:
    javax.servlet.ServletContext

      public class JspCServletContext
      extends Object
      implements javax.servlet.ServletContext

  Simple `ServletContext` implementation without HTTP-specific methods.
  Author:
    Peter Rossbach (pr@webapp.de)

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected Hashtable` | `myAttributes` Servlet context attributes.
    `protected PrintWriter` | `myLogWriter` The log writer we will write log messages to.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JspCServletContext(PrintWriter aLogWriter, ClassLoaderInterface classLoaderInterface)` Create a new instance of this ServletContext implementation.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `getAttribute(String name)`
    `Enumeration` | `getAttributeNames()`
    `javax.servlet.ServletContext` | `getContext(String uripath)`
    `String` | `getContextPath()`
    `String` | `getInitParameter(String name)`
    `Enumeration` | `getInitParameterNames()`
    `int` | `getMajorVersion()`
    `String` | `getMimeType(String file)`
    `int` | `getMinorVersion()`
    `javax.servlet.RequestDispatcher` | `getNamedDispatcher(String name)`
    `String` | `getRealPath(String path)`
    `javax.servlet.RequestDispatcher` | `getRequestDispatcher(String path)`
    `URL` | `getResource(String path)`
    `InputStream` | `getResourceAsStream(String path)`
    `Set` | `getResourcePaths(String path)`
    `String` | `getServerInfo()`
    `javax.servlet.Servlet` | `getServlet(String name)` Deprecated. This method has been deprecated with no replacement
    `String` | `getServletContextName()`
    `Enumeration` | `getServletNames()` Deprecated. This method has been deprecated with no replacement
    `Enumeration` | `getServlets()` Deprecated. This method has been deprecated with no replacement
    `void` | `log(Exception exception, String message)` Deprecated. Use log(String,Throwable) instead
    `void` | `log(String message)` Log the specified message.
    `void` | `log(String message, Throwable exception)` Log the specified message and exception.
    `void` | `removeAttribute(String name)` Remove the specified context attribute.
    `void` | `setAttribute(String name, Object value)` Set or replace the specified context attribute.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### myAttributes

          protected Hashtable myAttributes

      Servlet context attributes.

    - #### myLogWriter

          protected PrintWriter myLogWriter

      The log writer we will write log messages to.

  - ### Constructor Detail

    - #### JspCServletContext

          public JspCServletContext(PrintWriter aLogWriter,
                            ClassLoaderInterface classLoaderInterface)

      Create a new instance of this ServletContext implementation.
      Parameters:
        `aLogWriter` - PrintWriter which is used for `log()` calls
        `classLoaderInterface` - classloader interface

  - ### Method Detail

    - #### getAttribute

          public Object getAttribute(String name)

      Specified by:
        `getAttribute` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the requested attribute
      Returns:
        the specified context attribute, if any.

    - #### getAttributeNames

          public Enumeration getAttributeNames()

      Specified by:
        `getAttributeNames` in interface `javax.servlet.ServletContext`
      Returns:
        an enumeration of context attribute names.

    - #### getContext

          public javax.servlet.ServletContext getContext(String uripath)

      Specified by:
        `getContext` in interface `javax.servlet.ServletContext`
      Parameters:
        `uripath` - Server-relative path starting with '/'
      Returns:
        the servlet context for the specified path.

    - #### getContextPath

          public String getContextPath()

      Returns:
        the context path.

    - #### getInitParameter

          public String getInitParameter(String name)

      Specified by:
        `getInitParameter` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the requested parameter
      Returns:
        the specified context initialization parameter.

    - #### getInitParameterNames

          public Enumeration getInitParameterNames()

      Specified by:
        `getInitParameterNames` in interface `javax.servlet.ServletContext`
      Returns:
        an enumeration of the names of context initialization parameters.

    - #### getMajorVersion

          public int getMajorVersion()

      Specified by:
        `getMajorVersion` in interface `javax.servlet.ServletContext`
      Returns:
        the Servlet API major version number.

    - #### getMimeType

          public String getMimeType(String file)

      Specified by:
        `getMimeType` in interface `javax.servlet.ServletContext`
      Parameters:
        `file` - Filename whose MIME type is requested
      Returns:
        the MIME type for the specified filename.

    - #### getMinorVersion

          public int getMinorVersion()

      Specified by:
        `getMinorVersion` in interface `javax.servlet.ServletContext`
      Returns:
        the Servlet API minor version number.

    - #### getNamedDispatcher

          public javax.servlet.RequestDispatcher getNamedDispatcher(String name)

      Specified by:
        `getNamedDispatcher` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the requested servlet
      Returns:
        a request dispatcher for the specified servlet name.

    - #### getRealPath

          public String getRealPath(String path)

      Specified by:
        `getRealPath` in interface `javax.servlet.ServletContext`
      Parameters:
        `path` - The context-relative virtual path to resolve
      Returns:
        the real path for the specified context-relative virtual path.

    - #### getRequestDispatcher

          public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

      Specified by:
        `getRequestDispatcher` in interface `javax.servlet.ServletContext`
      Parameters:
        `path` - Context-relative path for which to acquire a dispatcher
      Returns:
        a request dispatcher for the specified context-relative path.

    - #### getResource

          public URL getResource(String path)
                          throws MalformedURLException

      Specified by:
        `getResource` in interface `javax.servlet.ServletContext`
      Parameters:
        `path` - Context-relative path of the desired resource
      Returns:
        a URL object of a resource that is mapped to the specified context-relative path.
      Throws:
        `MalformedURLException` - if the resource path is not properly formed

    - #### getResourceAsStream

          public InputStream getResourceAsStream(String path)

      Specified by:
        `getResourceAsStream` in interface `javax.servlet.ServletContext`
      Parameters:
        `path` - Context-relative path of the desired resource
      Returns:
        an InputStream allowing access to the resource at the specified context-relative path.

    - #### getResourcePaths

          public Set getResourcePaths(String path)

      Specified by:
        `getResourcePaths` in interface `javax.servlet.ServletContext`
      Parameters:
        `path` - Context-relative base path
      Returns:
        the set of resource paths for the "directory" at the specified context path.

    - #### getServerInfo

          public String getServerInfo()

      Specified by:
        `getServerInfo` in interface `javax.servlet.ServletContext`
      Returns:
        descriptive information about this server.

    - #### getServlet

          public javax.servlet.Servlet getServlet(String name)
                                           throws javax.servlet.ServletException

      Deprecated. This method has been deprecated with no replacement
      Specified by:
        `getServlet` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the requested servlet
      Returns:
        a null reference for the specified servlet name.
      Throws:
        `javax.servlet.ServletException`

    - #### getServletContextName

          public String getServletContextName()

      Specified by:
        `getServletContextName` in interface `javax.servlet.ServletContext`
      Returns:
        the name of this servlet context.

    - #### getServletNames

          public Enumeration getServletNames()

      Deprecated. This method has been deprecated with no replacement
      Specified by:
        `getServletNames` in interface `javax.servlet.ServletContext`
      Returns:
        an empty enumeration of servlet names.

    - #### getServlets

          public Enumeration getServlets()

      Deprecated. This method has been deprecated with no replacement
      Specified by:
        `getServlets` in interface `javax.servlet.ServletContext`
      Returns:
        an empty enumeration of servlets.

    - #### log

          public void log(String message)

      Log the specified message.
      Specified by:
        `log` in interface `javax.servlet.ServletContext`
      Parameters:
        `message` - The message to be logged

    - #### log

          public void log(Exception exception,
                 String message)

      Deprecated. Use log(String,Throwable) instead
      Log the specified message and exception.
      Specified by:
        `log` in interface `javax.servlet.ServletContext`
      Parameters:
        `exception` - The exception to be logged
        `message` - The message to be logged

    - #### log

          public void log(String message,
                 Throwable exception)

      Log the specified message and exception.
      Specified by:
        `log` in interface `javax.servlet.ServletContext`
      Parameters:
        `message` - The message to be logged
        `exception` - The exception to be logged

    - #### removeAttribute

          public void removeAttribute(String name)

      Remove the specified context attribute.
      Specified by:
        `removeAttribute` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the attribute to remove

    - #### setAttribute

          public void setAttribute(String name,
                          Object value)

      Set or replace the specified context attribute.
      Specified by:
        `setAttribute` in interface `javax.servlet.ServletContext`
      Parameters:
        `name` - Name of the context attribute to set
        `value` - Corresponding attribute value

Copyright © 2000–2021 Apache Software Foundation. All rights reserved.