HttpRequestMetaData (servicetalk-http-api 0.28.0 API)

All Superinterfaces:

HttpMetaData

All Known Subinterfaces:

BlockingStreamingHttpRequest, HttpRequest, StreamingHttpRequest
```
public interface HttpRequestMetaData
extends HttpMetaData
```
Meta data associated with an HTTP request.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default HttpRequestMetaData`	`addCookie(CharSequence name, CharSequence value)` Adds a cookie with the specified `name` and `value`.
`default HttpRequestMetaData`	`addCookie(HttpCookiePair cookie)` Adds a cookie.
`default HttpRequestMetaData`	`addHeader(CharSequence name, CharSequence value)` Adds a new header with the specified `name` and `value`.
`default HttpRequestMetaData`	`addHeaders(HttpHeaders headers)` Adds all header names and values of `headers` object.
`HttpRequestMetaData`	`addQueryParameter(String key, String value)` Adds a new query parameter with the specified `key` and `value`, which will be percent-encoded if needed.
`HttpRequestMetaData`	`addQueryParameters(String key, Iterable<String> values)` Adds new query parameters with the specified `key` and `values`.
`HttpRequestMetaData`	`addQueryParameters(String key, String... values)` Adds new query parameters with the specified `key` and `values`.
`default HttpRequestMetaData`	`addSetCookie(CharSequence name, CharSequence value)` Adds a set-cookie with the specified `name` and `value`.
`default HttpRequestMetaData`	`addSetCookie(HttpSetCookie cookie)` Adds a set-cookie.
`HttpRequestMetaData`	`appendPathSegments(String... segments)` Appends segments to the current `path()`, performing encoding of each segment (including (`'/'`) characters) according to percent-encoding.
`String`	`effectiveHost()` The host component derived from `requestTarget()` and the `Host` header field value.
`int`	`effectivePort()` The port component derived from `requestTarget()` and the `Host` header field value.
`default boolean`	`hasQueryParameter(String key)` Returns `true` if a query parameter with the `key` exists, `false` otherwise.
`boolean`	`hasQueryParameter(String key, String value)` Returns `true` if a query parameter with the `key` and `value` exists, `false` otherwise.
`String`	`host()` The host component derived from `requestTarget()`.
`HttpRequestMethod`	`method()` Returns the `HttpRequestMethod` of this `StreamingHttpRequest`.
`HttpRequestMetaData`	`method(HttpRequestMethod method)` Set the `HttpRequestMethod` of this `StreamingHttpRequest`.
`String`	`path()` Get an equivalent value as `rawPath()` but decoded according to percent-encoding.
`HttpRequestMetaData`	`path(String path)` Sets the path, performing encoding according to percent-encoding, except for forward-slash (`'/'`) characters.
`int`	`port()` The port component derived from `requestTarget()`.
`String`	`queryParameter(String key)` Returns the value of a query parameter with the specified key.
`Iterable<Map.Entry<String,String>>`	`queryParameters()` Returns all query parameters as key/value pairs.
`Iterable<String>`	`queryParameters(String key)` Returns all values for the query parameter with the specified key.
`Iterator<String>`	`queryParametersIterator(String key)` Returns all values for the query parameter with the specified key.
`Set<String>`	`queryParametersKeys()` Returns a `Set` of all query parameter keys.
`int`	`queryParametersSize()` Returns the number of query parameters.
`String`	`rawPath()` The path component derived from `requestTarget()`.
`HttpRequestMetaData`	`rawPath(String path)` Sets the path to `path`, without any encoding performed.
`String`	`rawQuery()` The query component derived from `requestTarget()`.
`HttpRequestMetaData`	`rawQuery(String query)` Sets the query component to `query`, without any encoding performed.
`boolean`	`removeQueryParameters(String key)` Removes all query parameters with the specified `key`.
`boolean`	`removeQueryParameters(String key, String value)` Removes all query parameters with the specified `key` and `value`.
`String`	`requestTarget()` The request-target.
`HttpRequestMetaData`	`requestTarget(String requestTarget)` Set the request-target.
`String`	`scheme()` The scheme component derived from `requestTarget()` in lower case.
`default HttpRequestMetaData`	`setHeader(CharSequence name, CharSequence value)` Sets a header with the specified `name` and `value`.
`default HttpRequestMetaData`	`setHeaders(HttpHeaders headers)` Clears the current header entries and copies all header entries of the specified `headers` object.
`HttpRequestMetaData`	`setQueryParameter(String key, String value)` Sets a query parameter with the specified `key` and `value`, which will be percent-encoded if needed.
`HttpRequestMetaData`	`setQueryParameters(String key, Iterable<String> values)` Sets new query parameters with the specified `key` and `values`.
`HttpRequestMetaData`	`setQueryParameters(String key, String... values)` Sets new query parameters with the specified `key` and `values`.
`String`	`userInfo()` The user information component derived from `requestTarget()`.
`HttpRequestMetaData`	`version(HttpProtocolVersion version)` Set the protocol version of this `HttpMetaData`.

Methods inherited from interface HttpMetaData
headers, toString, toString, version

- Method Detail
  - method
```
HttpRequestMethod method()
```
    Returns the HttpRequestMethod of this StreamingHttpRequest.
    
    Returns:
    
    The HttpRequestMethod of this StreamingHttpRequest
  - method
```
HttpRequestMetaData method(HttpRequestMethod method)
```
    Set the HttpRequestMethod of this StreamingHttpRequest.
    
    Parameters:
    
    method - the HttpRequestMethod to set.
    
    Returns:
    
    this.
  - requestTarget
```
String requestTarget()
```
    The request-target.
    No decoding has been done on the request-target.
    
    Returns:
    
    The request-target.
    No decoding has been done on the request-target.
  - requestTarget
```
HttpRequestMetaData requestTarget(String requestTarget)
```
    Set the request-target.
    This will be treated as encoded according to percent-encoding.
    This may result in clearing of internal caches used by methods that are derived from the request-target, such as path(), rawQuery(), etc.
    
    Parameters:
    
    requestTarget - the percent-encoded request-target to set.
    
    Returns:
    
    this.
  - scheme
```
@Nullable
String scheme()
```
    The scheme component derived from requestTarget() in lower case.
    
    Returns:
    
    The scheme component derived from requestTarget() in lower case, or null if none can be derived.
  - userInfo
```
@Nullable
String userInfo()
```
    The user information component derived from requestTarget().
    
    Returns:
    
    The user information component derived from requestTarget(), or null if none can be derived.
  - host
```
@Nullable
String host()
```
    The host component derived from requestTarget().
    
    Returns:
    
    The host component derived from requestTarget(), or null if none can be derived.
  - port
```
int port()
```
    The port component derived from requestTarget().
    
    Returns:
    
    The port component derived from requestTarget(), or <0 if none can be derived.
  - rawPath
```
String rawPath()
```
    The path component derived from requestTarget().
    No decoding has been done on the query component: the value is provided as specified in the request target.
    
    Returns:
    
    The path component derived from requestTarget().
    No decoding has been done on the query component: the value is provided as specified in the request target.
  - path
```
String path()
```
    Get an equivalent value as rawPath() but decoded according to percent-encoding.
    
    Returns:
    
    an equivalent value as rawPath() but decoded according to percent-encoding.
  - rawPath
```
HttpRequestMetaData rawPath(String path)
```
    Sets the path to path, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.
    Because this modifies the request target, this may result in the clearing of internal caches. See requestTarget(String).
    
    Parameters:
    
    path - the encoded path to set.
    
    Returns:
    
    this.
  - path
```
HttpRequestMetaData path(String path)
```
    Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/') characters. This allows for path("/abc") without it turning into '%2Fabc'.
    
    Parameters:
    
    path - the un-encoded path to set.
    
    Returns:
    
    this.
  - appendPathSegments
```
HttpRequestMetaData appendPathSegments(String... segments)
```
    Appends segments to the current path(), performing encoding of each segment (including ('/') characters) according to percent-encoding. A / is used to separate each segment and between the current path() and the following segments.
    
    Parameters:
    
    segments - the un-encoded path to set.
    
    Returns:
    
    this.
  - rawQuery
```
String rawQuery()
```
    The query component derived from requestTarget().
    No decoding has been done on the query component: the value is provided as specified in the request target.
    
    Returns:
    
    The query component derived from requestTarget().
    No decoding has been done on the query component: the value is provided as specified in the request target.
  - rawQuery
```
HttpRequestMetaData rawQuery(String query)
```
    Sets the query component to query, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.
    Because this modifies the request target, this may result in the clearing of internal caches. See requestTarget(String).
    
    Parameters:
    
    query - the encoded query to set.
    
    Returns:
    
    this.
  - queryParameter
```
@Nullable
String queryParameter(String key)
```
    Returns the value of a query parameter with the specified key. If there is more than one value for the specified key, the first value in insertion order is returned.
    
    Parameters:
    
    key - the key of the query parameter to retrieve.
    
    Returns:
    
    the first query parameter value if the key is found. null if there's no such key.
  - queryParameters
```
Iterable<Map.Entry<String,String>> queryParameters()
```
    Returns all query parameters as key/value pairs.
    
    Returns:
    
    an Iterable of query parameter key/value pairs or an empty Iterable if none present.
  - queryParameters
```
Iterable<String> queryParameters(String key)
```
    Returns all values for the query parameter with the specified key.
    
    Parameters:
    
    key - the key of the query parameter to retrieve.
    
    Returns:
    
    an Iterable of query parameter values or an empty Iterable if no values are found.
  - queryParametersIterator
```
Iterator<String> queryParametersIterator(String key)
```
    Returns all values for the query parameter with the specified key.
    
    Parameters:
    
    key - the key of the query parameter to retrieve.
    
    Returns:
    
    an Iterator of query parameter values or an empty Iterator if no values are found.
  - queryParametersKeys
```
Set<String> queryParametersKeys()
```
    Returns a Set of all query parameter keys. The returned Set cannot be modified.
    
    Returns:
    
    a Set of all query parameter keys. The returned Set cannot be modified.
  - hasQueryParameter
```
default boolean hasQueryParameter(String key)
```
    Returns true if a query parameter with the key exists, false otherwise.
    
    Parameters:
    
    key - the query parameter name.
    
    Returns:
    
    true if key exists.
  - hasQueryParameter
```
boolean hasQueryParameter(String key,
                          String value)
