Package io.servicetalk.http.api

Class HttpSerializationProviders

java.lang.Object

io.servicetalk.http.api.HttpSerializationProviders

public final class HttpSerializationProviders
extends java.lang.Object

A factory to create HttpSerializationProviders.

Method Summary

Modifier and Type	Method	Description
static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedDeserializer()	Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.
static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedDeserializer(java.nio.charset.Charset charset)	Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.
static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedDeserializer(java.nio.charset.Charset charset, java.util.function.Predicate<HttpHeaders> checkContentType)	Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.
static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedSerializer()	Creates an HttpSerializer that can serialize a key-values Maps with StandardCharsets.UTF_8 Charset to urlencoded forms.
static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedSerializer(java.nio.charset.Charset charset)	Creates an HttpSerializer that can serialize key-values Maps with the specified Charset to to urlencoded forms.
static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	formUrlEncodedSerializer(java.nio.charset.Charset charset, java.util.function.Consumer<HttpHeaders> addContentType)	Creates an HttpSerializer that can serialize a key-values Maps with the specified Charset to urlencoded forms.
static HttpSerializationProvider	jsonSerializer(SerializationProvider serializationProvider)	Creates a new HttpSerializationProvider that could serialize/deserialize to/from JSON using the passed SerializationProvider.
static HttpSerializationProvider	jsonSerializer(Serializer serializer)	Creates a new HttpSerializationProvider that could serialize/deserialize to/from JSON using the passed Serializer.
static HttpSerializationProvider	serializationProvider(SerializationProvider serializationProvider, java.util.function.Consumer<HttpHeaders> addContentType, java.util.function.Predicate<HttpHeaders> checkContentType)	Creates a new HttpSerializationProvider that could serialize/deserialize to/from the desired content-type using the passed SerializationProvider.
static HttpSerializationProvider	serializationProvider(Serializer serializer, java.util.function.Consumer<HttpHeaders> addContentType, java.util.function.Predicate<HttpHeaders> checkContentType)	Creates a new HttpSerializationProvider that could serialize/deserialize to/from the desired content-type using the passed Serializer.
static HttpDeserializer<java.lang.String>	textDeserializer()	Creates an HttpDeserializer that can deserialize Strings with StandardCharsets.UTF_8 Charset.
static HttpDeserializer<java.lang.String>	textDeserializer(java.nio.charset.Charset charset)	Creates an HttpDeserializer that can deserialize Strings with the specified Charset.
static HttpDeserializer<java.lang.String>	textDeserializer(java.nio.charset.Charset charset, java.util.function.Predicate<HttpHeaders> checkContentType)	Creates an HttpDeserializer that can deserialize Strings with the specified Charset.
static HttpSerializer<java.lang.String>	textSerializer()	Creates an HttpSerializer that can serialize Strings with StandardCharsets.UTF_8 Charset.
static HttpSerializer<java.lang.String>	textSerializer(java.nio.charset.Charset charset)	Creates an HttpSerializer that can serialize Strings with the specified Charset.
static HttpSerializer<java.lang.String>	textSerializer(java.nio.charset.Charset charset, java.util.function.Consumer<HttpHeaders> addContentType)	Creates an HttpSerializer that can serialize Strings with the specified Charset.

Methods inherited from class java.lang.Object

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

Method Detail

formUrlEncodedSerializer

public static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedSerializer()

Creates an HttpSerializer that can serialize a key-values Maps with StandardCharsets.UTF_8 Charset to urlencoded forms.

Returns:

HttpSerializer that could serialize key-value Map.

See Also:

x-www-form-urlencoded specification

formUrlEncodedSerializer

public static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedSerializer(java.nio.charset.Charset charset)

Creates an HttpSerializer that can serialize key-values Maps with the specified Charset to to urlencoded forms.

Parameters:

charset - Charset for the key-value Map that will be serialized.

Returns:

HttpSerializer that could serialize from key-value Map.

See Also:

