org.atmosphere.cpr
Interface ApplicationConfig

public interface ApplicationConfig

Web.xml init-param configuration supported by Atmosphere.

Author:

Jeanfrancois Arcand

Field Summary

static String	ALLOW_QUERYSTRING_AS_REQUEST Allow query string as set as request's header.
static String	ANNOTATION_PROCESSOR The annotation processor
static String	ATMOSPHERE_EXCLUDED_FILE Regex pattern for excluding file from being serviced by AtmosphereFilter
static String	ATMOSPHERE_HANDLER Tell Atmosphere which AtmosphereHandler should be used.
static String	ATMOSPHERE_HANDLER_MAPPING The AtmosphereHandler defined using the property will be mapped to that value.
static String	ATMOSPHERE_HANDLER_PATH The location of classes implementing the AtmosphereHandler interface.
static String	ATMOSPHERE_INTERCEPTORS A list of AtmosphereInterceptor class name that will be invoked before the AtmosphereResource gets delivered to an application or framework
static String	ATMOSPHERE_RESOURCE The Atmosphere resource to use.
static String	ATMOSPHERERESOURCE_INTERCEPTOR_METHOD The method used that trigger automatic management of AtmosphereResource when the AtmosphereResourceLifecycleInterceptor is used
static String	BROADCAST_FILTER_CLASSES A list of BroadcastFilter separated with coma that will be added to every new Broadcaster
static String	BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE The maximum number of Thread created when writing requests BroadcasterConfig.setAsyncWriteService(java.util.concurrent.ExecutorService)
static String	BROADCASTER_CACHE The default BroadcasterCache class.
static String	BROADCASTER_CACHE_STRATEGY Define when a broadcasted message is cached.
static String	BROADCASTER_CLASS The default Broadcaster class.
static String	BROADCASTER_FACTORY The default BroadcasterFactory class.
static String	BROADCASTER_LIFECYCLE_POLICY The BroadcasterLifeCyclePolicy policy to use
static String	BROADCASTER_LIFECYCLE_POLICY_IDLETIME BroadcasterLifecycle max idle time before executing.
static String	BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE The maximum number of Thread created when processing broadcast operations BroadcasterConfig.setExecutorService(java.util.concurrent.ExecutorService)
static String	BROADCASTER_SHARABLE_THREAD_POOLS Configure Broadcaster to share the same ExecutorService instead among them.
static String	DEFAULT_CONTENT_TYPE The default content-type value used when Atmosphere requires one.
static String	DEFAULT_NAMED_DISPATCHER The default Servlet used when forwarding request.
static String	DISABLE_ATMOSPHEREINTERCEPTOR Disable au-discovery of pre-installed AtmosphereInterceptor
static String	DISABLE_ONSTATE_EVENT Disable invoking AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) when the connection times out or get cancelled
static String	DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER Tell Atmosphere to not write the access-control header.
static String	ENDPOINT_MAPPER Definr an implementation of the EndpointMapper
static String	EXCLUDED_CONTENT_TYPES The list of content-type to exclude when delimiting message.
static String	FILTER_CLASS The Filter's name where Meteor will be available
static String	FILTER_NAME The Servlet's mapping value to the FILTER_CLASS
static String	HANDLER_MAPPING_REGEX Change the default regex used when mapping AtmosphereHandler.
static String	JERSEY_CONTAINER_RESPONSE_WRITER_CLASS Jersey's ContainerResponseWriter.
static String	MAPPING The Servlet's mapping value to the SERVLET_CLASS
static String	MAX_INACTIVE The maximum time, in milisecond, a connection gets idle.
static String	MESSAGE_DELIMITER The token used to separate broadcasted messages.
static String	NO_CACHE_HEADERS Tell Atmosphere to not write the no-cache header.
static String	OUT_OF_ORDER_BROADCAST Set to true if order of message delivered to the client is not important
static String	PROPERTY_ATMOSPHERE_XML The location of the atmosphere.xml file.
static String	PROPERTY_BLOCKING_COMETSUPPORT Set Atmosphere to use the BlockingIOCometSupport, e.g blocking I/O
static String	PROPERTY_COMET_SUPPORT Tell Atmosphere which AsyncSupport implementation to use.
static String	PROPERTY_NATIVE_COMETSUPPORT Set Atmosphere to use the container native Comet support
static String	PROPERTY_SERVLET_MAPPING The path that will be used to map request to Jersey
static String	PROPERTY_SESSION_SUPPORT Tell Atmosphere to use HttpSession.
static String	PROPERTY_USE_STREAM Force Atmosphere to use stream when writing bytes.
static String	RECOVER_DEAD_BROADCASTER Recover from a Broadcaster that has been destroyed.
static String	RECYCLE_ATMOSPHERE_REQUEST_RESPONSE Recycle (make them unusable) AtmosphereRequest/Response after wrapping a WebSocket message and delegating it to a Container
static String	RESUME_AND_KEEPALIVE A request attribute used to tell AsyncSupport implementation to keep alive the connection or not.
static String	RESUME_ON_BROADCAST Force Atmosphere to invoke AtmosphereResource.resume() after the first Broadcaster.broadcast(Object) invokation.
static String	RESUMED_ON_TIMEOUT A request attribute telling a AsyncSupport if the AtmosphereResource was resumed on timeout or by an application.
static String	SERVLET_CLASS The Servlet's name where Meteor will be available
static String	SHARED Set to true if Atmosphere is used as a library and you don't want to destroy associated static factory when undeploying.
static String	SSE_CONTENT_TYPE Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest
static String	STREAMING_PADDING_MODE Configure the padding used when streaming is used.
static String	SUPPORT_LOCATION_HEADER Support the Jersey location header for resuming.
static String	SUSPENDED_ATMOSPHERE_RESOURCE_UUID The suspended UUID of the suspended connection which is the same as HeaderConfig.X_ATMOSPHERE_TRACKING_ID but available to all transport.
static String	TOMCAT_CLOSE_STREAM Prevent Tomcat from closing connection when inputStream#read() reach the end of the stream, as documented in the tomcat documentation
static String	UNIQUE_UUID_WEBSOCKET Use a unique uuid for all WebSocket message delivered on the same connection.
static String	USE_SERVLET_WRAPPER Wrap the request/response with associated HttpServletRequest and HttpServletResponse
static String	WEB_SOCKET_BANNED_VERSION WebSocket version to exclude and downgrade to comet.
static String	WEBSOCKET_BINARY_WRITE Write binary instead of String
static String	WEBSOCKET_BUFFER_SIZE Tell Atmosphere the WebSocket write buffer size.
static String	WEBSOCKET_CONTENT_TYPE Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest
static String	WEBSOCKET_IDLETIME Tell Atmosphere how long a WebSocket connection can stay idle.
static String	WEBSOCKET_MAXBINARYSIZE Set the WebSocket mas text size: size<0 No aggregation of frames to messages, >=0 max size of text frame aggregation buffer in characters
static String	WEBSOCKET_MAXTEXTSIZE Set the WebSocket mas text size: size<0 No aggregation of frames to messages, >=0 max size of text frame aggregation buffer in characters
static String	WEBSOCKET_METHOD Tell Atmosphere the method to use when a WebSocket message is dispatched as an AtmosphereRequest
static String	WEBSOCKET_PATH_DELIMITER Tell Atmosphere the path delimiter to use when a WebSocket message contains the path as it first line.
static String	WEBSOCKET_PROCESSOR Tell Atmosphere the WebSocketProcessor to use.
static String	WEBSOCKET_PROTOCOL Tell Atmosphere the WebSocketProcessor to use.
static String	WEBSOCKET_PROTOCOL_EXECUTION Execute the WebSocketProtocol.onMessage(org.atmosphere.websocket.WebSocket, byte[], int, int)
static String	WEBSOCKET_SUPPORT Force Atmosphere to use WebSocket
static String	WEBSOCKET_SUPPORT_SERVLET3 Force Atmosphere to use WebSocket + Servlet 30 API

Field Detail

PROPERTY_ATMOSPHERE_XML

static final String PROPERTY_ATMOSPHERE_XML

The location of the atmosphere.xml file.

See Also:

Constant Field Values

PROPERTY_SERVLET_MAPPING

static final String PROPERTY_SERVLET_MAPPING

The path that will be used to map request to Jersey

See Also:

Constant Field Values

PROPERTY_BLOCKING_COMETSUPPORT

static final String PROPERTY_BLOCKING_COMETSUPPORT

Set Atmosphere to use the BlockingIOCometSupport, e.g blocking I/O

See Also:

Constant Field Values

PROPERTY_NATIVE_COMETSUPPORT

static final String PROPERTY_NATIVE_COMETSUPPORT

Set Atmosphere to use the container native Comet support

See Also:

Constant Field Values

WEBSOCKET_SUPPORT

static final String WEBSOCKET_SUPPORT

Force Atmosphere to use WebSocket

See Also:

Constant Field Values

WEBSOCKET_SUPPORT_SERVLET3

static final String WEBSOCKET_SUPPORT_SERVLET3

Force Atmosphere to use WebSocket + Servlet 30 API

See Also:

Constant Field Values

PROPERTY_USE_STREAM

static final String PROPERTY_USE_STREAM

Force Atmosphere to use stream when writing bytes.

