Package com.ibm.wsspi.http
Interface HttpRequest
- 
- All Known Subinterfaces:
- Http2Request
 
 public interface HttpRequestRepresentation of an HTTP request message provided by the dispatcher to any HTTP container.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description HttpInputStreamgetBody()Access the possible body of the request message.longgetContentLength()Access the possible content-length header of this message.HttpCookiegetCookie(java.lang.String name)Access the first cookie instance in the message with the provided name.java.util.List<HttpCookie>getCookies()Access the list of all cookies found in this message.java.util.List<HttpCookie>getCookies(java.lang.String name)Access the list of all cookies matching the provided name.java.lang.StringgetHeader(java.lang.String name)Access the first instance found for the given header name.java.util.List<java.lang.String>getHeaderNames()Access a list of all header names found in this message.java.util.List<java.lang.String>getHeaders(java.lang.String name)Access a list of all header values found for the given header name.java.lang.StringgetMethod()Query the request method of this message, such as POST or GET.java.lang.StringgetQuery()Query the URL query string information.java.lang.StringgetScheme()Query the protocol scheme of this message.java.lang.StringgetTrailer(java.lang.String name)java.util.List<java.lang.String>getTrailerNames()java.lang.StringgetURI()Query the URI of this message, which is only /uri with no query string.java.lang.StringgetURL()Query the full URL of this message, in the form of scheme://host:port/uri<?query>.java.lang.StringgetVersion()Query the protocol version of this message.java.lang.StringgetVirtualHost()Query the virtual host target of this message.intgetVirtualPort()Query the virtual port of this request message.booleanisTrailersReady()
 
- 
- 
- 
Method Detail- 
getMethodjava.lang.String getMethod() Query the request method of this message, such as POST or GET.- Returns:
- String
 
 - 
getURIjava.lang.String getURI() Query the URI of this message, which is only /uri with no query string.- Returns:
- String
 
 - 
getURLjava.lang.String getURL() Query the full URL of this message, in the form of scheme://host:port/uri<?query>.- Returns:
- String
 
 - 
getVersionjava.lang.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
 
 - 
getSchemejava.lang.String getScheme() Query the protocol scheme of this message. This will be "HTTP" or "HTTPS".- Returns:
- String
 
 - 
getQueryjava.lang.String getQuery() Query the URL query string information. This might be null if not present.- Returns:
- String
 
 - 
getVirtualHostjava.lang.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
 
 - 
getVirtualPortint 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
 
 - 
getContentLengthlong getContentLength() Access the possible content-length header of this message. It will return -1L if no header exists.- Returns:
- long
 
 - 
getHeaderjava.lang.String getHeader(java.lang.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
 
 - 
getHeadersjava.util.List<java.lang.String> getHeaders(java.lang.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
 
 - 
getHeaderNamesjava.util.List<java.lang.String> getHeaderNames() Access a list of all header names found in this message. This list is never null, but might be empty.- Returns:
- List
 
 - 
getCookieHttpCookie getCookie(java.lang.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
 
 - 
getCookiesjava.util.List<HttpCookie> getCookies(java.lang.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
 
 - 
getCookiesjava.util.List<HttpCookie> getCookies() Access the list of all cookies found in this message. The list is never null, but might be empty.- Returns:
- List
 
 - 
getBodyHttpInputStream getBody() Access the possible body of the request message. This is never null but might be an empty stream.- Returns:
- HttpInputStream
 
 - 
getTrailerNamesjava.util.List<java.lang.String> getTrailerNames() 
 - 
getTrailerjava.lang.String getTrailer(java.lang.String name) 
 - 
isTrailersReadyboolean isTrailersReady() 
 
- 
 
-