Class AbstractKotlinSerializationHttpMessageConverter<T extends kotlinx.serialization.SerialFormat>

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<Object>

org.springframework.http.converter.AbstractSmartHttpMessageConverter<Object>

org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter<T>

Type Parameters:

T - the type of SerialFormat

All Implemented Interfaces:

HttpMessageConverter<Object>, SmartHttpMessageConverter<Object>

Direct Known Subclasses:

KotlinSerializationBinaryHttpMessageConverter, KotlinSerializationStringHttpMessageConverter

public abstract class AbstractKotlinSerializationHttpMessageConverter<T extends kotlinx.serialization.SerialFormat>
extends AbstractSmartHttpMessageConverter<Object>

Abstract base class for HttpMessageConverter implementations that use Kotlin serialization.

As of Spring Framework 7.0, by default it only encodes types annotated with @Serializable at type or generics level since it allows combined usage with other general purpose converters without conflicts. Alternative constructors with a Predicate<ResolvableType> parameter can be used to customize this behavior.

Since:

6.0

Author:

Andreas Ahlenstorf, Sebastien Deleuze, Juergen Hoeller, Iain Henderson, Arjen Poutsma

Field Summary

Fields inherited from class AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractKotlinSerializationHttpMessageConverter(T format, Predicate<org.springframework.core.ResolvableType> typePredicate, MediaType... supportedMediaTypes)	Creates a new instance with the given format and supported mime types which only converts types for which the specified predicate returns true.
protected	AbstractKotlinSerializationHttpMessageConverter(T format, MediaType... supportedMediaTypes)	Creates a new instance with the given format and supported mime types which only converters types annotated with @Serializable at type or generics level.

Method Summary

Modifier and Type	Method	Description
boolean	canRead(org.springframework.core.ResolvableType type, @Nullable MediaType mediaType)	Indicates whether the given type can be read by this converter.
boolean	canWrite(org.springframework.core.ResolvableType type, Class<?> valueClass, @Nullable MediaType mediaType)	Indicates whether the given class can be written by this converter.
List<MediaType>	getSupportedMediaTypes(Class<?> clazz)	Return the list of media types supported by this converter for the given class.
final Object	read(org.springframework.core.ResolvableType type, HttpInputMessage inputMessage, @Nullable Map<String,Object> hints)	Read an object of the given type from the given input message, and returns it.
protected abstract Object	readInternal(kotlinx.serialization.KSerializer<Object> serializer, T format, HttpInputMessage inputMessage)	Reads the given input message with the given serializer and format.
protected boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
protected boolean	supportsRepeatableWrites(Object object)	Indicates whether this message converter can write the given object multiple times.
protected abstract void	writeInternal(Object object, kotlinx.serialization.KSerializer<Object> serializer, T format, HttpOutputMessage outputMessage)	Write the given object to the output message with the given serializer and format.
protected final void	writeInternal(Object object, org.springframework.core.ResolvableType type, HttpOutputMessage outputMessage, @Nullable Map<String,Object> hints)	Abstract template method that writes the actual body.

Methods inherited from class AbstractSmartHttpMessageConverter

canRead, canWrite, readInternal, write, writeInternal

Methods inherited from class AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

Methods inherited from class Object

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

Methods inherited from interface HttpMessageConverter

getSupportedMediaTypes

Methods inherited from interface SmartHttpMessageConverter

read, write

Constructor Details

AbstractKotlinSerializationHttpMessageConverter

protected AbstractKotlinSerializationHttpMessageConverter(T format,
 MediaType... supportedMediaTypes)

Creates a new instance with the given format and supported mime types which only converters types annotated with @Serializable at type or generics level.

AbstractKotlinSerializationHttpMessageConverter

protected AbstractKotlinSerializationHttpMessageConverter(T format,
 Predicate<org.springframework.core.ResolvableType> typePredicate,
 MediaType... supportedMediaTypes)

Creates a new instance with the given format and supported mime types which only converts types for which the specified predicate returns true.

Since:

7.0

Method Details

getSupportedMediaTypes

public List<MediaType> getSupportedMediaTypes(Class<?> clazz)

Description copied from interface: HttpMessageConverter

Return the list of media types supported by this converter for the given class. The list may differ from HttpMessageConverter.getSupportedMediaTypes() if the converter does not support the given Class or if it supports it only for a subset of media types.

Parameters:

clazz - the type of class to check

Returns:

the list of media types supported for the given class

supports

protected boolean supports(Class<?> clazz)

Description copied from class: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

Overrides:

supports in class AbstractSmartHttpMessageConverter<Object>

Parameters:

clazz - the class to test for support

Returns:

true if supported; false otherwise

canRead

public boolean canRead(org.springframework.core.ResolvableType type,
 @Nullable MediaType mediaType)

Description copied from interface: SmartHttpMessageConverter

Indicates whether the given type can be read by this converter. This method should perform the same checks as HttpMessageConverter.canRead(Class, MediaType) with additional ones related to the generic type.

Parameters:

type - the (potentially generic) type to test for readability. The type source may be used for retrieving additional information (the related method signature for example) when relevant.

mediaType - the media type to read, can be null if not specified. Typically, the value of a Content-Type header.

Returns:

true if readable; false otherwise

canWrite

public boolean canWrite(org.springframework.core.ResolvableType type,
 Class<?> valueClass,
 @Nullable MediaType mediaType)

Description copied from interface: SmartHttpMessageConverter

Indicates whether the given class can be written by this converter.

This method should perform the same checks as HttpMessageConverter.canWrite(Class, MediaType) with additional ones related to the generic type.

Parameters:

type - the (potentially generic) target type to test for writability (can be ResolvableType.NONE if not specified). The type source may be used for retrieving additional information (the related method signature for example) when relevant.

valueClass - the source object class to test for writability

mediaType - the media type to write (can be null if not specified); typically the value of an Accept header.

Returns:

true if writable; false otherwise

read

public final Object read(org.springframework.core.ResolvableType type,
 HttpInputMessage inputMessage,
 @Nullable Map<String,Object> hints)
                  throws IOException,
HttpMessageNotReadableException

Description copied from interface: SmartHttpMessageConverter

Read an object of the given type from the given input message, and returns it.

Parameters:

type - the (potentially generic) type of object to return. This type must have previously been passed to the canRead method of this interface, which must have returned true. The type source may be used for retrieving additional information (the related method signature for example) when relevant.

inputMessage - the HTTP input message to read from

hints - additional information about how to encode

Returns:

the converted object

Throws:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

readInternal

protected abstract Object readInternal(kotlinx.serialization.KSerializer<Object> serializer,
 T format,
 HttpInputMessage inputMessage)
                                throws IOException,
HttpMessageNotReadableException

Reads the given input message with the given serializer and format.

Throws:

IOException

HttpMessageNotReadableException

writeInternal

protected final void writeInternal(Object object,
 org.springframework.core.ResolvableType type,
 HttpOutputMessage outputMessage,
 @Nullable Map<String,Object> hints)
                            throws IOException,
HttpMessageNotWritableException

Description copied from class: AbstractSmartHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractSmartHttpMessageConverter.write(Object, ResolvableType, MediaType, HttpOutputMessage, Map).

Specified by:

writeInternal in class AbstractSmartHttpMessageConverter<Object>

Parameters:

object - the object to write to the output message

type - the type of object to write

outputMessage - the HTTP output message to write to

hints - additional information about how to encode

Throws:

IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

writeInternal

protected abstract void writeInternal(Object object,
 kotlinx.serialization.KSerializer<Object> serializer,
 T format,
 HttpOutputMessage outputMessage)
                               throws IOException,
HttpMessageNotWritableException

Write the given object to the output message with the given serializer and format.

Throws:

IOException

HttpMessageNotWritableException

supportsRepeatableWrites

protected boolean supportsRepeatableWrites(Object object)

Description copied from class: AbstractHttpMessageConverter

Indicates whether this message converter can write the given object multiple times.

The default implementation returns false.

Overrides:

supportsRepeatableWrites in class AbstractHttpMessageConverter<Object>

Parameters:

object - the object t

Returns:

true if t can be written repeatedly; false otherwise