See Also:

Constant Field Values

BROADCASTER_FACTORY

static final String BROADCASTER_FACTORY

The default BroadcasterFactory class.

BROADCASTER_CLASS

static final String BROADCASTER_CLASS

The default Broadcaster class.

BROADCASTER_CACHE

static final String BROADCASTER_CACHE

The default BroadcasterCache class.

PROPERTY_COMET_SUPPORT

static final String PROPERTY_COMET_SUPPORT

Tell Atmosphere which AsyncSupport implementation to use.

PROPERTY_SESSION_SUPPORT

static final String PROPERTY_SESSION_SUPPORT

Tell Atmosphere to use HttpSession. Default is false.

RESUME_ON_BROADCAST

static final String RESUME_ON_BROADCAST

Force Atmosphere to invoke AtmosphereResource.resume() after the first Broadcaster.broadcast(Object) invokation.

See Also:

Constant Field Values

DEFAULT_NAMED_DISPATCHER

static final String DEFAULT_NAMED_DISPATCHER

The default Servlet used when forwarding request.

See Also:

Constant Field Values

NO_CACHE_HEADERS

static final String NO_CACHE_HEADERS

Tell Atmosphere to not write the no-cache header. Default is false, e.g Atmosphere will write them.

DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER

static final String DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER

Tell Atmosphere to not write the access-control header. Default is false, e.g Atmosphere will write them.

BROADCASTER_LIFECYCLE_POLICY

static final String BROADCASTER_LIFECYCLE_POLICY

The BroadcasterLifeCyclePolicy policy to use

WEBSOCKET_PROCESSOR

static final String WEBSOCKET_PROCESSOR

Tell Atmosphere the WebSocketProcessor to use.

WEBSOCKET_PROTOCOL

static final String WEBSOCKET_PROTOCOL

Tell Atmosphere the WebSocketProcessor to use.

WEBSOCKET_CONTENT_TYPE

static final String WEBSOCKET_CONTENT_TYPE

Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest

See Also:

Constant Field Values

SSE_CONTENT_TYPE

static final String SSE_CONTENT_TYPE

Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest

See Also:

Constant Field Values

WEBSOCKET_METHOD

static final String WEBSOCKET_METHOD

Tell Atmosphere the method to use when a WebSocket message is dispatched as an AtmosphereRequest

See Also:

Constant Field Values

WEBSOCKET_IDLETIME

static final String WEBSOCKET_IDLETIME

Tell Atmosphere how long a WebSocket connection can stay idle. Default is 5 minutes

See Also:

Constant Field Values

WEBSOCKET_BUFFER_SIZE

static final String WEBSOCKET_BUFFER_SIZE

Tell Atmosphere the WebSocket write buffer size. Default is 8192

See Also:

Constant Field Values

WEBSOCKET_PATH_DELIMITER

static final String WEBSOCKET_PATH_DELIMITER

Tell Atmosphere the path delimiter to use when a WebSocket message contains the path as it first line. The value is used to create a HttpServletRequest.

See Also:

Constant Field Values

WEBSOCKET_MAXTEXTSIZE

static final String WEBSOCKET_MAXTEXTSIZE

Set the WebSocket mas text size: size<0 No aggregation of frames to messages, >=0 max size of text frame aggregation buffer in characters

See Also:

Constant Field Values

WEBSOCKET_MAXBINARYSIZE

static final String WEBSOCKET_MAXBINARYSIZE