```
    Returns true if a query parameter with the key and value exists, false otherwise.
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value of the query parameter to find.
    
    Returns:
    
    true if a key, value pair exists.
  - queryParametersSize
```
int queryParametersSize()
```
    Returns the number of query parameters.
    
    Returns:
    
    the number of query parameters.
  - addQueryParameter
```
HttpRequestMetaData addQueryParameter(String key,
                                      String value)
```
    Adds a new query parameter with the specified key and value, which will be percent-encoded if needed.
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value.
    
    Returns:
    
    this.
  - addQueryParameters
```
HttpRequestMetaData addQueryParameters(String key,
                                       Iterable<String> values)
```
    Adds new query parameters with the specified key and values. This method is semantically equivalent to:
```
 for (T value : values) {
     addQueryParameter(key, value);
 }
 
```
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - addQueryParameters
```
HttpRequestMetaData addQueryParameters(String key,
                                       String... values)
```
    Adds new query parameters with the specified key and values. This method is semantically equivalent to:
```
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - setQueryParameter
```
HttpRequestMetaData setQueryParameter(String key,
                                      String value)
```
    Sets a query parameter with the specified key and value, which will be percent-encoded if needed. Any existing query parameters with the same key are overwritten.
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value.
    
    Returns:
    
    this.
  - setQueryParameters
