org.springframework.http.codec

Class ServerSentEventHttpMessageReader

java.lang.Object

org.springframework.http.codec.ServerSentEventHttpMessageReader

All Implemented Interfaces:

HttpMessageReader<java.lang.Object>

public class ServerSentEventHttpMessageReader
extends java.lang.Object
implements HttpMessageReader<java.lang.Object>

Reader that supports a stream of ServerSentEvents and also plain Objects which is the same as an ServerSentEvent with data only.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private static DataBufferFactory	bufferFactory
private Decoder<?>	decoder
private static ResolvableType	STRING_TYPE
private static StringDecoder	stringDecoder

Constructor Summary

Constructors

Constructor and Description
ServerSentEventHttpMessageReader() Constructor without a Decoder.
ServerSentEventHttpMessageReader(Decoder<?> decoder) Constructor with JSON Decoder for decoding to Objects.

Method Summary

Modifier and Type	Method and Description
private <any>	buildEvent(java.util.List<java.lang.String> lines, ResolvableType valueType, boolean shouldWrap, java.util.Map<java.lang.String,java.lang.Object> hints)
boolean	canRead(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.
private <any>	decodeData(java.lang.String data, ResolvableType dataType, java.util.Map<java.lang.String,java.lang.Object> hints)
Decoder<?>	getDecoder() Return the configured Decoder.
java.util.List<MediaType>	getReadableMediaTypes() Return the MediaType's that this reader supports.
private boolean	isServerSentEvent(ResolvableType elementType)
<any>	read(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a stream of objects.
<any>	readMono(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a single object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.codec.HttpMessageReader

read, readMono

Field Detail

bufferFactory

private static final DataBufferFactory bufferFactory

stringDecoder

private static final StringDecoder stringDecoder

STRING_TYPE

private static final ResolvableType STRING_TYPE

decoder

@Nullable
private final Decoder<?> decoder

Constructor Detail

ServerSentEventHttpMessageReader

public ServerSentEventHttpMessageReader()

Constructor without a Decoder. In this mode only String is supported as the data of an event.

ServerSentEventHttpMessageReader

public ServerSentEventHttpMessageReader(@Nullable
                                        Decoder<?> decoder)

Constructor with JSON Decoder for decoding to Objects. Support for decoding to String event data is built-in.

Method Detail

getDecoder

@Nullable
public Decoder<?> getDecoder()

Return the configured Decoder.

getReadableMediaTypes

public java.util.List<MediaType> getReadableMediaTypes()

Description copied from interface: HttpMessageReader

Return the MediaType's that this reader supports.

Specified by:

getReadableMediaTypes in interface HttpMessageReader<java.lang.Object>

canRead

public boolean canRead(ResolvableType elementType,
                       @Nullable
                       MediaType mediaType)

Description copied from interface: HttpMessageReader

Whether the given object type is supported by this reader.

Specified by:

canRead in interface HttpMessageReader<java.lang.Object>

Parameters:

elementType - the type of object to check

mediaType - the media type for the read (possibly null)

Returns:

true if readable, false otherwise

isServerSentEvent

private boolean isServerSentEvent(ResolvableType elementType)

read

public <any> read(ResolvableType elementType,
                  ReactiveHttpInputMessage message,
                  java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a stream of objects.

Specified by:

read in interface HttpMessageReader<java.lang.Object>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded stream of elements

buildEvent

private <any> buildEvent(java.util.List<java.lang.String> lines,
                         ResolvableType valueType,
                         boolean shouldWrap,
                         java.util.Map<java.lang.String,java.lang.Object> hints)

decodeData

private <any> decodeData(java.lang.String data,
                         ResolvableType dataType,
                         java.util.Map<java.lang.String,java.lang.Object> hints)

readMono

public <any> readMono(ResolvableType elementType,
                      ReactiveHttpInputMessage message,
                      java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a single object.

Specified by:

readMono in interface HttpMessageReader<java.lang.Object>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded object