Interface HttpServletRequest

All Superinterfaces:
ServletRequest
public interface HttpServletRequest extends ServletRequest
Contains all the client's request information. Implementation note: all the headername matching in this class should be caseinsensitive.
Since:
Servlet API 1.0
Version:
Servlet API 2.2

  • Method Details

    • getAuthType

      String getAuthType()
      Gets the authorization scheme of this request. This is the same as the CGI request metadata AUTH_TYPE. See also section 11 of the HTTP/1.1 specification (RFC 2068).
      Returns:
      Authorization scheme or null if not set
      Since:
      Servlet API 1.0

    • getCookies

      Cookie[] getCookies()
      Gets all the Cookies present in the request.
      Returns:
      an array containing all the Cookies or an empty array if there are no cookies
      Since:
      Servlet API 2.0

    • getDateHeader

      long getDateHeader(String name)
      Converts a given header parameter name to a date in the form of the number of milliseconds since 1 january 1970 midnight GMT. If the headername doesn't exist it returns -1; If the header can not be converted to a date it throws an IllegalArgumentException.
      Parameters:
      name - the name of the header field (case insensitive)
      Returns:
      milliseconds since January 1, 1970, 00:00:00 GMT or -1 if the header does not exist.
      Throws:
      IllegalArgumentException - if the value is not a date
      Since:
      Servlet API 1.0

    • getHeader

      String getHeader(String name)
      Gets a named header. returns null if the headername doesn't exist.
      Parameters:
      name - the name of the header field (case insensitive)
      Returns:
      The value of the header or null if the header does not exist
      Since:
      Servlet API 1.0

    • getHeaders

      Enumeration getHeaders(String name)
      XXX
      Since:
      Servlet API 2.2

    • getHeaderNames

      Enumeration getHeaderNames()
      Gets an Enumeration with all the headernames. Note that the Servlet API 2.1 Specification says that if an implementation does not support this operation an empty enumeration should be returned, but the Servlet API documentation says that the implementation will return null.
      Returns:
      Enumeration of all the header names or when this operation is not supported an empty Enumeration or null.
      Since:
      Servlet API 1.0

    • getIntHeader

      int getIntHeader(String name) throws NumberFormatException
      Gets a named header and returns it in the shape of an int. returns -1 if the headername doesn't exist.
      [MJW] What if the value is -1?
      Parameters:
      name - the name of the header field (case insensitive)
      Returns:
      the value of the header field or -1 if the header does not exist
      Throws:
      NumberFormatException - if the headervalue can't be converted to an int.
      Since:
      Servlet API 1.0

    • getMethod

      String getMethod()
      Gets the method the client used. This is the same as the CGI request metadata REQUEST_METHOD. Possible return values are "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS", "TRACE".
      Returns:
      The method in question
      Since:
      Servlet API 1.0

    • getContextPath

      String getContextPath()
      XXX
      Since:
      Servlet API 2.2

    • getPathInfo

      String getPathInfo()
      Extra path info. Everything after the actual Servlet except the query data. This is the same as the CGI request metadata PATH_INFO and identifies the source or sub-resource to be returned by the Servlet.

      The function of this method could best be explained using an example. Client requests: www.foo_bar.com/servlets/myServlet/more/path?id=paul (where myServlet is a servlet)
      In this case this method would return "/more/path".

      [MJW] Note that the Servlet 2.1 Spec says that the path info must be URL decoded although this was not required before 2.1 and I am not sure if that is the behaviour of the CGI request metadata PATH_INFO.

      Returns:
      The path info or null when there is no path information.
      Since:
      Servlet API 1.0

    • getPathTranslated

      String getPathTranslated()
      The filesystem path to the path info. Does the same as getPathInfo, but translates the result to a real path. This is the same as the CGI request metadata PATH_TRANSLATED.

      [MJW] Can this be different from calling ServletContext.getRealPath() on the urldecoded result of getPathInfo()?

      Returns:
      The filesystem path to the file indicated by the path info or null if there is no path info
      Since:
      Servlet API 1.0

    • getQueryString

      String getQueryString()
      Gets the request's query string. The query string is the part of the request that follows the '?'.
      This is the same as the CGI request metadata QUERY_STRING.
      Returns:
      the query string or null if there is no such part
      Since:
      Servlet API 1.0

    • getRemoteUser

      String getRemoteUser()
      Gets the username of the person sending the request. This is the same as the CGI request metadata REMOTE_USER.
      Returns:
      User name or null if the username wasn't in the HTTP authentication.
      Since:
      Servlet API 1.0

    • isUserInRole

      boolean isUserInRole(String role)
      XXX
      Since:
      Servlet API 2.2

    • getUserPrincipal

      Principal getUserPrincipal()
      XXX
      Since:
      Servlet API 2.2

    • getRequestedSessionId

      String getRequestedSessionId()
      Gets the session Id of this request that the client wanted. This id can differ from the id in the current session if the client recently had gotten a new session id for whatver reason.
      Returns:
      The requested session id
      Since:
      Servlet API 2.0

    • getRequestURI

      String getRequestURI()
      Gets the requested URI. This includes both the path to the servlet and everything after that except the '?' and the query_string.

      Note that the Servlet 2.1 Spec says that the URI must be decoded before being returned, but this was not required before the Servlet 2.1 API and normally all URIs are encoded.

      Returns:
      The requested URI
      Since:
      Servlet API 1.0

    • getServletPath

      String getServletPath()
      Gets the part of the URI up to and including the servlet name. No path info or query string segments are included. This is the same as the CGI request metadata SCRIPT_NAME.
      Since:
      Servlet API 1.0

    • getSession

      HttpSession getSession()
      Gets the HttpSession connected with the client sending the request. If the client didn't have a session connected with him then a new HttpSession will be created. To maintain a session this method must be called before the connection is flushed or closed. Same as calling getSession(true).
      Returns:
      The HttpSession connected with the client sending the request.
      Since:
      Servlet API 2.1

    • getSession

      HttpSession getSession(boolean create)
      Gets the HttpSession connected with the client sending the request. If the client didn't have a session connected with him, and create is true then a new HttpSession will be created. If create is false then null is returned. To maintain a session this method must be called before the connection is flushed or closed.
      Returns:
      The HttpSession connected with the client sending the request.
      Since:
      Servlet API 2.0

    • isRequestedSessionIdValid

      boolean isRequestedSessionIdValid()
      Checks whether the session connected with the id in the request is a valid one. Note that the requested session could differ from the actual session returned from getSession.
      Since:
      Servlet API 2.0

    • isRequestedSessionIdFromCookie

      boolean isRequestedSessionIdFromCookie()
      Returns whether the session id in the request was provided through a Cookie.
      Since:
      Servlet API 2.0

    • isRequestedSessionIdFromURL

      boolean isRequestedSessionIdFromURL()
      Returns whether the session id in the request was encoded in the request URI.
      Since:
      Servlet API 2.1

    • isRequestedSessionIdFromUrl

      boolean isRequestedSessionIdFromUrl()
      Deprecated.
      Use isRequestedSessionIdFromURL
      Returns whether the session id in the request was encoded in the request URI.
      Since:
      Servlet API 2.0