Package com.ibm.wsspi.http

Interface HttpRequest

All Known Subinterfaces:
Http2Request
public interface HttpRequest
Representation of an HTTP request message provided by the dispatcher to any HTTP container.

  • Method Details

    • getMethod

      String getMethod()
      Query the request method of this message, such as POST or GET.
      Returns:
      String

    • getURI

      String getURI()
      Query the URI of this message, which is only /uri with no query string.
      Returns:
      String

    • getURL

      String getURL()
      Query the full URL of this message, in the form of scheme://host:port/uri<?query>.
      Returns:
      String

    • getVersion

      String getVersion()
      Query the protocol version of this message. It will be in the form of "HTTP/<major>.<minor>". This is never null.
      Returns:
      String

    • getScheme

      String getScheme()
      Query the protocol scheme of this message. This will be "HTTP" or "HTTPS".
      Returns:
      String

    • getQuery

      String getQuery()
      Query the URL query string information. This might be null if not present.
      Returns:
      String

    • getVirtualHost

      String getVirtualHost()
      Query the virtual host target of this message. It might exist in the URL or the Host header, and may or may not match the actual socket target. If it is not set in either of those two locations, a null is returned.
      Returns:
      String

    • getVirtualPort

      int getVirtualPort()
      Query the virtual port of this request message. It might exist in the URL or the Host header, and may or may not match the actual socket port. If it is not set in either of those two locations, a -1 is returned.
      Returns:
      int

    • getContentLength

      long getContentLength()
      Access the possible content-length header of this message. It will return -1L if no header exists.
      Returns:
      long

    • getHeader

      String getHeader(String name)
      Access the first instance found for the given header name. This might be null if no instance was found.
      Parameters:
      name -
      Returns:
      String

    • getHeaders

      List<String> getHeaders(String name)
      Access a list of all header values found for the given header name. This list is never null, but might be empty.
      Parameters:
      name -
      Returns:
      List

    • getHeaderNames

      List<String> getHeaderNames()
      Access a list of all header names found in this message. This list is never null, but might be empty.
      Returns:
      List

    • getCookie

      HttpCookie getCookie(String name)
      Access the first cookie instance in the message with the provided name. This might be null if no match is found.
      Parameters:
      name -
      Returns:
      HttpCookie

    • getCookies

      List<HttpCookie> getCookies(String name)
      Access the list of all cookies matching the provided name. This list is never null, but might be empty.
      Parameters:
      name -
      Returns:
      List

    • getCookies

      List<HttpCookie> getCookies()
      Access the list of all cookies found in this message. The list is never null, but might be empty.
      Returns:
      List

    • getBody

      HttpInputStream getBody()
      Access the possible body of the request message. This is never null but might be an empty stream.
      Returns:
      HttpInputStream

    • getTrailerNames

      List<String> getTrailerNames()

    • getTrailer

      String getTrailer(String name)

    • isTrailersReady

      boolean isTrailersReady()