org.glassfish.jersey.media.sse

Class SseFeature

java.lang.Object

org.glassfish.jersey.media.sse.SseFeature

All Implemented Interfaces:

javax.ws.rs.core.Feature

public class SseFeature
extends Object
implements javax.ws.rs.core.Feature

A JAX-RS feature that enables Server-Sent Events support.

Author:

Marek Potociar

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_SSE If true then SSE Feature automatic registration is suppressed.
static String	DISABLE_SSE_CLIENT Client-side variant of DISABLE_SSE property.
static String	DISABLE_SSE_SERVER Server-side variant of DISABLE_SSE property.
static String	LAST_EVENT_ID_HEADER "Last-Event-ID" HTTP request header name as defined by SSE specification.
static long	RECONNECT_NOT_SET A "reconnection not set" value for the SSE reconnect delay set via retry field.
static String	SERVER_SENT_EVENTS String representation of Server sent events media type.
static javax.ws.rs.core.MediaType	SERVER_SENT_EVENTS_TYPE Server sent events media type.

Constructor Summary

Constructors

Constructor and Description
SseFeature()

Method Summary

Modifier and Type	Method and Description
boolean	configure(javax.ws.rs.core.FeatureContext context)

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_SENT_EVENTS

public static final String SERVER_SENT_EVENTS

String representation of Server sent events media type. (""text/event-stream"").

See Also:

Constant Field Values

SERVER_SENT_EVENTS_TYPE

public static final javax.ws.rs.core.MediaType SERVER_SENT_EVENTS_TYPE

Server sent events media type.

DISABLE_SSE

public static final String DISABLE_SSE

If true then SSE Feature automatic registration is suppressed.

Since Jersey 2.8, by default SSE Feature is automatically enabled when the SSE module is on class path. You can override this behavior by setting this property to true. The value of this property may be specifically overridden on either client or server side by setting the client or server variant of this property.

The default value is false.

The name of the configuration property is "jersey.config.media.sse.disable".

Since:

2.8

See Also:

Constant Field Values

DISABLE_SSE_CLIENT

public static final String DISABLE_SSE_CLIENT

Client-side variant of DISABLE_SSE property.

The default value is false.

The name of the configuration property is "jersey.config.client.media.sse.disable".

Since:

2.8

See Also:

Constant Field Values

DISABLE_SSE_SERVER

public static final String DISABLE_SSE_SERVER

Server-side variant of DISABLE_SSE property.

The default value is false.

The name of the configuration property is "jersey.config.server.media.sse.disable".

Since:

2.8

See Also:

Constant Field Values

RECONNECT_NOT_SET

public static final long RECONNECT_NOT_SET

A "reconnection not set" value for the SSE reconnect delay set via retry field.

Since:

2.3

See Also:

Constant Field Values

LAST_EVENT_ID_HEADER

public static final String LAST_EVENT_ID_HEADER

"Last-Event-ID" HTTP request header name as defined by SSE specification.

Since:

2.3

See Also:

Constant Field Values

Constructor Detail

SseFeature

public SseFeature()

Method Detail

configure

public boolean configure(javax.ws.rs.core.FeatureContext context)

Specified by:

configure in interface javax.ws.rs.core.Feature