```
HttpRequestMetaData setQueryParameters(String key,
                                       Iterable<String> values)
```
    Sets new query parameters with the specified key and values. This method is equivalent to:
```
 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - setQueryParameters
```
HttpRequestMetaData setQueryParameters(String key,
                                       String... values)
```
    Sets new query parameters with the specified key and values. This method is equivalent to:
```
 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - removeQueryParameters
```
boolean removeQueryParameters(String key)
```
    Removes all query parameters with the specified key.
    
    Parameters:
    
    key - the query parameter key.
    
    Returns:
    
    true if at least one entry has been removed.
  - removeQueryParameters
```
boolean removeQueryParameters(String key,
                              String value)
```
    Removes all query parameters with the specified key and value.
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value.
    
    Returns:
    
    true if at least one entry has been removed.
  - effectiveHost
```
@Nullable
String effectiveHost()
```
    The host component derived from requestTarget() and the Host header field value. This is the scheme component to use when computing an effective request URI.
    
    Returns:
    
    The host component derived from requestTarget() and the Host header field value, or null if none can be derived.
  - effectivePort
```
int effectivePort()
```
    The port component derived from requestTarget() and the Host header field value. This is the scheme component to use when computing an effective request URI.
    
    Returns:
    
    The port component derived from requestTarget(), and the Host header field value, or <0 if none can be derived.
  - version