Set the WebSocket mas text size: size<0 No aggregation of frames to messages, >=0 max size of text frame aggregation buffer in characters

See Also:

Constant Field Values

ATMOSPHERE_RESOURCE

static final String ATMOSPHERE_RESOURCE

The Atmosphere resource to use.

BROADCAST_FILTER_CLASSES

static final String BROADCAST_FILTER_CLASSES

A list of BroadcastFilter separated with coma that will be added to every new Broadcaster

RESUME_AND_KEEPALIVE

static final String RESUME_AND_KEEPALIVE

A request attribute used to tell AsyncSupport implementation to keep alive the connection or not. Default is to delegate the talk to the underlying WebServer.

See Also:

Constant Field Values

RESUMED_ON_TIMEOUT

static final String RESUMED_ON_TIMEOUT

A request attribute telling a AsyncSupport if the AtmosphereResource was resumed on timeout or by an application. This attribute is for WebServer that doesn't support times out (like Jetty 6)

See Also:

Constant Field Values

DISABLE_ONSTATE_EVENT

static final String DISABLE_ONSTATE_EVENT

Disable invoking AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) when the connection times out or get cancelled

See Also:

Constant Field Values

MAX_INACTIVE

static final String MAX_INACTIVE

The maximum time, in milisecond, a connection gets idle. This properly can be used with Jetty and BlockingIOCometSupport. Other WebServer supports detection of idle connection (idle or remotely closed)

See Also:

Constant Field Values

ALLOW_QUERYSTRING_AS_REQUEST

static final String ALLOW_QUERYSTRING_AS_REQUEST

Allow query string as set as request's header.

STREAMING_PADDING_MODE

static final String STREAMING_PADDING_MODE

Configure the padding used when streaming is used. Value can be atmosphere or whitespace. Default is ATMOSPHERE org.atmosphere.cpr.AtmosphereResourceImpl#createStreamingPadding(String) ()}

BROADCASTER_SHARABLE_THREAD_POOLS

static final String BROADCASTER_SHARABLE_THREAD_POOLS

Configure Broadcaster to share the same ExecutorService instead among them. Default is false.

BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE

static final String BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE

The maximum number of Thread created when processing broadcast operations BroadcasterConfig.setExecutorService(java.util.concurrent.ExecutorService)

BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE

static final String BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE

The maximum number of Thread created when writing requests BroadcasterConfig.setAsyncWriteService(java.util.concurrent.ExecutorService)

BROADCASTER_LIFECYCLE_POLICY_IDLETIME

static final String BROADCASTER_LIFECYCLE_POLICY_IDLETIME

BroadcasterLifecycle max idle time before executing. Default is 5 minutes

RECOVER_DEAD_BROADCASTER

static final String RECOVER_DEAD_BROADCASTER

Recover from a Broadcaster that has been destroyed. Default is true.

ATMOSPHERE_HANDLER

static final String ATMOSPHERE_HANDLER

Tell Atmosphere which AtmosphereHandler should be used. You can do the same using atmosphere.xml

ATMOSPHERE_HANDLER_MAPPING

static final String ATMOSPHERE_HANDLER_MAPPING

The AtmosphereHandler defined using the property will be mapped to that value. Same as atmosphere.xml

SERVLET_CLASS

static final String SERVLET_CLASS

The Servlet's name where Meteor will be available

See Also:

Constant Field Values

FILTER_CLASS

static final String FILTER_CLASS

The Filter's name where Meteor will be available

See Also:

Constant Field Values

MAPPING

static final String MAPPING

The Servlet's mapping value to the SERVLET_CLASS

See Also:

Constant Field Values

FILTER_NAME

static final String FILTER_NAME

The Servlet's mapping value to the FILTER_CLASS

See Also:

Constant Field Values

BROADCASTER_CACHE_STRATEGY

static final String BROADCASTER_CACHE_STRATEGY

Define when a broadcasted message is cached. Value can be 'beforeFilter' or 'afterFilter'. Default is afterFilter

SUPPORT_LOCATION_HEADER

static final String SUPPORT_LOCATION_HEADER

Support the Jersey location header for resuming. WARNING: this can cause memory leak if the connection is never resumed.

See Also:

Constant Field Values

WEB_SOCKET_BANNED_VERSION

