org.glassfish.jersey.media.sse

Class InboundEvent

java.lang.Object

org.glassfish.jersey.media.sse.InboundEvent

public class InboundEvent
extends Object

Inbound event.

Author:

Pavel Bucek (pavel.bucek at oracle.com), Marek Potociar (marek.potociar at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
String	getData() Deprecated. Use readData() instead.
<T> T	getData(Class<T> type) Deprecated. Use readData(Class) instead.
<T> T	getData(Class<T> messageType, javax.ws.rs.core.MediaType mediaType) Deprecated. Use readData(Class, javax.ws.rs.core.MediaType) instead.
String	getId() Get event identifier.
String	getName() Get event name.
byte[]	getRawData() Get the raw event data bytes.
long	getReconnectDelay() Get new connection retry time in milliseconds the event receiver should wait before attempting to reconnect after a connection to the SSE event source is lost.
boolean	isEmpty() Check if the event is empty (i.e.
boolean	isReconnectDelaySet() Check if the connection retry time has been set in the event.
String	readData() Get the original event data string String.
<T> T	readData(Class<T> type) Read event data as a given Java type.
<T> T	readData(Class<T> messageType, javax.ws.rs.core.MediaType mediaType) Read event data as a given Java type.
<T> T	readData(javax.ws.rs.core.GenericType<T> type) Read event data as a given generic type.
<T> T	readData(javax.ws.rs.core.GenericType<T> type, javax.ws.rs.core.MediaType mediaType) Read event data as a given generic type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Get event name.

Contains value of SSE "event" field. This field is optional. Method may return null, if the event name is not specified.

Returns:

event name, or null if not set.

getId

public String getId()

Get event identifier.

Contains value of SSE "id" field. This field is optional. Method may return null, if the event identifier is not specified.

Returns:

event id.

Since:

2.3

getReconnectDelay

public long getReconnectDelay()

Get new connection retry time in milliseconds the event receiver should wait before attempting to reconnect after a connection to the SSE event source is lost.

Contains value of SSE "retry" field. This field is optional. Method returns SseFeature.RECONNECT_NOT_SET if no value has been set.

Returns:

reconnection delay in milliseconds or SseFeature.RECONNECT_NOT_SET if no value has been set.

Since:

2.3

isReconnectDelaySet

public boolean isReconnectDelaySet()

Check if the connection retry time has been set in the event.

Returns:

true if new reconnection delay has been set in the event, false otherwise.

Since:

2.3

isEmpty

public 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

public String readData()

Get the original event data string String.

Returns:

event data de-serialized into a string.

Throws:

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

Since:

2.3

readData

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

Read event data as a given Java 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:

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

Since:

2.3

readData

public <T> T readData(javax.ws.rs.core.GenericType<T> type)

Read event data as a given generic 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:

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

Since:

2.3

readData

public <T> T readData(Class<T> messageType,
             javax.ws.rs.core.MediaType mediaType)

Read event data as a given Java 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:

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

Since:

2.3

readData

public <T> T readData(javax.ws.rs.core.GenericType<T> type,
             javax.ws.rs.core.MediaType mediaType)

Read event data as a given generic 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:

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

Since:

2.3

getData

@Deprecated
public String getData()
               throws IOException

Deprecated. Use readData() instead.

See readData().

Returns:

event data de-serialized into a string.

Throws:

IOException - when provided type can't be read.

getData

@Deprecated
public <T> T getData(Class<T> type)
          throws IOException

Deprecated. Use readData(Class) instead.

See readData(Class).

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:

IOException - when provided type can't be read.

getData

@Deprecated
public <T> T getData(Class<T> messageType,
                       javax.ws.rs.core.MediaType mediaType)
          throws IOException

Deprecated. Use readData(Class, javax.ws.rs.core.MediaType) instead.

See readData(Class).

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:

IOException - when provided type can't be read.

getRawData

public byte[] getRawData()

Get the raw event data bytes.

Returns:

raw event data bytes. The returned byte array may be empty if the event does not contain any data.

toString

public String toString()

Overrides:

toString in class Object