ServerSentEventHttpMessageWriter (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.http.codec.ServerSentEventHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<java.lang.Object>
```
public class ServerSentEventHttpMessageWriter
extends java.lang.Object
implements HttpMessageWriter<java.lang.Object>
```
HttpMessageWriter for "text/event-stream" responses.

Since:

5.0

Author:

Sebastien Deleuze, Arjen Poutsma, Rossen Stoyanchev

Constructor Summary

Constructors
Constructor and Description
`ServerSentEventHttpMessageWriter()` Constructor without an `Encoder`.
`ServerSentEventHttpMessageWriter(Encoder<?> encoder)` Constructor with JSON `Encoder` for encoding objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canWrite(ResolvableType elementType, MediaType mediaType)` Whether the given object type is supported by this writer.
`Encoder<?>`	`getEncoder()` Return the configured `Encoder`, if any.
`java.util.List<MediaType>`	`getWritableMediaTypes()` Return the `MediaType`'s that this writer supports.
`reactor.core.publisher.Mono<java.lang.Void>`	`write(org.reactivestreams.Publisher<?> input, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints)` Write an given stream of object to the output message.
`reactor.core.publisher.Mono<java.lang.Void>`	`write(org.reactivestreams.Publisher<?> input, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, java.util.Map<java.lang.String,java.lang.Object> hints)` Server-side only alternative to `HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)` with additional context available.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ServerSentEventHttpMessageWriter
```
public ServerSentEventHttpMessageWriter()
```
  Constructor without an Encoder. In this mode only String is supported for event data to be encoded.
- ServerSentEventHttpMessageWriter
```
public ServerSentEventHttpMessageWriter(@Nullable
                                        Encoder<?> encoder)
```
  Constructor with JSON Encoder for encoding objects. Support for String event data is built-in.
  
  Parameters:
  
  encoder - the Encoder to use (may be null)

Method Detail

getEncoder
```
@Nullable
public Encoder<?> getEncoder()
```
Return the configured Encoder, if any.

getWritableMediaTypes
```
public java.util.List<MediaType> getWritableMediaTypes()
```
Description copied from interface: HttpMessageWriter

Return the MediaType's that this writer supports.

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<java.lang.Object>

canWrite
```
public boolean canWrite(ResolvableType elementType,
                        @Nullable
                        MediaType mediaType)
```
Description copied from interface: HttpMessageWriter

Whether the given object type is supported by this writer.

Specified by:

canWrite in interface HttpMessageWriter<java.lang.Object>

Parameters:

elementType - the type of object to check

mediaType - the media type for the write, possibly null

Returns:

true if writable, false otherwise

write

public reactor.core.publisher.Mono<java.lang.Void> write(org.reactivestreams.Publisher<?> input,
                                                         ResolvableType elementType,
                                                         @Nullable
                                                         MediaType mediaType,
                                                         ReactiveHttpOutputMessage message,
                                                         java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageWriter

Write an given stream of object to the output message.

Specified by:: write in interface HttpMessageWriter<java.lang.Object>
Parameters:: input - the objects to write; elementType - the type of objects in the stream which must have been previously checked via HttpMessageWriter.canWrite(ResolvableType, MediaType); mediaType - the content type for the write, possibly null to indicate that the default content type of the writer must be used.; message - the message to write to; hints - additional information about how to encode and write
Returns:: indicates completion or error

write

public reactor.core.publisher.Mono<java.lang.Void> write(org.reactivestreams.Publisher<?> input,
                                                         ResolvableType actualType,
                                                         ResolvableType elementType,
                                                         @Nullable
                                                         MediaType mediaType,
                                                         ServerHttpRequest request,
                                                         ServerHttpResponse response,
                                                         java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageWriter

Server-side only alternative to HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map) with additional context available.

Specified by:: write in interface HttpMessageWriter<java.lang.Object>; actualType - the actual return type of the method that returned the value; for annotated controllers, the MethodParameter can be accessed via ResolvableType.getSource().; elementType - the type of Objects in the input stream; mediaType - the content type to use, possibly null indicating the default content type of the writer should be used.; request - the current request; response - the current response
Returns:: a Mono that indicates completion of writing or error

Class ServerSentEventHttpMessageWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerSentEventHttpMessageWriter

ServerSentEventHttpMessageWriter

Method Detail

getEncoder

getWritableMediaTypes

canWrite

write

write