org.atmosphere.cpr

Interface FrameworkConfig

public interface FrameworkConfig

Request attribute a framework integrator can use to lookup Atmosphere internal objects.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASYNC_CONTEXT The AsyncContext.
static java.lang.String	ATMOSPHERE_CONFIG AtmosphereConfig instance.
static java.lang.String	ATMOSPHERE_HANDLER_WRAPPER A request attribute used to lookup the AtmosphereHandler.
static java.lang.String	ATMOSPHERE_RESOURCE A request attribute used to lookup the AtmosphereResource.
static java.lang.String	ATMOSPHERE_SERVLET A request attribute used to lookup the AtmosphereServlet.
static java.lang.String	BROADCASTER_FACTORY The current installed BroadcasterFactory
static java.lang.String	CALLBACK_JAVASCRIPT_PROTOCOL The callback for handshaking the JavaScriptProtocol.
static java.lang.String	CANCEL_SUSPEND_OPERATION Cancel suspending a connection.
static java.lang.String	CDI_INJECTOR CDI Injector
static java.lang.String	CONTAINER_RESPONSE A reference to the Jersey's ContainerResponse.
static java.lang.String	EXPECTED_CONTENT_TYPE Used by a container to tell Atmosphere Runtime what is the expected content type.
static java.lang.String	GUICE_INJECTOR Guice Injector
static java.lang.String	HAZELCAST_BROADCASTER The default Hazelcast Broadcaster class.
static java.lang.String	INJECT_LIBARY The Java Inject class
static java.lang.String	INJECTED_ATMOSPHERE_RESOURCE A request attribute used to lookup the AtmosphereResource created by an external component and injected inside the AsynchronousProcessor.
static java.lang.String	JERSEY_BROADCASTER The default Jersey Broadcaster class.
static java.lang.String	JERSEY_CONTAINER The default Jersey container class.
static java.lang.String	JERSEY_CONTAINER_RESPONSE_WRITER_INSTANCE Instance of Jersey's ContainerResponseWriter that can be configured by a Framework running on top of Atmosphere.
static java.lang.String	JERSEY_SCANNING_PACKAGE The Jersey package used for scanning annotation.
static java.lang.String	JERSEY2_SCANNING_PACKAGE The Jersey package used for scanning annotation.
static java.lang.String	JGROUPS_BROADCASTER The default JGroups Broadcaster class.
static java.lang.String	JMS_BROADCASTER The default JMS Broadcaster class.
static java.lang.String	KAFKA_BROADCASTER The default Kafka Broadcaster class.
static java.lang.String	MAPPED_PATH The path that mapped the AtmosphereHandler
static java.lang.String	MESSAGE_WRITTEN A flag indicating a message has been written on the resource.
static java.lang.String	NEED_RUNTIME_INJECTION Need runtime injection
static java.lang.String	NEW_MAPPING True if the AtmosphereFramework.AtmosphereHandlerWrapper has been modified by an AtmosphereInterceptor.
static java.lang.String	RABBITMQ_BROADCASTER The default RabbitMQ Broadcaster class.
static java.lang.String	REDIS_BROADCASTER The default Redis Broadcaster class.
static java.lang.String	RMI_BROADCASTER The default RMI Broadcaster class.
static java.lang.String	SECURITY_SUBJECT The subject for the current request.
static java.lang.String	SIMPLE_HTTP_OVER_WEBSOCKET The SimpleHttpProtocol.
static java.lang.String	SPRING_INJECTOR Spring Injector
static java.lang.String	STREAMING_HTTP_OVER_WEBSOCKET The StreamingHttpProtocol.
static java.lang.String	SUPPORT_SESSION Tell a AsyncSupport it can support session or not.
static java.lang.String	THROW_EXCEPTION_ON_CLONED_REQUEST Throw Exception from cloned request.
static java.lang.String	TRANSPORT_IN_USE Current transport used.
static java.lang.String	WEBSOCKET_MESSAGE Tag for WebSocket's Message
static java.lang.String	WEBSOCKET_SUBPROTOCOL The name of the sub-protocol used.
static java.lang.String	WRITE_HEADERS Decide to write extra header.
static java.lang.String	XMPP_BROADCASTER The default XMPP Broadcaster class.

Field Detail

KAFKA_BROADCASTER

static final java.lang.String KAFKA_BROADCASTER

The default Kafka Broadcaster class.

See Also:

Constant Field Values

HAZELCAST_BROADCASTER

static final java.lang.String HAZELCAST_BROADCASTER

The default Hazelcast Broadcaster class.

See Also:

Constant Field Values

JERSEY_BROADCASTER

static final java.lang.String JERSEY_BROADCASTER

The default Jersey Broadcaster class.

See Also:

Constant Field Values

REDIS_BROADCASTER

static final java.lang.String REDIS_BROADCASTER

The default Redis Broadcaster class.

See Also:

Constant Field Values

JMS_BROADCASTER

static final java.lang.String JMS_BROADCASTER

The default JMS Broadcaster class.

See Also:

Constant Field Values

JGROUPS_BROADCASTER

static final java.lang.String JGROUPS_BROADCASTER

The default JGroups Broadcaster class.

See Also:

Constant Field Values

RMI_BROADCASTER

static final java.lang.String RMI_BROADCASTER

The default RMI Broadcaster class.

See Also:

Constant Field Values

RABBITMQ_BROADCASTER

static final java.lang.String RABBITMQ_BROADCASTER

The default RabbitMQ Broadcaster class.

See Also:

Constant Field Values

XMPP_BROADCASTER