x-www-form-urlencoded specification

formUrlEncodedSerializer

public static HttpSerializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedSerializer(java.nio.charset.Charset charset,
                                                                                                                              java.util.function.Consumer<HttpHeaders> addContentType)

Creates an HttpSerializer that can serialize a key-values Maps with the specified Charset to urlencoded forms.

Parameters:

charset - Charset for the key-value Map that will be serialized.

addContentType - A Consumer that adds relevant headers to the passed HttpHeaders matching the serialized payload. Typically, this involves adding a HttpHeaderNames.CONTENT_TYPE header.

Returns:

HttpSerializer that could serialize from key-value Map.

See Also:

x-www-form-urlencoded specification

formUrlEncodedDeserializer

public static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedDeserializer()

Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.

Returns:

HttpDeserializer that could deserialize a key-values Map.

See Also:

x-www-form-urlencoded specification

formUrlEncodedDeserializer

public static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedDeserializer(java.nio.charset.Charset charset)

Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.

Parameters:

charset - Charset for the key-value Map that will be deserialized. deserialized payload. If the validation fails, then deserialization will fail with SerializationException

Returns:

HttpDeserializer that could deserialize a key-value Map.

See Also:

x-www-form-urlencoded specification

formUrlEncodedDeserializer

public static HttpDeserializer<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> formUrlEncodedDeserializer(java.nio.charset.Charset charset,
                                                                                                                                  java.util.function.Predicate<HttpHeaders> checkContentType)

Creates an HttpDeserializer that can deserialize key-values Maps with StandardCharsets.UTF_8 from urlencoded forms.

Parameters:

charset - Charset for the key-value Map that will be deserialized.

checkContentType - Checks the HttpHeaders to see if a compatible encoding is found. deserialized payload. If the validation fails, then deserialization will fail with SerializationException

Returns:

HttpDeserializer that could deserialize a key-value Map.

See Also:

x-www-form-urlencoded specification

textSerializer

public static HttpSerializer<java.lang.String> textSerializer()

Creates an HttpSerializer that can serialize Strings with StandardCharsets.UTF_8 Charset.

Returns:

HttpSerializer that could serialize String.

textSerializer

public static HttpSerializer<java.lang.String> textSerializer(java.nio.charset.Charset charset)

Creates an HttpSerializer that can serialize Strings with the specified Charset.

Parameters:

charset - Charset for the String that will be serialized.

Returns:

HttpSerializer that could serialize from String.

textSerializer

public static HttpSerializer<java.lang.String> textSerializer(java.nio.charset.Charset charset,
                                                              java.util.function.Consumer<HttpHeaders> addContentType)

Creates an HttpSerializer that can serialize Strings with the specified Charset.

Parameters:

charset - Charset for the String that will be serialized.

addContentType - A Consumer that adds relevant headers to the passed HttpHeaders matching the serialized payload. Typically, this involves adding a HttpHeaderNames.CONTENT_TYPE header.

Returns:

HttpSerializer that could serialize from String.

textDeserializer

public static HttpDeserializer<java.lang.String> textDeserializer()

Creates an HttpDeserializer that can deserialize Strings with StandardCharsets.UTF_8 Charset.

Returns:

HttpDeserializer that could deserialize String.

textDeserializer

public static HttpDeserializer<java.lang.String> textDeserializer(java.nio.charset.Charset charset)

Creates an HttpDeserializer that can deserialize Strings with the specified Charset.

Parameters:

charset - Charset for the String that will be deserialized.

Returns:

HttpDeserializer that could deserialize String.

textDeserializer

public static HttpDeserializer<java.lang.String> textDeserializer(java.nio.charset.Charset charset,
                                                                  java.util.function.Predicate<HttpHeaders> checkContentType)

Creates an HttpDeserializer that can deserialize Strings with the specified Charset.

Parameters:

charset - Charset for the String that will be deserialized.

checkContentType - A Predicate that validates the passed HttpHeaders as expected for the deserialized payload. If the validation fails, then deserialization will fail with SerializationException

