Module jakarta.ws.rs

Package jakarta.ws.rs.sse

Interface OutboundSseEvent

All Superinterfaces:

SseEvent

public interface OutboundSseEvent
extends SseEvent

Representation of a single outbound Server-sent event.

Used on the server side, when creating and sending an event to a client or when broadcasting.

Since:

2.1

Author:

Marek Potociar

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OutboundSseEvent.Builder	A builder class used for creating OutboundSseEvent instances.

Field Summary

Fields inherited from interface jakarta.ws.rs.sse.SseEvent

RECONNECT_NOT_SET

Method Summary

Modifier and Type	Method	Description
Object	getData()	Get event data.
Type	getGenericType()	Get generic data type.
MediaType	getMediaType()	Get media type of the event data.
Class<?>	getType()	Get data type.

Methods inherited from interface jakarta.ws.rs.sse.SseEvent

getComment, getId, getName, getReconnectDelay, isReconnectDelaySet

Method Details

getType

Class<?> getType()

Get data type.

This information is used to select a proper MessageBodyWriter to be used for serializing the event data.

Returns:

data type. May return null, if the event does not contain any data.

getGenericType

Type getGenericType()

Get generic data type.

This information is used to select a proper MessageBodyWriter to be used for serializing the event data.

Returns:

generic data type. May return null, if the event does not contain any data.

getMediaType

MediaType getMediaType()

Get media type of the event data.

This information is used to a select proper MessageBodyWriter to be used for serializing the event data.

Returns:

data MediaType.

getData

Object getData()

Get event data.

The event data, if specified, are serialized and sent as one or more SSE event "data" fields (depending on the line breaks in the actual serialized data content). The data are serialized using an available MessageBodyWriter that is selected based on the event type, getGenericType() generic type} and getMediaType() media type}.

Returns:

event data. May return null, if the event does not contain any data.