org.springframework.http.codec

Class ServerSentEventHttpMessageWriter

java.lang.Object

org.springframework.http.codec.ServerSentEventHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<Object>

public class ServerSentEventHttpMessageWriter
extends Object
implements HttpMessageWriter<Object>

Writer 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, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
static String	SSE_CONTENT_HINT Server-Sent Events hint key expecting a Boolean value which when set to true will adapt the content in order to comply with Server-Sent Events recommendation.

Constructor Summary

Constructors

Constructor and Description
ServerSentEventHttpMessageWriter()
ServerSentEventHttpMessageWriter(List<org.springframework.core.codec.Encoder<?>> dataEncoders)

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(org.springframework.core.ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be written by this converter.
List<MediaType>	getWritableMediaTypes() Return the list of MediaType objects that can be written by this converter.
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<?> inputStream, org.springframework.core.ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String,Object> hints) Write an given object to the given output message.

Methods inherited from class java.lang.Object

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

Field Detail

SSE_CONTENT_HINT

public static final String SSE_CONTENT_HINT

Server-Sent Events hint key expecting a Boolean value which when set to true will adapt the content in order to comply with Server-Sent Events recommendation. For example, it will append "data:" after each line break with data encoders supporting it.

See Also:

Server-Sent Events W3C recommendation

Constructor Detail

ServerSentEventHttpMessageWriter

public ServerSentEventHttpMessageWriter()

ServerSentEventHttpMessageWriter

public ServerSentEventHttpMessageWriter(List<org.springframework.core.codec.Encoder<?>> dataEncoders)

Method Detail

canWrite

public boolean canWrite(org.springframework.core.ResolvableType elementType,
                        MediaType mediaType)

Description copied from interface: HttpMessageWriter

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

Specified by:

canWrite in interface HttpMessageWriter<Object>

Parameters:

elementType - the stream element type 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

getWritableMediaTypes

public List<MediaType> getWritableMediaTypes()

Description copied from interface: HttpMessageWriter

Return the list of MediaType objects that can be written by this converter.

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<Object>

Returns:

the list of supported readable media types

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<?> inputStream,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ReactiveHttpOutputMessage outputMessage,
                                               Map<String,Object> hints)

Description copied from interface: HttpMessageWriter

Write an given object to the given output message.

Specified by:

write in interface HttpMessageWriter<Object>

Parameters:

inputStream - the input stream to write

elementType - the stream element type to process. This type must have previously been passed to the HttpMessageWriter.canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) canWrite} method of this interface, which must have returned true.

mediaType - the content type to use when writing, typically the value of an Accept header. May be null to indicate that the default content type of the converter must be used.

outputMessage - the message to write to

hints - additional information about how to write

Returns:

a Mono that indicates completion or error