org.springframework.web.servlet.mvc.method.annotation

Class SseEmitter

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter

org.springframework.web.servlet.mvc.method.annotation.SseEmitter

public class SseEmitter
extends ResponseBodyEmitter

A specialization of ResponseBodyEmitter for sending Server-Sent Events.

Since:

4.2

Author:

Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SseEmitter.SseEventBuilder A builder for an SSE event.
private static class	SseEmitter.SseEventBuilderImpl Default implementation of SseEventBuilder.

Nested classes/interfaces inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter

ResponseBodyEmitter.DataWithMediaType, ResponseBodyEmitter.Handler

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static MediaType	TEXT_PLAIN

Constructor Summary

Constructors

Constructor and Description
SseEmitter()

Method Summary

Modifier and Type	Method and Description
static SseEmitter.SseEventBuilder	event()
protected void	extendResponse(ServerHttpResponse outputMessage) Invoked after the response is updated with the status code and headers, if the ResponseBodyEmitter is wrapped in a ResponseEntity, but before the response is committed, i.e.
void	send(java.lang.Object object) Send the object formatted as a single SSE "data" line.
void	send(java.lang.Object object, MediaType mediaType) Send the object formatted as a single SSE "data" line.
void	send(SseEmitter.SseEventBuilder builder) Send an SSE event prepared with the given builder.

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter

complete, completeWithError, getTimeout, initialize, onCompletion, onTimeout

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_PLAIN

static final MediaType TEXT_PLAIN

Constructor Detail

SseEmitter

public SseEmitter()

Method Detail

extendResponse

protected void extendResponse(ServerHttpResponse outputMessage)

Description copied from class: ResponseBodyEmitter

Invoked after the response is updated with the status code and headers, if the ResponseBodyEmitter is wrapped in a ResponseEntity, but before the response is committed, i.e. before the response body has been written to.

The default implementation is empty.

Overrides:

extendResponse in class ResponseBodyEmitter

send

public void send(java.lang.Object object)
          throws java.io.IOException

Send the object formatted as a single SSE "data" line. It's equivalent to:

 // static import of SseEmitter.*

 SseEmitter emitter = new SseEmitter();
 emitter.send(event().data(myObject));
 

Overrides:

send in class ResponseBodyEmitter

Parameters:

object - the object to write

Throws:

java.io.IOException - raised when an I/O error occurs

java.lang.IllegalStateException - wraps any other errors

send

public void send(java.lang.Object object,
                 MediaType mediaType)
          throws java.io.IOException

Send the object formatted as a single SSE "data" line. It's equivalent to:

 // static import of SseEmitter.*

 SseEmitter emitter = new SseEmitter();
 emitter.send(event().data(myObject, MediaType.APPLICATION_JSON));
 

Overrides:

send in class ResponseBodyEmitter

Parameters:

object - the object to write

mediaType - a MediaType hint for selecting an HttpMessageConverter

Throws:

java.io.IOException - raised when an I/O error occurs

send

public void send(SseEmitter.SseEventBuilder builder)
          throws java.io.IOException

Send an SSE event prepared with the given builder. For example:

 // static import of SseEmitter

 SseEmitter emitter = new SseEmitter();
 emitter.send(event().name("update").id("1").data(myObject));
 

Parameters:

builder - a builder for an SSE formatted event.

Throws:

java.io.IOException - raised when an I/O error occurs

event

public static SseEmitter.SseEventBuilder event()