Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- awaitFirstContact() - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor
-
Await the initial contact with the SSE endpoint.
B
- boundListeners(Map<String, List<EventListener>>) - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Unbounded listeners will get notified about incoming events with particular name.
- build() - Method in class org.glassfish.jersey.media.sse.EventSource.Builder
-
Build new SSE event source pointing at a SSE streaming
web target. - build() - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Build the
EventProcessor. - build() - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource.Builder
- build() - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Build
OutboundEvent. - builder(WebTarget, AtomicReference<EventProcessor.State>, ClientExecutor, EventListener, EventProcessor.ShutdownHandler) - Static method in class org.glassfish.jersey.media.sse.internal.EventProcessor
-
Create new Event processor builder.
- Builder() - Constructor for class org.glassfish.jersey.media.sse.internal.JerseySseEventSource.Builder
- Builder() - Constructor for class org.glassfish.jersey.media.sse.OutboundEvent.Builder
C
- close() - Method in class org.glassfish.jersey.media.sse.EventSource
-
Close this event source.
- close(long, TimeUnit) - Method in class org.glassfish.jersey.media.sse.EventSource
-
Close this event source and wait for the internal event processing task to complete for up to the specified amount of wait time.
- close(long, TimeUnit) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- CLOSED - Enum constant in enum class org.glassfish.jersey.media.sse.internal.EventProcessor.State
-
Closed, won't receive any events.
- comment(String) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set comment string associated with the event.
- configure() - Method in class org.glassfish.jersey.media.sse.internal.SseBinder
- configure(FeatureContext) - Method in class org.glassfish.jersey.media.sse.internal.SseAutoDiscoverable
- configure(FeatureContext) - Method in class org.glassfish.jersey.media.sse.SseFeature
- createValueProvider(Parameter) - Method in class org.glassfish.jersey.media.sse.internal.SseEventSinkValueParamProvider
D
- data(GenericType, Object) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set event data and a generic java type of event data.
- data(Class, Object) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set event data and java type of event data.
- data(Object) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set event data and java type of event data.
- DISABLE_SSE - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
If
truethenSSE Featureautomatic registration is suppressed. - DISABLE_SSE_CLIENT - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
Client-side variant of
SseFeature.DISABLE_SSEproperty. - DISABLE_SSE_SERVER - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
Server-side variant of
SseFeature.DISABLE_SSEproperty. - disableKeepAlive() - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Disables keepalive.
E
- EVENT_DATA_READER_NOT_FOUND() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Message body reader not found for the SSE event data.
- EVENT_SINK_CLOSE_FAILED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Closing EventSink failed.
- EVENT_SINK_NEXT_FAILED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Processing onNext signal failed.
- EVENT_SOURCE_ALREADY_CLOSED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
This event source has already been closed.
- EVENT_SOURCE_ALREADY_CONNECTED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
This event source is already open.
- EVENT_SOURCE_DEFAULT_ONERROR() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Subscriber.onError() called on subscriber with no registered error handler.
- EVENT_SOURCE_OPEN_CONNECTION_INTERRUPTED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Waiting for opening the event source connection has been interrupted.
- EVENT_SOURCE_SHUTDOWN_INTERRUPTED(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Waiting for the event source executor for [{0}] to shutdown has been interrupted.
- EVENT_SOURCE_SHUTDOWN_TIMEOUT(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Attempt to shutdown the event source executor for [{0}] has timed out.
- EventInput - Class in org.glassfish.jersey.media.sse
-
Inbound Server-Sent Events channel.
- EventInput(InputStream, Annotation[], MediaType, MultivaluedMap<String, String>, MessageBodyWorkers, PropertiesDelegate) - Constructor for class org.glassfish.jersey.media.sse.EventInput
-
Package-private constructor used by the
ChunkedInputReader. - EventListener - Interface in org.glassfish.jersey.media.sse
-
EventSourcelistener that can be registered to listen for newly receivedInboundEventnotifications. - EventOutput - Class in org.glassfish.jersey.media.sse
-
Outbound Server-Sent Events channel.
- EventOutput() - Constructor for class org.glassfish.jersey.media.sse.EventOutput
-
Create new outbound Server-Sent Events channel.
- EventProcessor - Class in org.glassfish.jersey.media.sse.internal
-
Private event processor task responsible for connecting to the SSE stream and processing incoming SSE events as well as handling any connection issues.
- EventProcessor.Builder - Class in org.glassfish.jersey.media.sse.internal
-
EventProcessorbuilder. - EventProcessor.ShutdownHandler - Interface in org.glassfish.jersey.media.sse.internal
-
Used to signal that the
EventProcessorreached terminal stage. - EventProcessor.State - Enum Class in org.glassfish.jersey.media.sse.internal
-
Event processor state, which is shared with the owner (to be able to control bootstrap and shutdown).
- EventSource - Class in org.glassfish.jersey.media.sse
-
Client for reading and processing
incoming Server-Sent Events. - EventSource(WebTarget) - Constructor for class org.glassfish.jersey.media.sse.EventSource
-
Create new SSE event source and open a connection it to the supplied SSE streaming
web target. - EventSource(WebTarget, boolean) - Constructor for class org.glassfish.jersey.media.sse.EventSource
-
Create new SSE event source pointing at a SSE streaming
web target. - EventSource.Builder - Class in org.glassfish.jersey.media.sse
-
Jersey
EventSourcebuilder class.
G
- getComment() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Get a comment string that accompanies the event.
- getComment() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get a comment string that accompanies the event.
- getData() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get event data.
- getGenericType() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get generic data type.
- getId() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Get event identifier.
- getId() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get event identifier.
- getMediaType() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get
media typeof the event data. - getName() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Get event name.
- getName() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get event name.
- getRawData() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Get the raw event data bytes.
- getReconnectDelay() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
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.
- getReconnectDelay() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get connection retry time in milliseconds the event receiver should wait before attempting to reconnect after a connection to the SSE source is lost.
- getType() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Get data type.
I
- id(String) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set event id.
- IN_EVENT_FIELD_NOT_RECOGNIZED(Object, Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Inbound event field [{0}: {1}] is not a recognized SSE field name and will be ignored.
- IN_EVENT_RETRY_PARSE_ERROR(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Unable to parse inbound event retry value [{0}] as decimal number.
- InboundEvent - Class in org.glassfish.jersey.media.sse
-
Inbound event.
- isEmpty() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Check if the event is empty (i.e. does not contain any data).
- isOpen() - Method in class org.glassfish.jersey.media.sse.EventSource
-
Check if this event source instance has already been
opened. - isOpen() - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- isReconnectDelaySet() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Check if the connection retry time has been set in the event.
- isReconnectDelaySet() - Method in class org.glassfish.jersey.media.sse.OutboundEvent
-
Check if the connection retry time has been set in the event.
J
- JerseySseEventSource - Class in org.glassfish.jersey.media.sse.internal
-
SseEventSourceimplementation. - JerseySseEventSource.Builder - Class in org.glassfish.jersey.media.sse.internal
-
SseEventSource.Builderimplementation. - JerseySseEventSourceBuilder - Class in org.glassfish.jersey.media.sse
-
Public
SseEventSource.Builderimplementation. - JerseySseEventSourceBuilder() - Constructor for class org.glassfish.jersey.media.sse.JerseySseEventSourceBuilder
L
- LAST_EVENT_ID_HEADER - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
"Last-Event-ID"HTTP request header name as defined by SSE specification. - localizableEVENT_DATA_READER_NOT_FOUND() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SINK_CLOSE_FAILED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SINK_NEXT_FAILED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_ALREADY_CLOSED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_ALREADY_CONNECTED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_DEFAULT_ONERROR() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_OPEN_CONNECTION_INTERRUPTED() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_SHUTDOWN_INTERRUPTED(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableEVENT_SOURCE_SHUTDOWN_TIMEOUT(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableIN_EVENT_FIELD_NOT_RECOGNIZED(Object, Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableIN_EVENT_RETRY_PARSE_ERROR(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableOUT_EVENT_DATA_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableOUT_EVENT_DATA_TYPE_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableOUT_EVENT_MEDIA_TYPE_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableOUT_EVENT_NOT_BUILDABLE() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizablePARAM_NULL(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizablePARAMS_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- localizableUNSUPPORTED_WEBTARGET_TYPE(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
- LocalizationMessages - Class in org.glassfish.jersey.media.sse
-
Defines string formatting method for each constant in the resource file
M
- mediaType(MediaType) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set the
media typeof the event data.
N
- name(String) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set event name.
- named(String) - Method in class org.glassfish.jersey.media.sse.EventSource.Builder
-
Set a custom name for the event source.
O
- onEvent(InboundSseEvent) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
-
On event callback, invoked whenever an event is received.
- onEvent(InboundEvent) - Method in interface org.glassfish.jersey.media.sse.EventListener
-
Invoked when an event is received.
- onEvent(InboundEvent) - Method in class org.glassfish.jersey.media.sse.EventSource
-
Invoked when an event is received.
- onEvent(InboundEvent) - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor
-
Called by the event source when an inbound event is received.
- open() - Method in class org.glassfish.jersey.media.sse.EventSource.Builder
-
Build new SSE event source pointing at a SSE streaming
web target. - open() - Method in class org.glassfish.jersey.media.sse.EventSource
-
Open the connection to the supplied SSE underlying
web targetand start processing incomingevents. - open() - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- OPEN - Enum constant in enum class org.glassfish.jersey.media.sse.internal.EventProcessor.State
-
Connection established, events can be received.
- org.glassfish.jersey.media.sse - package org.glassfish.jersey.media.sse
-
Support for Server Sent events in Jersey.
- org.glassfish.jersey.media.sse.internal - package org.glassfish.jersey.media.sse.internal
- OUT_EVENT_DATA_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Outbound event data must not be explicitly set to 'null'.
- OUT_EVENT_DATA_TYPE_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Outbound event data type must not be explicitly set to 'null'.
- OUT_EVENT_MEDIA_TYPE_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Outbound event data media type must not be explicitly set to 'null'.
- OUT_EVENT_NOT_BUILDABLE() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Cannot build outbound event.
- OutboundEvent - Class in org.glassfish.jersey.media.sse
-
Representation of a single outbound SSE event.
- OutboundEvent.Builder - Class in org.glassfish.jersey.media.sse
-
Used for creating
OutboundEventinstances.
P
- PARAM_NULL(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
"{0}" parameter is null.
- PARAMS_NULL() - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
One or more of parameters is null.
R
- readData() - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Get the original event data string
String. - readData(GenericType<T>) - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Read event data as a given generic type.
- readData(GenericType<T>, MediaType) - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Read event data as a given generic type.
- readData(Class<T>) - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Read event data as a given Java type.
- readData(Class<T>, MediaType) - Method in class org.glassfish.jersey.media.sse.InboundEvent
-
Read event data as a given Java type.
- READY - Enum constant in enum class org.glassfish.jersey.media.sse.internal.EventProcessor.State
-
Ready to connect.
- RECONNECT_DEFAULT - Static variable in class org.glassfish.jersey.media.sse.EventSource
-
Default SSE
EventSourcereconnect delay value in milliseconds. - RECONNECT_NOT_SET - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
A "reconnection not set" value for the SSE reconnect delay set via
retryfield. - reconnectDelay(long) - Method in class org.glassfish.jersey.media.sse.OutboundEvent.Builder
-
Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to reconnect in case a connection to SSE event source is lost.
- reconnectDelay(long, TimeUnit) - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Set initial reconnect delay.
- reconnectingEvery(long, TimeUnit) - Method in class org.glassfish.jersey.media.sse.EventSource.Builder
-
Set the initial reconnect delay to be used by the event source.
- reconnectingEvery(long, TimeUnit) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource.Builder
- register(Consumer<InboundSseEvent>) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- register(Consumer<InboundSseEvent>, Consumer<Throwable>) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- register(Consumer<InboundSseEvent>, Consumer<Throwable>, Runnable) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource
- register(EventListener) - Method in class org.glassfish.jersey.media.sse.EventSource
-
Register new
event listenerto receive all streamedSSE events. - register(EventListener, String, String...) - Method in class org.glassfish.jersey.media.sse.EventSource
-
Add name-bound
event listenerwhich will be called only for incoming SSEeventswhosenameis equal to the specified name(s). - run() - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor
S
- SERVER_SENT_EVENTS - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
Stringrepresentation of Server sent events media type - SERVER_SENT_EVENTS_TYPE - Static variable in class org.glassfish.jersey.media.sse.SseFeature
-
Server sent events media type.
- shutdown() - Method in interface org.glassfish.jersey.media.sse.internal.EventProcessor.ShutdownHandler
-
Invoked when the
EventProcessorreaches terminal stage. - SseAutoDiscoverable - Class in org.glassfish.jersey.media.sse.internal
-
Jersey
AutoDiscoverableresponsible for registeringSseFeature. - SseAutoDiscoverable() - Constructor for class org.glassfish.jersey.media.sse.internal.SseAutoDiscoverable
- SseBinder - Class in org.glassfish.jersey.media.sse.internal
-
Binds implementations to interfaces for injection of SSE-related injectables.
- SseBinder() - Constructor for class org.glassfish.jersey.media.sse.internal.SseBinder
- SseBroadcaster - Class in org.glassfish.jersey.media.sse
-
Used for broadcasting SSE to multiple
EventOutputinstances. - SseBroadcaster() - Constructor for class org.glassfish.jersey.media.sse.SseBroadcaster
-
Creates a new instance.
- SseBroadcaster(Class<? extends SseBroadcaster>) - Constructor for class org.glassfish.jersey.media.sse.SseBroadcaster
-
Can be used by subclasses to override the default functionality of adding self to the set of
listeners. - SseEventSinkValueParamProvider - Class in org.glassfish.jersey.media.sse.internal
-
ValueParamProviderfor bindingSseEventSinkto its implementation. - SseEventSinkValueParamProvider(Provider<MultivaluedParameterExtractorProvider>, Provider<AsyncContext>) - Constructor for class org.glassfish.jersey.media.sse.internal.SseEventSinkValueParamProvider
-
Constructor.
- SseFeature - Class in org.glassfish.jersey.media.sse
-
A JAX-RS
featurethat enables Server-Sent Events support. - SseFeature() - Constructor for class org.glassfish.jersey.media.sse.SseFeature
T
- target(WebTarget) - Static method in class org.glassfish.jersey.media.sse.EventSource
-
Create a new
event source builderthat provides convenient way how to configure and fine-tune various aspects of a newly prepared event source instance. - target(WebTarget) - Method in class org.glassfish.jersey.media.sse.internal.JerseySseEventSource.Builder
- throwableConsumers(List<Consumer<Throwable>>) - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Set the consumers of
Throwableoccurring during connection. - toString() - Method in class org.glassfish.jersey.media.sse.InboundEvent
U
- unboundListeners(List<EventListener>) - Method in class org.glassfish.jersey.media.sse.internal.EventProcessor.Builder
-
Unbounded listeners will get notified about any incoming event.
- UNSUPPORTED_WEBTARGET_TYPE(Object) - Static method in class org.glassfish.jersey.media.sse.LocalizationMessages
-
Argument {0} is not a valid JerseyWebTarget instance.
- usePersistentConnections() - Method in class org.glassfish.jersey.media.sse.EventSource.Builder
-
Instruct event source to use persistent HTTP connections when connecting (or reconnecting) to the SSE endpoint, provided the mechanism is supported by the underlying client
Connector.
V
- valueOf(String) - Static method in enum class org.glassfish.jersey.media.sse.internal.EventProcessor.State
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.glassfish.jersey.media.sse.internal.EventProcessor.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values