ServletRequestContext (Apache Tomcat 11.0.25 API Documentation)
Description: declaration: package: org.apache.tomcat.util.http.fileupload.servlet, class: ServletRequestContext

# Class ServletRequestContext

java.lang.Object
org.apache.tomcat.util.http.fileupload.servlet.ServletRequestContext

All Implemented Interfaces:
  `RequestContext, UploadContext`

public class ServletRequestContext extends Object implements UploadContext

Provides access to the request information needed for a request made to an HTTP servlet.

Since:
  FileUpload 1.1

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ServletRequestContext(HttpServletRequest request)`
  Construct a context for this request.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `long`
  `contentLength()`
  Retrieve the content length of the request.
  `String`
  `getCharacterEncoding()`
  Retrieve the character encoding for the request.
  `String`
  `getContentType()`
  Retrieve the content type of the request.
  `InputStream`
  `getInputStream()`
  Retrieve the input stream for the request.
  `String`
  `toString()`
  Returns a string representation of this object.

  ### Methods inherited from class Object

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

- ## Constructor Details

  - ### ServletRequestContext

    public ServletRequestContext(HttpServletRequest request)
    Construct a context for this request.
    Parameters:
      `request` - The request to which this context applies.

- ## Method Details

  - ### contentLength

    public long contentLength()
    Retrieve the content length of the request.
    Specified by:
      `contentLength` in interface `UploadContext`
    Returns:
      The content length of the request.
    Since:
      FileUpload 1.3

  - ### getCharacterEncoding

    public String getCharacterEncoding()
    Retrieve the character encoding for the request.
    Specified by:
      `getCharacterEncoding` in interface `RequestContext`
    Returns:
      The character encoding for the request.

  - ### getContentType

    public String getContentType()
    Retrieve the content type of the request.
    Specified by:
      `getContentType` in interface `RequestContext`
    Returns:
      The content type of the request.

  - ### getInputStream

    public InputStream getInputStream() throws IOException
    Retrieve the input stream for the request.
    Specified by:
      `getInputStream` in interface `RequestContext`
    Returns:
      The input stream for the request.
    Throws:
      `IOException` - if a problem occurs.

  - ### toString

    public String toString()
    Returns a string representation of this object.
    Overrides:
      `toString` in class `Object`
    Returns:
      a string representation of this object.