static final java.lang.String XMPP_BROADCASTER

The default XMPP Broadcaster class.

See Also:

Constant Field Values

JERSEY_CONTAINER

static final java.lang.String JERSEY_CONTAINER

The default Jersey container class.

See Also:

Constant Field Values

ATMOSPHERE_SERVLET

static final java.lang.String ATMOSPHERE_SERVLET

A request attribute used to lookup the AtmosphereServlet. This attribute is for framework integrators and not recommend for normal applications.

See Also:

Constant Field Values

ATMOSPHERE_RESOURCE

static final java.lang.String ATMOSPHERE_RESOURCE

A request attribute used to lookup the AtmosphereResource. This attribute is for framework integrators and not recommend for normal applications.

INJECTED_ATMOSPHERE_RESOURCE

static final java.lang.String INJECTED_ATMOSPHERE_RESOURCE

A request attribute used to lookup the AtmosphereResource created by an external component and injected inside the AsynchronousProcessor.

SUPPORT_SESSION

static final java.lang.String SUPPORT_SESSION

Tell a AsyncSupport it can support session or not.

ATMOSPHERE_HANDLER_WRAPPER

static final java.lang.String ATMOSPHERE_HANDLER_WRAPPER

A request attribute used to lookup the AtmosphereHandler. This attribute is for framework integrator and not recommend for normal application.

NEW_MAPPING

static final java.lang.String NEW_MAPPING

True if the AtmosphereFramework.AtmosphereHandlerWrapper has been modified by an AtmosphereInterceptor.

CONTAINER_RESPONSE

static final java.lang.String CONTAINER_RESPONSE

A reference to the Jersey's ContainerResponse.

See Also:

Constant Field Values

WRITE_HEADERS

static final java.lang.String WRITE_HEADERS

Decide to write extra header.

EXPECTED_CONTENT_TYPE

static final java.lang.String EXPECTED_CONTENT_TYPE

Used by a container to tell Atmosphere Runtime what is the expected content type.

WEBSOCKET_SUBPROTOCOL

static final java.lang.String WEBSOCKET_SUBPROTOCOL

The name of the sub-protocol used.

See Also:

Constant Field Values

SIMPLE_HTTP_OVER_WEBSOCKET

static final java.lang.String SIMPLE_HTTP_OVER_WEBSOCKET

The SimpleHttpProtocol.

See Also:

Constant Field Values

STREAMING_HTTP_OVER_WEBSOCKET

static final java.lang.String STREAMING_HTTP_OVER_WEBSOCKET

The StreamingHttpProtocol.

See Also:

Constant Field Values

CANCEL_SUSPEND_OPERATION

static final java.lang.String CANCEL_SUSPEND_OPERATION

Cancel suspending a connection.

See Also:

Constant Field Values

ATMOSPHERE_CONFIG

static final java.lang.String ATMOSPHERE_CONFIG

AtmosphereConfig instance.

JERSEY_CONTAINER_RESPONSE_WRITER_INSTANCE

static final java.lang.String JERSEY_CONTAINER_RESPONSE_WRITER_INSTANCE

Instance of Jersey's ContainerResponseWriter that can be configured by a Framework running on top of Atmosphere.

See Also:

Constant Field Values

TRANSPORT_IN_USE

static final java.lang.String TRANSPORT_IN_USE

Current transport used.

CALLBACK_JAVASCRIPT_PROTOCOL

static final java.lang.String CALLBACK_JAVASCRIPT_PROTOCOL

The callback for handshaking the JavaScriptProtocol.

JERSEY_SCANNING_PACKAGE

static final java.lang.String JERSEY_SCANNING_PACKAGE

The Jersey package used for scanning annotation.

See Also:

Constant Field Values

JERSEY2_SCANNING_PACKAGE

static final java.lang.String JERSEY2_SCANNING_PACKAGE

The Jersey package used for scanning annotation.

See Also:

Constant Field Values

THROW_EXCEPTION_ON_CLONED_REQUEST

static final java.lang.String THROW_EXCEPTION_ON_CLONED_REQUEST

Throw Exception from cloned request.

SECURITY_SUBJECT

static final java.lang.String SECURITY_SUBJECT

The subject for the current request.

ASYNC_CONTEXT

static final java.lang.String ASYNC_CONTEXT

The AsyncContext.

See Also:

Constant Field Values

MESSAGE_WRITTEN

static final java.lang.String MESSAGE_WRITTEN

A flag indicating a message has been written on the resource. This is useful to know if a resource must be resumed for transport like long-polling.

GUICE_INJECTOR

static final java.lang.String GUICE_INJECTOR

Guice Injector

See Also:

Constant Field Values

SPRING_INJECTOR

static final java.lang.String SPRING_INJECTOR

Spring Injector

See Also:

Constant Field Values

CDI_INJECTOR

static final java.lang.String CDI_INJECTOR

CDI Injector

See Also:

Constant Field Values

MAPPED_PATH

static final java.lang.String MAPPED_PATH

The path that mapped the AtmosphereHandler

WEBSOCKET_MESSAGE

static final java.lang.String WEBSOCKET_MESSAGE

Tag for WebSocket's Message

INJECT_LIBARY

static final java.lang.String INJECT_LIBARY

The Java Inject class

See Also:

Constant Field Values

BROADCASTER_FACTORY

static final java.lang.String BROADCASTER_FACTORY

The current installed BroadcasterFactory

NEED_RUNTIME_INJECTION

static final java.lang.String NEED_RUNTIME_INJECTION

Need runtime injection