Returns:

HttpDeserializer that could deserialize String.

jsonSerializer

public static HttpSerializationProvider jsonSerializer(Serializer serializer)

Creates a new HttpSerializationProvider that could serialize/deserialize to/from JSON using the passed Serializer. For serialization, the returned HttpSerializationProvider adds a HttpHeaderNames.CONTENT_TYPE header with value HttpHeaderValues.APPLICATION_JSON. For deserialization, it expects a HttpHeaderNames.CONTENT_TYPE header with value HttpHeaderValues.APPLICATION_JSON. If the expected header is not present, then deserialization will fail with SerializationException.

Parameters:

serializer - Serializer that has the capability of serializing/deserializing to/from JSON.

Returns:

HttpSerializationProvider that has the capability of serializing/deserializing to/from JSON.

jsonSerializer

public static HttpSerializationProvider jsonSerializer(SerializationProvider serializationProvider)

Creates a new HttpSerializationProvider that could serialize/deserialize to/from JSON using the passed SerializationProvider. For serialization, the returned HttpSerializationProvider adds a HttpHeaderNames.CONTENT_TYPE header with value HttpHeaderValues.APPLICATION_JSON. For deserialization, it expects a HttpHeaderNames.CONTENT_TYPE header with value HttpHeaderValues.APPLICATION_JSON. If the expected header is not present, then deserialization will fail with SerializationException.

Parameters:

serializationProvider - SerializationProvider that has the capability of serializing/deserializing to/from JSON.

Returns:

HttpSerializationProvider that has the capability of serializing/deserializing to/from JSON.

serializationProvider

public static HttpSerializationProvider serializationProvider(Serializer serializer,
                                                              java.util.function.Consumer<HttpHeaders> addContentType,
                                                              java.util.function.Predicate<HttpHeaders> checkContentType)

Creates a new HttpSerializationProvider that could serialize/deserialize to/from the desired content-type using the passed Serializer.

For serialization, the returned HttpSerializationProvider would update HttpHeaders appropriately to indicate the content-type using the passed addContentType.

For deserialization, it would validate headers as specified by the passed checkContentType predicate. If the validation fails, then deserialization will fail with SerializationException.

Parameters:

serializer - Serializer that has the capability of serializing/deserializing to/from a desired content-type.

addContentType - A Consumer that adds relevant headers to the passed HttpHeaders matching the serialized payload. Typically, this involves adding a HttpHeaderNames.CONTENT_TYPE header.

checkContentType - A Predicate that validates the passed HttpHeaders as expected for the deserialized payload. If the validation fails, then deserialization will fail with SerializationException

Returns:

HttpSerializationProvider that has the capability of serializing/deserializing to/from a desired content-type.

serializationProvider

public static HttpSerializationProvider serializationProvider(SerializationProvider serializationProvider,
                                                              java.util.function.Consumer<HttpHeaders> addContentType,
                                                              java.util.function.Predicate<HttpHeaders> checkContentType)

Creates a new HttpSerializationProvider that could serialize/deserialize to/from the desired content-type using the passed SerializationProvider.

For serialization, the returned HttpSerializationProvider would update HttpHeaders appropriately to indicate the content-type using the passed addContentType.

For deserialization, it would validate headers as specified by the passed checkContentType predicate. If the validation fails, then deserialization will fail with SerializationException.

Parameters:

serializationProvider - SerializationProvider that has the capability of serializing/deserializing to/from a desired content-type.

addContentType - A Consumer that adds relevant headers to the passed HttpHeaders matching the serialized payload. Typically, this involves adding a HttpHeaderNames.CONTENT_TYPE header.

checkContentType - A Predicate that validates the passed HttpHeaders as expected for the deserialized payload. If the validation fails, then deserialization will fail with SerializationException.

Returns:

HttpSerializationProvider that has the capability of serializing/deserializing to/from a desired content-type.