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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HttpInputStream
getBody()
Access the possible body of the request message.long
getContentLength()
Access the possible content-length header of this message.HttpCookie
getCookie(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.String
getHeader(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.String
getMethod()
Query the request method of this message, such as POST or GET.java.lang.String
getQuery()
Query the URL query string information.java.lang.String
getScheme()
Query the protocol scheme of this message.java.lang.String
getTrailer(java.lang.String name)
java.util.List<java.lang.String>
getTrailerNames()
java.lang.String
getURI()
Query the URI of this message, which is only /uri with no query string.java.lang.String
getURL()
Query the full URL of this message, in the form of scheme://host:port/uri<?query>.java.lang.String
getVersion()
Query the protocol version of this message.java.lang.String
getVirtualHost()
Query the virtual host target of this message.int
getVirtualPort()
Query the virtual port of this request message.boolean
isTrailersReady()
-
-
-
Method Detail
-
getMethod
java.lang.String getMethod()
Query the request method of this message, such as POST or GET.- Returns:
- String
-
getURI
java.lang.String getURI()
Query the URI of this message, which is only /uri with no query string.- Returns:
- String
-
getURL
java.lang.String getURL()
Query the full URL of this message, in the form of scheme://host:port/uri<?query>.- Returns:
- String
-
getVersion
java.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
-
getScheme
java.lang.String getScheme()
Query the protocol scheme of this message. This will be "HTTP" or "HTTPS".- Returns:
- String
-
getQuery
java.lang.String getQuery()
Query the URL query string information. This might be null if not present.- Returns:
- String
-
getVirtualHost
java.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
-
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
java.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
-
getHeaders
java.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
-
getHeaderNames
java.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
-
getCookie
HttpCookie 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
-
getCookies
java.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
-
getCookies
java.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
-
getBody
HttpInputStream getBody()
Access the possible body of the request message. This is never null but might be an empty stream.- Returns:
- HttpInputStream
-
getTrailerNames
java.util.List<java.lang.String> getTrailerNames()
-
getTrailer
java.lang.String getTrailer(java.lang.String name)
-
isTrailersReady
boolean isTrailersReady()
-
-