Module jakarta.ws.rs

Package jakarta.ws.rs.sse

Interface InboundSseEvent

All Superinterfaces:

SseEvent

public interface InboundSseEvent
extends SseEvent

Inbound Server-sent event.

Used on the client side, when accepting incoming Server-sent events.

Since:

2.1

Field Summary

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

RECONNECT_NOT_SET

Method Summary

Modifier and Type	Method	Description
boolean	isEmpty()	Check if the event is empty (i.e.
String	readData()	Get the original event data as String.
<T> T	readData(GenericType<T> type)	Read event data as a given generic type.
<T> T	readData(GenericType<T> type, MediaType mediaType)	Read event data as a given generic type.
<T> T	readData(Class<T> type)	Read event data as a given Java type.
<T> T	readData(Class<T> messageType, MediaType mediaType)	Read event data as a given Java type.

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

getComment, getId, getName, getReconnectDelay, isReconnectDelaySet

Method Details

isEmpty

boolean isEmpty()

Check if the event is empty (i.e. does not contain any data).

Returns:

true if current instance does not contain any data, false otherwise.

readData

String readData()

Get the original event data as String.

Returns:

event data de-serialized into a string.

Throws:

ProcessingException - when provided type can't be read. The thrown exception wraps the original cause.

readData

<T> T readData(Class<T> type)

Read event data as a given Java type.

Type Parameters:

T - generic event data type

Parameters:

type - Java type to be used for event data de-serialization.

Returns:

event data de-serialized as an instance of a given type.

Throws:

ProcessingException - when provided type can't be read. The thrown exception wraps the original cause.

readData

<T> T readData(GenericType<T> type)

Read event data as a given generic type.

Type Parameters:

T - generic event data type

Parameters:

type - generic type to be used for event data de-serialization.

Returns:

event data de-serialized as an instance of a given type.

Throws:

ProcessingException - when provided type can't be read. The thrown exception wraps the original cause.

readData

<T> T readData(Class<T> messageType,
 MediaType mediaType)

Read event data as a given Java type.

Type Parameters:

T - generic event data type

Parameters:

messageType - Java type to be used for event data de-serialization.

mediaType - media type to be used for event data de-serialization.

Returns:

event data de-serialized as an instance of a given type.

Throws:

ProcessingException - when provided type can't be read. The thrown exception wraps the original cause.

readData

<T> T readData(GenericType<T> type,
 MediaType mediaType)

Read event data as a given generic type.

Type Parameters:

T - generic event data type

Parameters:

type - generic type to be used for event data de-serialization.

mediaType - media type to be used for event data de-serialization.

Returns:

event data de-serialized as an instance of a given type.

Throws:

ProcessingException - when provided type can't be read. The thrown exception wraps the original cause.