software.amazon.awssdk.utils.http

Class SdkHttpUtils

java.lang.Object

software.amazon.awssdk.utils.http.SdkHttpUtils

public final class SdkHttpUtils
extends java.lang.Object

A set of utilities that assist with HTTP message-related interactions.

Method Summary

Modifier and Type	Method and Description
static java.util.stream.Stream<java.lang.String>	allMatchingHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers, java.lang.String header) Perform a case-insensitive search for a particular header in the provided map of headers.
static java.lang.String	appendUri(java.lang.String baseUri, java.lang.String path) Append the given path to the given baseUri, separating them with a slash, if required.
static java.util.Optional<java.lang.String>	encodeAndFlattenFormData(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawFormData) Encode the provided form data using encodeFormData(Map) and then flatten them into a string that can be used as the body of a form data request.
static java.util.Optional<java.lang.String>	encodeAndFlattenQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawQueryParameters) Encode the provided query parameters using encodeQueryParameters(Map) and then flatten them into a string that can be used as the query string in a URL.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	encodeFormData(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawFormData) Encode each of the keys and values in the provided form data using formDataEncode(String).
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	encodeQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawQueryParameters) Encode each of the keys and values in the provided query parameters using urlEncode(String).
static java.util.Optional<java.lang.String>	firstMatchingHeader(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers, java.lang.String header) Perform a case-insensitive search for a particular header in the provided map of headers, returning the first matching header, if one is found.
static java.util.Optional<java.lang.String>	flattenQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> toFlatten) Flatten the provided query parameters into a string that can be used as the query string in a URL.
static java.lang.String	formDataEncode(java.lang.String value) Encode a string according to RFC 1630: encoding for form data.
static boolean	isSingleHeader(java.lang.String h)
static boolean	isUsingStandardPort(java.lang.String protocol, java.lang.Integer port) Returns true if the specified port is the standard port for the given protocol.
static int	standardPort(java.lang.String protocol) Retrieve the standard port for the provided protocol.
static java.lang.String	urlDecode(java.lang.String value) Decode the string according to RFC 3986: encoding for URI paths, query strings, etc.
static java.lang.String	urlEncode(java.lang.String value) Encode a string according to RFC 3986: encoding for URI paths, query strings, etc.
static java.lang.String	urlEncodeIgnoreSlashes(java.lang.String value) Encode a string according to RFC 3986, but ignore "/" characters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

urlEncode

public static java.lang.String urlEncode(java.lang.String value)

Encode a string according to RFC 3986: encoding for URI paths, query strings, etc.

urlEncodeIgnoreSlashes

public static java.lang.String urlEncodeIgnoreSlashes(java.lang.String value)

Encode a string according to RFC 3986, but ignore "/" characters. This is useful for encoding the components of a path, without encoding the path separators.

formDataEncode

public static java.lang.String formDataEncode(java.lang.String value)

Encode a string according to RFC 1630: encoding for form data.

urlDecode

public static java.lang.String urlDecode(java.lang.String value)

Decode the string according to RFC 3986: encoding for URI paths, query strings, etc.

Assumes the decoded string is UTF-8 encoded.

Parameters:

value - The string to decode.

Returns:

The decoded string.

encodeQueryParameters

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> encodeQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawQueryParameters)

Encode each of the keys and values in the provided query parameters using urlEncode(String).

encodeFormData

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> encodeFormData(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawFormData)

Encode each of the keys and values in the provided form data using formDataEncode(String).

encodeAndFlattenQueryParameters

public static java.util.Optional<java.lang.String> encodeAndFlattenQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawQueryParameters)

Encode the provided query parameters using encodeQueryParameters(Map) and then flatten them into a string that can be used as the query string in a URL. The result is not prepended with "?".

encodeAndFlattenFormData

public static java.util.Optional<java.lang.String> encodeAndFlattenFormData(java.util.Map<java.lang.String,java.util.List<java.lang.String>> rawFormData)

Encode the provided form data using encodeFormData(Map) and then flatten them into a string that can be used as the body of a form data request.

flattenQueryParameters

public static java.util.Optional<java.lang.String> flattenQueryParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> toFlatten)

Flatten the provided query parameters into a string that can be used as the query string in a URL. The result is not prepended with "?". This is useful when you have already-encoded query parameters you wish to flatten.

isUsingStandardPort

public static boolean isUsingStandardPort(java.lang.String protocol,
                                          java.lang.Integer port)

Returns true if the specified port is the standard port for the given protocol. (i.e. 80 for HTTP or 443 for HTTPS). Null or -1 ports (to simplify interaction with URI's default value) are treated as standard ports.

Returns:

True if the specified port is standard for the specified protocol, otherwise false.

standardPort

public static int standardPort(java.lang.String protocol)

Retrieve the standard port for the provided protocol.

appendUri

public static java.lang.String appendUri(java.lang.String baseUri,
                                         java.lang.String path)

Append the given path to the given baseUri, separating them with a slash, if required. The result will preserve the trailing slash of the provided path.

allMatchingHeaders

public static java.util.stream.Stream<java.lang.String> allMatchingHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers,
                                                                           java.lang.String header)

Perform a case-insensitive search for a particular header in the provided map of headers.

Parameters:

headers - The headers to search.

header - The header to search for (case insensitively).

Returns:

A stream providing the values for the headers that matched the requested header.

firstMatchingHeader

public static java.util.Optional<java.lang.String> firstMatchingHeader(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers,
                                                                       java.lang.String header)

Perform a case-insensitive search for a particular header in the provided map of headers, returning the first matching header, if one is found.
This is useful for headers like 'Content-Type' or 'Content-Length' of which there is expected to be only one value present.

Parameters:

headers - The headers to search.

header - The header to search for (case insensitively).

Returns:

The first header that matched the requested one, or empty if one was not found.

isSingleHeader

public static boolean isSingleHeader(java.lang.String h)