Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ServerSentEventHttpMessageReader.LimitTracker

Field Summary

Modifier and Type	Field and Description
private final Decoder<?>	decoder
private final StringDecoder	lineDecoder
private static final ResolvableType	STRING_TYPE

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private Object	buildEvent(List<String> lines, ResolvableType valueType, boolean shouldWrap, Map<String, Object> hints)
public boolean	canRead(ResolvableType the type of object to check elementType, MediaType the media type for the read (possibly `null`) mediaType) Implements org.springframework.http.codec.HttpMessageReader.canRead. Whether the given object type is supported by this reader.
private Object	decodeData(StringBuilder data, ResolvableType dataType, Map<String, Object> hints)
public Decoder<?>	getDecoder() Return the configured `Decoder`.
public int	getMaxInMemorySize() Return the `configured` byte count limit.
public List<MediaType>	getReadableMediaTypes() Implements org.springframework.http.codec.HttpMessageReader.getReadableMediaTypes. Return the list of media types supported by this reader.
private boolean	isServerSentEvent(ResolvableType elementType)
public Flux<Object>	read(ResolvableType the type of objects in the stream which must have been previously checked via `canRead(ResolvableType, MediaType)` elementType, ReactiveHttpInputMessage the message to read from message, Map<String, Object> additional information about how to read and decode the input hints) Implements org.springframework.http.codec.HttpMessageReader.read. Read from the input message and decode to a stream of objects.
public Mono<Object>	readMono(ResolvableType the type of objects in the stream which must have been previously checked via `canRead(ResolvableType, MediaType)` elementType, ReactiveHttpInputMessage the message to read from message, Map<String, Object> additional information about how to read and decode the input hints) Implements org.springframework.http.codec.HttpMessageReader.readMono. Read from the input message and decode to a single object.
public void	setMaxInMemorySize(int the max number of bytes to buffer, or -1 for unlimited byteCount) Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

decoder	back to summary
private final Decoder<?> decoder Annotations @Nullable

lineDecoder	back to summary
private final StringDecoder lineDecoder

STRING_TYPE	back to summary
private static final ResolvableType STRING_TYPE

Constructor Detail

ServerSentEventHttpMessageReader	back to summary
public ServerSentEventHttpMessageReader() Constructor without a `Decoder`. In this mode only `String` is supported as the data of an event.

ServerSentEventHttpMessageReader	back to summary
public ServerSentEventHttpMessageReader(Decoder<?> decoder) Constructor with JSON `Decoder` for decoding to Objects. Support for decoding to `String` event data is built-in.

Method Detail

buildEvent	back to summary
private Object buildEvent(List<String> lines, ResolvableType valueType, boolean shouldWrap, Map<String, Object> hints) Annotations @Nullable

canRead back to summary

canRead	back to summary
public boolean canRead(ResolvableType elementType, MediaType mediaType) Implements org.springframework.http.codec.HttpMessageReader.canRead. Doc from org.springframework.http.codec.HttpMessageReader.canRead. Whether the given object type is supported by this reader. Parameters elementType:ResolvableType the type of object to check mediaType:MediaType the media type for the read (possibly `null`) Returns:boolean `true` if readable, `false` otherwise Annotations @Override

public boolean canRead(ResolvableType elementType, MediaType mediaType)

Implements org.springframework.http.codec.HttpMessageReader.canRead.

Doc from org.springframework.http.codec.HttpMessageReader.canRead.

Whether the given object type is supported by this reader.

Parameters

elementType:ResolvableType: the type of object to check
mediaType:MediaType: the media type for the read (possibly null)

Returns:boolean

true if readable, false otherwise

Annotations

@Override

decodeData	back to summary
private Object decodeData(StringBuilder data, ResolvableType dataType, Map<String, Object> hints) Annotations @Nullable

getDecoder back to summary

getDecoder	back to summary
public Decoder<?> getDecoder() Return the configured `Decoder`. Annotations @Nullable

public Decoder<?> getDecoder()

Return the configured Decoder.

Annotations

@Nullable

getMaxInMemorySize back to summary

getMaxInMemorySize	back to summary
public int getMaxInMemorySize() Return the `configured` byte count limit. Since 5.1.13

public int getMaxInMemorySize()

Return the configured byte count limit.

Since: 5.1.13

getReadableMediaTypes back to summary

getReadableMediaTypes	back to summary
public List<MediaType> getReadableMediaTypes() Implements org.springframework.http.codec.HttpMessageReader.getReadableMediaTypes. Doc from org.springframework.http.codec.HttpMessageReader.getReadableMediaTypes. Return the list of media types supported by this reader. The list may not apply to every possible target element type and calls to this method should typically be guarded via `canWrite(elementType, null)`. The list may also exclude media types supported only for a specific element type. Alternatively, use `getReadableMediaTypes(ResolvableType)` for a more precise list. Returns:List<MediaType> the general list of supported media types Annotations @Override