static final String WEB_SOCKET_BANNED_VERSION

WebSocket version to exclude and downgrade to comet. Version are separated by comma

See Also:

Constant Field Values

TOMCAT_CLOSE_STREAM

static final String TOMCAT_CLOSE_STREAM

Prevent Tomcat from closing connection when inputStream#read() reach the end of the stream, as documented in the tomcat documentation

See Also:

Constant Field Values

WEBSOCKET_BINARY_WRITE

static final String WEBSOCKET_BINARY_WRITE

Write binary instead of String

See Also:

Constant Field Values

RECYCLE_ATMOSPHERE_REQUEST_RESPONSE

static final String RECYCLE_ATMOSPHERE_REQUEST_RESPONSE

Recycle (make them unusable) AtmosphereRequest/Response after wrapping a WebSocket message and delegating it to a Container

ATMOSPHERE_HANDLER_PATH

static final String ATMOSPHERE_HANDLER_PATH

The location of classes implementing the AtmosphereHandler interface. Default to "/WEB-INF/classes".

JERSEY_CONTAINER_RESPONSE_WRITER_CLASS

static final String JERSEY_CONTAINER_RESPONSE_WRITER_CLASS

Jersey's ContainerResponseWriter.

See Also:

Constant Field Values

WEBSOCKET_PROTOCOL_EXECUTION

static final String WEBSOCKET_PROTOCOL_EXECUTION

Execute the WebSocketProtocol.onMessage(org.atmosphere.websocket.WebSocket, byte[], int, int)

DEFAULT_CONTENT_TYPE

static final String DEFAULT_CONTENT_TYPE

The default content-type value used when Atmosphere requires one. Default is text/plain.

USE_SERVLET_WRAPPER

static final String USE_SERVLET_WRAPPER

Wrap the request/response with associated HttpServletRequest and HttpServletResponse

ATMOSPHERE_INTERCEPTORS

static final String ATMOSPHERE_INTERCEPTORS

A list of AtmosphereInterceptor class name that will be invoked before the AtmosphereResource gets delivered to an application or framework

ATMOSPHERE_EXCLUDED_FILE

static final String ATMOSPHERE_EXCLUDED_FILE

Regex pattern for excluding file from being serviced by AtmosphereFilter

MESSAGE_DELIMITER

static final String MESSAGE_DELIMITER

The token used to separate broadcasted messages. This value is used by the client to parse several messages received in one chunk. Default is '<||>'

ATMOSPHERERESOURCE_INTERCEPTOR_METHOD

static final String ATMOSPHERERESOURCE_INTERCEPTOR_METHOD

The method used that trigger automatic management of AtmosphereResource when the AtmosphereResourceLifecycleInterceptor is used

DISABLE_ATMOSPHEREINTERCEPTOR

static final String DISABLE_ATMOSPHEREINTERCEPTOR

Disable au-discovery of pre-installed AtmosphereInterceptor

SHARED

static final String SHARED

Set to true if Atmosphere is used as a library and you don't want to destroy associated static factory when undeploying.

See Also:

Constant Field Values

SUSPENDED_ATMOSPHERE_RESOURCE_UUID

static final String SUSPENDED_ATMOSPHERE_RESOURCE_UUID

The suspended UUID of the suspended connection which is the same as HeaderConfig.X_ATMOSPHERE_TRACKING_ID but available to all transport.

HANDLER_MAPPING_REGEX

static final String HANDLER_MAPPING_REGEX

Change the default regex used when mapping AtmosphereHandler. Default is AtmosphereFramework.MAPPING_REGEX

ANNOTATION_PROCESSOR

static final String ANNOTATION_PROCESSOR

The annotation processor

ENDPOINT_MAPPER

static final String ENDPOINT_MAPPER

Definr an implementation of the EndpointMapper

EXCLUDED_CONTENT_TYPES

static final String EXCLUDED_CONTENT_TYPES

The list of content-type to exclude when delimiting message.

UNIQUE_UUID_WEBSOCKET

static final String UNIQUE_UUID_WEBSOCKET

Use a unique uuid for all WebSocket message delivered on the same connection.

OUT_OF_ORDER_BROADCAST

static final String OUT_OF_ORDER_BROADCAST

Set to true if order of message delivered to the client is not important