Module jakarta.ws.rs

Package jakarta.ws.rs.sse

Interface Sse

public interface Sse

Server-side entry point for creating OutboundSseEvent and SseBroadcaster.

Instance of this interface can be injected into a field or as a parameter of a method or a constructor. Also, the instance is thread safe, meaning that it can be shared and its method invoked from different threads without causing inconsistent internal state.

Since:

2.1

Author:

Marek Potociar (marek.potociar at oracle.com)

Method Summary

Modifier and Type	Method	Description
SseBroadcaster	newBroadcaster()	Get a new Server-sent event broadcaster.
default OutboundSseEvent	newEvent(String data)	Create new OutboundSseEvent from provided data.
default OutboundSseEvent	newEvent(String name, String data)	Create new OutboundSseEvent from provided data and name.
OutboundSseEvent.Builder	newEventBuilder()	Get a new outbound event builder.

Method Details

newEventBuilder

OutboundSseEvent.Builder newEventBuilder()

Get a new outbound event builder.

Returns:

SSE outbound event builder.

newEvent

default OutboundSseEvent newEvent(String data)

Create new OutboundSseEvent from provided data.

The data can be string only and must not be null.

Parameters:

data - event data.

Returns:

created OutboundSseEvent.

Throws:

IllegalArgumentException - when data is null.

newEvent

default OutboundSseEvent newEvent(String name,
 String data)

Create new OutboundSseEvent from provided data and name.

Parameters:

name - event name. (see SseEvent.getName()).

data - event data.

Returns:

created OutboundSseEvent.

Throws:

IllegalArgumentException - when name or data is null.

newBroadcaster

SseBroadcaster newBroadcaster()

Get a new Server-sent event broadcaster.

Returns:

new Server-sent event broadcaster instance.