public List<MediaType> getReadableMediaTypes()

Implements org.springframework.http.codec.HttpMessageReader.getReadableMediaTypes.

Doc from org.springframework.http.codec.HttpMessageReader.getReadableMediaTypes.

Return the list of media types supported by this reader. The list may not apply to every possible target element type and calls to this method should typically be guarded via canWrite(elementType, null). The list may also exclude media types supported only for a specific element type. Alternatively, use getReadableMediaTypes(ResolvableType) for a more precise list.

Returns:List<MediaType>

the general list of supported media types

Annotations

@Override

isServerSentEvent	back to summary
private boolean isServerSentEvent(ResolvableType elementType)

read back to summary

read	back to summary
public Flux<Object> read(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String, Object> hints) Implements org.springframework.http.codec.HttpMessageReader.read. Doc from org.springframework.http.codec.HttpMessageReader.read. Read from the input message and decode to a stream of objects. Parameters elementType:ResolvableType the type of objects in the stream which must have been previously checked via `canRead(ResolvableType, MediaType)` message:ReactiveHttpInputMessage the message to read from hints:Map<String, Object> additional information about how to read and decode the input Returns:Flux<Object> the decoded stream of elements Annotations @Override

public Flux<Object> read(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String, Object> hints)

Implements org.springframework.http.codec.HttpMessageReader.read.

Doc from org.springframework.http.codec.HttpMessageReader.read.

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

Parameters

elementType:ResolvableType: the type of objects in the stream which must have been previously checked via canRead(ResolvableType, MediaType)
message:ReactiveHttpInputMessage: the message to read from
hints:Map<String, Object>: additional information about how to read and decode the input

Returns:Flux<Object>

the decoded stream of elements

Annotations

@Override

readMono back to summary

readMono	back to summary
public Mono<Object> readMono(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String, Object> hints) Implements org.springframework.http.codec.HttpMessageReader.readMono. Doc from org.springframework.http.codec.HttpMessageReader.readMono. Read from the input message and decode to a single object. Parameters elementType:ResolvableType the type of objects in the stream which must have been previously checked via `canRead(ResolvableType, MediaType)` message:ReactiveHttpInputMessage the message to read from hints:Map<String, Object> additional information about how to read and decode the input Returns:Mono<Object> the decoded object Annotations @Override

public Mono<Object> readMono(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String, Object> hints)

Implements org.springframework.http.codec.HttpMessageReader.readMono.

Doc from org.springframework.http.codec.HttpMessageReader.readMono.

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

Parameters

elementType:ResolvableType: the type of objects in the stream which must have been previously checked via canRead(ResolvableType, MediaType)
message:ReactiveHttpInputMessage: the message to read from
hints:Map<String, Object>: additional information about how to read and decode the input

Returns:Mono<Object>

the decoded object

Annotations

@Override

setMaxInMemorySize back to summary

setMaxInMemorySize	back to summary
public void setMaxInMemorySize(int byteCount) Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed. Note that the `data decoder`, if provided, must also be customized accordingly to raise the limit if necessary in order to be able to parse the data portion of the event. By default this is set to 256K. Parameters byteCount:int the max number of bytes to buffer, or -1 for unlimited Since 5.1.13

public void setMaxInMemorySize(int byteCount)

Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed.

Note that the data decoder, if provided, must also be customized accordingly to raise the limit if necessary in order to be able to parse the data portion of the event.

By default this is set to 256K.

Parameters

byteCount:int: the max number of bytes to buffer, or -1 for unlimited

Since

5.1.13

org.springframework.http.codec back to summary

private Class ServerSentEventHttpMessageReader.LimitTracker

Class Inheritance

extends Object

java.lang.Object
org.springframework.http.codec.ServerSentEventHttpMessageReader.LimitTracker

Field Summary

Modifier and Type	Field and Description
private int	accumulated

Constructor Summary

Access	Constructor and Description
private	LimitTracker()

Method Summary

Modifier and Type	Method and Description
public void	afterLineParsed(String line)
private void	raiseLimitException()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

accumulated	back to summary
private int accumulated

Constructor Detail

LimitTracker	back to summary
private LimitTracker()

Method Detail

afterLineParsed	back to summary
public void afterLineParsed(String line)

raiseLimitException	back to summary
private void raiseLimitException()

public Class ServerSentEventHttpMessageReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ServerSentEventHttpMessageReader.LimitTracker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail