Top Description Methods
javax.ws.rs.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.

Author
Marek Potociar (marek.potociar at oracle.com)
Since
2.1

Method Summary

Modifier and TypeMethod and Description
public SseBroadcaster

Returns:

new Server-sent event broadcaster instance.
newBroadcaster()

Get a new Server-sent event broadcaster.

public default OutboundSseEvent

Returns:

created OutboundSseEvent.
newEvent(String
event data.
data)

Create new OutboundSseEvent from provided data.

public default OutboundSseEvent

Returns:

created OutboundSseEvent.
newEvent(String
event name. (see OutboundSseEvent#getName()).
name, String
event data.
data)

Create new OutboundSseEvent from provided data and name.

public OutboundSseEvent.Builder

Returns:

SSE outbound event builder.
newEventBuilder()

Get a new outbound event builder.

Method Detail

newBroadcasterback to summary
public SseBroadcaster newBroadcaster()

Get a new Server-sent event broadcaster.

Returns:SseBroadcaster

new Server-sent event broadcaster instance.

newEventback to summary
public default OutboundSseEvent newEvent(String data)

Create new OutboundSseEvent from provided data.

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

Parameters
data:String

event data.

Returns:OutboundSseEvent

created OutboundSseEvent.

Exceptions
IllegalArgumentException:
when data is null.
newEventback to summary
public default OutboundSseEvent newEvent(String name, String data)

Create new OutboundSseEvent from provided data and name.

Parameters
name:String

event name. (see OutboundSseEvent#getName()).

data:String

event data.

Returns:OutboundSseEvent

created OutboundSseEvent.

Exceptions
IllegalArgumentException:
when name or data is null.
newEventBuilderback to summary
public OutboundSseEvent.Builder newEventBuilder()

Get a new outbound event builder.

Returns:OutboundSseEvent.Builder

SSE outbound event builder.