```
HttpRequestMetaData version(HttpProtocolVersion version)
```
    Description copied from interface: HttpMetaData
    
    Set the protocol version of this HttpMetaData.
    
    Specified by:
    
    version in interface HttpMetaData
    
    Parameters:
    
    version - the protocol version to set.
    
    Returns:
    
    this.
  - addHeader
```
default HttpRequestMetaData addHeader(CharSequence name,
                                      CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a new header with the specified name and value.
    
    Specified by:
    
    addHeader in interface HttpMetaData
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header.
    
    Returns:
    
    this.
  - addHeaders
```
default HttpRequestMetaData addHeaders(HttpHeaders headers)
```
    Description copied from interface: HttpMetaData
    
    Adds all header names and values of headers object.
    
    Specified by:
    
    addHeaders in interface HttpMetaData
    
    Parameters:
    
    headers - the headers to add.
    
    Returns:
    
    this.
  - setHeader
```
default HttpRequestMetaData setHeader(CharSequence name,
                                      CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Sets a header with the specified name and value. Any existing headers with the same name are overwritten.
    
    Specified by:
    
    setHeader in interface HttpMetaData
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header.
    
    Returns:
    
    this.
  - setHeaders
```
default HttpRequestMetaData setHeaders(HttpHeaders headers)
```
    Description copied from interface: HttpMetaData
    
    Clears the current header entries and copies all header entries of the specified headers object.
    
    Specified by:
    
    setHeaders in interface HttpMetaData
    
    Parameters:
    
    headers - the headers object which contains new values.
    
    Returns:
    
    this.
  - addCookie
```
default HttpRequestMetaData addCookie(HttpCookiePair cookie)
```
    Description copied from interface: HttpMetaData
    
    Adds a cookie.
    This may result in multiple HttpCookiePairs with same name.
    
    Specified by:
    
    addCookie in interface HttpMetaData
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    this.
  - addCookie
```
default HttpRequestMetaData addCookie(CharSequence name,
                                      CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a cookie with the specified name and value.
    This may result in multiple HttpSetCookies with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.
    
    Specified by:
    
    addCookie in interface HttpMetaData
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Returns:
    
    this.
  - addSetCookie
```
default HttpRequestMetaData addSetCookie(HttpSetCookie cookie)
```
    Description copied from interface: HttpMetaData
    
    Adds a set-cookie.
    This may result in multiple HttpSetCookies with same name.
    
    Specified by:
    
    addSetCookie in interface HttpMetaData
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    this.
  - addSetCookie
```
default HttpRequestMetaData addSetCookie(CharSequence name,
                                         CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a set-cookie with the specified name and value.
    This may result in multiple HttpSetCookies with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.
    
    Specified by:
    
    addSetCookie in interface HttpMetaData
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Returns:
    
    this.

Interface HttpRequestMetaData

Method Summary

Methods inherited from interface HttpMetaData

Method Detail

method

method

requestTarget

requestTarget

scheme

userInfo

host

port

rawPath

path

rawPath

path

appendPathSegments

rawQuery

rawQuery

queryParameter

queryParameters

queryParameters

queryParametersIterator

queryParametersKeys

hasQueryParameter

hasQueryParameter

queryParametersSize

addQueryParameter

addQueryParameters

addQueryParameters

setQueryParameter

setQueryParameters

setQueryParameters

removeQueryParameters

removeQueryParameters

effectiveHost

effectivePort

version

addHeader

addHeaders

setHeader

setHeaders

addCookie

addCookie

addSetCookie

addSetCookie