Package org.glassfish.jersey.media.sse

Class InboundEvent

java.lang.Object
org.glassfish.jersey.media.sse.InboundEvent
All Implemented Interfaces:
InboundSseEvent, SseEvent
public class InboundEvent extends Object implements InboundSseEvent
Inbound event.
Author:
Pavel Bucek, Marek Potociar

  • Method Details

    • 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.

      Specified by:
      getName in interface SseEvent
      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.

      Specified by:
      getId in interface SseEvent
      Returns:
      event id.
      Since:
      2.3

    • getComment

      public String getComment()
      Get a comment string that accompanies the event.

      Contains value of the comment associated with SSE event. This field is optional. Method may return null, if the event comment is not specified.

      Specified by:
      getComment in interface SseEvent
      Returns:
      comment associated with the event.
      Since:
      2.21

    • 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.

      Specified by:
      getReconnectDelay in interface SseEvent
      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.
      Specified by:
      isReconnectDelaySet in interface SseEvent
      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).
      Specified by:
      isEmpty in interface InboundSseEvent
      Returns:
      true if current instance does not contain any data, false otherwise.

    • readData

      public String readData()
      Get the original event data string String.
      Specified by:
      readData in interface InboundSseEvent
      Returns:
      event data de-serialized into a string.
      Throws:
      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.
      Specified by:
      readData in interface InboundSseEvent
      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.
      Since:
      2.3

    • readData

      public <T> T readData(GenericType<T> type)
      Read event data as a given generic type.
      Specified by:
      readData in interface InboundSseEvent
      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.
      Since:
      2.3

    • readData

      public <T> T readData(Class<T> messageType, MediaType mediaType)
      Read event data as a given Java type.
      Specified by:
      readData in interface InboundSseEvent
      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.
      Since:
      2.3

    • readData

      public <T> T readData(GenericType<T> type, MediaType mediaType)
      Read event data as a given generic type.
      Specified by:
      readData in interface InboundSseEvent
      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.
      Since:
      2.3

    • 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