ApplicationConfig (atmosphere-runtime 2.0.12 API)

```
public interface ApplicationConfig
```
Web.xml init-param configuration supported by Atmosphere.

Author:

Jeanfrancois Arcand

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALLOW_QUERYSTRING_AS_REQUEST` Allow query string as set as request's header.
`static java.lang.String`	`ANNOTATION_PACKAGE` A list, separated by comma, of package name to scan when looking for Atmosphere's component annotated with Atmosphere's annotation.
`static java.lang.String`	`ANNOTATION_PROCESSOR` The annotation processor.
`static java.lang.String`	`ATMOSPHERE_EXCLUDED_FILE` Regex pattern for excluding file from being serviced by `AtmosphereFilter`.
`static java.lang.String`	`ATMOSPHERE_HANDLER` Tell Atmosphere which AtmosphereHandler should be used.
`static java.lang.String`	`ATMOSPHERE_HANDLER_MAPPING` The AtmosphereHandler defined using the property will be mapped to that value.
`static java.lang.String`	`ATMOSPHERE_HANDLER_PATH` The location of classes implementing the `AtmosphereHandler` interface.
`static java.lang.String`	`ATMOSPHERE_INTERCEPTORS` A list of `AtmosphereInterceptor` class name that will be invoked before the `AtmosphereResource` gets delivered to an application or framework.
`static java.lang.String`	`ATMOSPHERE_RESOURCE` The `AtmosphereResource`.
`static java.lang.String`	`ATMOSPHERERESOURCE_INTERCEPTOR_METHOD` The method used that trigger automatic management of `AtmosphereResource` when the `AtmosphereResourceLifecycleInterceptor` is used.
`static java.lang.String`	`ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT` The timeout, in second, for configuring the time an AtmosphereResource is suspended.
`static java.lang.String`	`BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR` Before 1.0.12, WebSocket's AtmosphereResource manually added to `Broadcaster` were added without checking if the parent, e.g the AtmosphereResource's created on the first request was already added to the Broadcaster.
`static java.lang.String`	`BROADCAST_FILTER_CLASSES` A list of `BroadcastFilter` separated by comma that will be added to every new `Broadcaster`.
`static java.lang.String`	`BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE` The maximum number of Thread created when writing requests `BroadcasterConfig.setAsyncWriteService(java.util.concurrent.ExecutorService)`.
`static java.lang.String`	`BROADCASTER_CACHE` The default `BroadcasterCache` class.
`static java.lang.String`	`BROADCASTER_CACHE_STRATEGY` Define when a broadcasted message is cached.
`static java.lang.String`	`BROADCASTER_CLASS` The default `Broadcaster` class.
`static java.lang.String`	`BROADCASTER_FACTORY` The default `BroadcasterFactory` class.
`static java.lang.String`	`BROADCASTER_LIFECYCLE_POLICY` The `BroadcasterLifeCyclePolicy` policy to use.
`static java.lang.String`	`BROADCASTER_LIFECYCLE_POLICY_IDLETIME` BroadcasterLifecycle max idle time before executing.
`static java.lang.String`	`BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE` The maximum number of Thread created when processing broadcast operations `BroadcasterConfig.setExecutorService(java.util.concurrent.ExecutorService)`.
`static java.lang.String`	`BROADCASTER_POLICY` Allow defining the Broadcaster's Suspend Policy `Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY)`.
`static java.lang.String`	`BROADCASTER_POLICY_TIMEOUT` Allow defining the Broadcaster's maximum Suspended Atmosphere Policy `Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY)`.
`static java.lang.String`	`BROADCASTER_SHARABLE_THREAD_POOLS` Configure `Broadcaster` to share the same `ExecutorService` among them.
`static java.lang.String`	`BROADCASTER_WAIT_TIME` The sleep time, in millisecond, before the `DefaultBroadcaster` release its reactive thread for pushing message and execute async write.
`static java.lang.String`	`BUILT_IN_SESSION` Use a build in `HttpSession` when using native WebSocket implementation.
`static java.lang.String`	`CUSTOM_ANNOTATION_PACKAGE` A list, separated by comma, of package name to scan when looking for @AtmosphereAnnotation custom Annotation.
`static java.lang.String`	`DEFAULT_CONTENT_TYPE` The default content-type value used when Atmosphere requires one.
`static java.lang.String`	`DEFAULT_NAMED_DISPATCHER` The default Servlet used when forwarding request.
`static java.lang.String`	`DISABLE_ATMOSPHEREINTERCEPTOR` Disable au-discovery of pre-installed `AtmosphereInterceptor`s.
`static java.lang.String`	`DISABLE_ONSTATE_EVENT` Disable invoking `AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent)` when the connection times out or get cancelled.
`static java.lang.String`	`DISALLOW_MODIFY_QUERYSTRING` Disallow Atmosphere to modify the query string of incoming connections.
`static java.lang.String`	`DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER` Tell Atmosphere to not write the access-control header.
`static java.lang.String`	`ENDPOINT_MAPPER` Define an implementation of the `EndpointMapper`.
`static java.lang.String`	`EXCLUDED_CONTENT_TYPES` The list of content-type to exclude when delimiting message.
`static java.lang.String`	`FILTER_CLASS` The Filter's name where `Meteor` will be available.
`static java.lang.String`	`FILTER_NAME` The Servlet's mapping value to the FILTER_CLASS.
`static java.lang.String`	`HANDLER_MAPPING_REGEX` Change the default regex used when mapping AtmosphereHandler.
`static java.lang.String`	`JERSEY_CONTAINER_RESPONSE_WRITER_CLASS` Jersey's ContainerResponseWriter.
`static java.lang.String`	`JETTY_WEBSOCKET_MIN_VERSION` Set the minimum WebSocket version that Jetty should accept.
`static java.lang.String`	`JSR356_MAPPING_PATH` The JSR 356 WebSocket root path.
`static java.lang.String`	`JSR356_PATH_MAPPING_LENGTH` jsr356 Path mapping length for add(ServerEndpointConfig.Builder.create(JSR356Endpoint.class, "/{path}/{path/...}").
`static java.lang.String`	`MAPPING` The Servlet's mapping value to the SERVLET_CLASS.
`static java.lang.String`	`MAX_INACTIVE` The maximum time, in milliseconds, a connection gets idle.
`static java.lang.String`	`MESSAGE_DELIMITER` The token used to separate broadcasted messages.
`static java.lang.String`	`NO_CACHE_HEADERS` Tell Atmosphere to not write the no-cache header.
`static java.lang.String`	`OUT_OF_ORDER_BROADCAST` Set to true if order of message delivered to the client is not important.
`static java.lang.String`	`PROPERTY_ATMOSPHERE_XML` The location of the atmosphere.xml file.
`static java.lang.String`	`PROPERTY_BLOCKING_COMETSUPPORT` Set Atmosphere to use the `BlockingIOCometSupport`, e.g blocking I/O.
`static java.lang.String`	`PROPERTY_COMET_SUPPORT` Tell Atmosphere which `AsyncSupport` implementation to use.
`static java.lang.String`	`PROPERTY_NATIVE_COMETSUPPORT` Set Atmosphere to use the container native Comet support.
`static java.lang.String`	`PROPERTY_SERVLET_MAPPING` The path that will be used to map request to Jersey.
`static java.lang.String`	`PROPERTY_SESSION_SUPPORT` Tell Atmosphere to use `HttpSession`.
`static java.lang.String`	`PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST` Set Atmosphere to throw exception on cloned request
`static java.lang.String`	`PROPERTY_USE_STREAM` Force Atmosphere to use stream when writing bytes.
`static java.lang.String`	`RECOVER_DEAD_BROADCASTER` Recover from a `Broadcaster` that has been destroyed.
`static java.lang.String`	`RECYCLE_ATMOSPHERE_REQUEST_RESPONSE` Recycle (make them unusable) AtmosphereRequest/Response after wrapping a WebSocket message and delegating it to a Container.
`static java.lang.String`	`RESUME_AND_KEEPALIVE` A request attribute used to tell `AsyncSupport` implementation to keep alive the connection or not.
`static java.lang.String`	`RESUME_ON_BROADCAST` Force Atmosphere to invoke `AtmosphereResource.resume()` after the first `Broadcaster.broadcast(Object)` invocation.
`static java.lang.String`	`RESUMED_ON_TIMEOUT` A request attribute telling a `AsyncSupport` if the AtmosphereResource was resumed on timeout or by an application.
`static java.lang.String`	`SCAN_CLASSPATH` Set to false if you want Atmosphere to scan the entire classpath looking for annotation.
`static java.lang.String`	`SERVLET_CLASS` The Servlet's name where `Meteor` will be available.
`static java.lang.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 java.lang.String`	`SSE_CONTENT_TYPE` Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest.
`static java.lang.String`	`SSE_DEFAULT_CONTENTTYPE` Default Server Side Event content type.
`static java.lang.String`	`STATE_RECOVERY_TIMEOUT` The timeout, in milliseconds, before an `AtmosphereResource`'s state get discarded.
`static java.lang.String`	`SUPPORT_LOCATION_HEADER` Support the Jersey location header for resuming.
`static java.lang.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 java.lang.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 java.lang.String`	`UNIQUE_UUID_WEBSOCKET` Use a unique UUID for all WebSocket message delivered on the same connection.
`static java.lang.String`	`WEB_SOCKET_BANNED_VERSION` WebSocket version to exclude and downgrade to comet.
`static java.lang.String`	`WEBSOCKET_BINARY_WRITE` Write binary instead of String.
`static java.lang.String`	`WEBSOCKET_BUFFER_SIZE` Tell Atmosphere the WebSocket write buffer size.
`static java.lang.String`	`WEBSOCKET_CONTENT_TYPE` Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest.
`static java.lang.String`	`WEBSOCKET_IDLETIME` Tell Atmosphere how long a WebSocket connection can stay idle.
`static java.lang.String`	`WEBSOCKET_MAXBINARYSIZE` Set the WebSocket max text size.
`static java.lang.String`	`WEBSOCKET_MAXTEXTSIZE` Set the WebSocket max text size.
`static java.lang.String`	`WEBSOCKET_METHOD` Tell Atmosphere the method to use when a WebSocket message is dispatched as an AtmosphereRequest.
`static java.lang.String`	`WEBSOCKET_PATH_DELIMITER` Tell Atmosphere the path delimiter to use when a WebSocket message contains the path as it first line.
`static java.lang.String`	`WEBSOCKET_PROCESSOR` Tell Atmosphere the `WebSocketProcessor` to use.
`static java.lang.String`	`WEBSOCKET_PROTOCOL` Tell Atmosphere the `WebSocketProtocol` to use.
`static java.lang.String`	`WEBSOCKET_PROTOCOL_EXECUTION` Execute the `WebSocketProtocol.onMessage(org.atmosphere.websocket.WebSocket, byte[], int, int)`.
`static java.lang.String`	`WEBSOCKET_REQUIRE_SAME_ORIGIN` Tell Atmosphere to enforce the same origin policy for all incoming WebSocket handshakes.
`static java.lang.String`	`WEBSOCKET_SUPPORT` Force Atmosphere to use WebSocket.
`static java.lang.String`	`WEBSOCKET_SUPPORT_SERVLET3` Force Atmosphere to use WebSocket + Servlet 3.0 API.
`static java.lang.String`	`WRITE_TIMEOUT` The write operation timeout, in millisecond, when using the `DefaultBroadcaster`.

- Field Detail
  - PROPERTY_ATMOSPHERE_XML
```
static final java.lang.String PROPERTY_ATMOSPHERE_XML
```
    The location of the atmosphere.xml file.
    Default: META-INF/
    Value: org.atmosphere.atmosphereDotXml
    
    See Also:
    Constant Field Values
  - PROPERTY_SERVLET_MAPPING
```
static final java.lang.String PROPERTY_SERVLET_MAPPING
```
    The path that will be used to map request to Jersey.
    Default: ""
    Value: org.atmosphere.jersey.servlet-mapping
    
    See Also:
    Constant Field Values
  - PROPERTY_BLOCKING_COMETSUPPORT
```
static final java.lang.String PROPERTY_BLOCKING_COMETSUPPORT
```
    Set Atmosphere to use the BlockingIOCometSupport, e.g blocking I/O.
    Default: false
    
    Value: org.atmosphere.useBlocking
    
    See Also:
    Constant Field Values
  - PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST
```
static final java.lang.String PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST
```
    Set Atmosphere to throw exception on cloned request
    Default: false
    Value: org.atmosphere.throwExceptionOnClonedRequest
    
    See Also:
    Constant Field Values
  - PROPERTY_NATIVE_COMETSUPPORT
```
static final java.lang.String PROPERTY_NATIVE_COMETSUPPORT
```
    Set Atmosphere to use the container native Comet support.
    Default: false
    Value: org.atmosphere.useNative
    
    See Also:
    Constant Field Values
  - WEBSOCKET_SUPPORT
```
static final java.lang.String WEBSOCKET_SUPPORT
```
    Force Atmosphere to use WebSocket.
    Default: true
    Value: org.atmosphere.useWebSocket
    
    See Also:
    Constant Field Values
  - WEBSOCKET_SUPPORT_SERVLET3
```
static final java.lang.String WEBSOCKET_SUPPORT_SERVLET3
```
    Force Atmosphere to use WebSocket + Servlet 3.0 API.
    Default: false
    Value: org.atmosphere.useWebSocketAndServlet3
    
    See Also:
    Constant Field Values
  - PROPERTY_USE_STREAM
```
static final java.lang.String PROPERTY_USE_STREAM
```
    Force Atmosphere to use stream when writing bytes.
    Default: true
    Value: org.atmosphere.useStream
    
    See Also:
    Constant Field Values
  - BROADCASTER_FACTORY
```
static final java.lang.String BROADCASTER_FACTORY
```
    The default BroadcasterFactory class.
    Default: org.atmosphere.cpr.DefaultBroadcasterFactory
    Value: org.atmosphere.cpr.broadcasterFactory
  - BROADCASTER_CLASS
```
static final java.lang.String BROADCASTER_CLASS
```
    The default Broadcaster class.
    Default: org.atmosphere.cpr.DefaultBroadcaster
    Value: org.atmosphere.cpr.broadcasterClass
  - BROADCASTER_CACHE
```
static final java.lang.String BROADCASTER_CACHE
```
    The default BroadcasterCache class.
    Default: "" (Not installed by default)
    Value: org.atmosphere.cpr.broadcasterCacheClass
  - PROPERTY_COMET_SUPPORT
```
static final java.lang.String PROPERTY_COMET_SUPPORT
```
    Tell Atmosphere which AsyncSupport implementation to use.
    Default: "" (Auto detected by Atmosphere)
    Value: org.atmosphere.cpr.asyncSupport
  - PROPERTY_SESSION_SUPPORT
```
static final java.lang.String PROPERTY_SESSION_SUPPORT
```
    Tell Atmosphere to use HttpSession.
    Default: false
    Value: org.atmosphere.cpr.sessionSupport
  - RESUME_ON_BROADCAST
```
static final java.lang.String RESUME_ON_BROADCAST
```
    Force Atmosphere to invoke AtmosphereResource.resume() after the first Broadcaster.broadcast(Object) invocation.
    Default: false
    Value: org.atmosphere.resumeOnBroadcast
    
    See Also:
    Constant Field Values
  - DEFAULT_NAMED_DISPATCHER
```
static final java.lang.String DEFAULT_NAMED_DISPATCHER
```
    The default Servlet used when forwarding request.
    Default: default
    Value: default
    
    See Also:
    Constant Field Values
  - NO_CACHE_HEADERS
```
static final java.lang.String NO_CACHE_HEADERS
```
    Tell Atmosphere to not write the no-cache header. Default is false, e.g Atmosphere will write them.
    Default: false
    Value: org.atmosphere.cpr.noCacheHeaders
  - DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER
```
static final java.lang.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.
    Default: false
    Value: org.atmosphere.cpr.dropAccessControlAllowOriginHeader
  - BROADCASTER_LIFECYCLE_POLICY
```
static final java.lang.String BROADCASTER_LIFECYCLE_POLICY
```
    The BroadcasterLifeCyclePolicy policy to use.
    Default: BroadcasterLifeCyclePolicy.NEVER
    Value: org.atmosphere.cpr.broadcasterLifeCyclePolicy
  - WEBSOCKET_PROCESSOR
```
static final java.lang.String WEBSOCKET_PROCESSOR
```
    Tell Atmosphere the WebSocketProcessor to use.
    Default: org.atmosphere.websocket.DefaultWebSocketProcessor
    Value: org.atmosphere.websocket.WebSocketProcessor
  - WEBSOCKET_PROTOCOL
```
static final java.lang.String WEBSOCKET_PROTOCOL
```
    Tell Atmosphere the WebSocketProtocol to use.
    Default: org.atmosphere.websocket.SimpleHttpProtocol
    Value: org.atmosphere.websocket.WebSocketProtocol
  - WEBSOCKET_CONTENT_TYPE
```
static final java.lang.String WEBSOCKET_CONTENT_TYPE
```
    Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest.
    Default: text/plain
    Value: org.atmosphere.websocket.messageContentType
    
    See Also:
    Constant Field Values
  - SSE_CONTENT_TYPE
```
static final java.lang.String SSE_CONTENT_TYPE
```
    Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest.
    Default: text/event-stream
    Value: org.atmosphere.sse.contentType
    
    See Also:
    Constant Field Values
  - WEBSOCKET_METHOD
```
static final java.lang.String WEBSOCKET_METHOD
```
    Tell Atmosphere the method to use when a WebSocket message is dispatched as an AtmosphereRequest.
    Default: POST
    Value: org.atmosphere.websocket.messageMethod
    
    See Also:
    Constant Field Values
  - WEBSOCKET_IDLETIME
```
static final java.lang.String WEBSOCKET_IDLETIME
```
    Tell Atmosphere how long a WebSocket connection can stay idle.
    Default: 5 minutes
    Value: org.atmosphere.websocket.maxIdleTime
    
    See Also:
    Constant Field Values
  - WEBSOCKET_BUFFER_SIZE
```
static final java.lang.String WEBSOCKET_BUFFER_SIZE
```
    Tell Atmosphere the WebSocket write buffer size.
    Default: 8192
    Value: org.atmosphere.websocket.bufferSize
    
    See Also:
    Constant Field Values
  - WEBSOCKET_PATH_DELIMITER
```
static final java.lang.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.
    Default: ""
    Value: org.atmosphere.websocket.pathDelimiter
    
    See Also:
    Constant Field Values
  - WEBSOCKET_MAXTEXTSIZE
```
static final java.lang.String WEBSOCKET_MAXTEXTSIZE
```
    Set the WebSocket max text size. Size lower than 0: no aggregation of frames to messages, larger than 0: max size of text frame aggregation buffer in characters
    Default: 8192
    Value: org.atmosphere.websocket.maxTextMessageSize
    
    See Also:
    Constant Field Values
  - WEBSOCKET_MAXBINARYSIZE
```
static final java.lang.String WEBSOCKET_MAXBINARYSIZE
```
    Set the WebSocket max text size. Size < 0: no aggregation of frames to messages, size >=0: max size of text frame aggregation buffer in characters
    Default: 8192
    Value: org.atmosphere.websocket.maxBinaryMessageSize
    
    See Also:
    Constant Field Values
  - WEBSOCKET_REQUIRE_SAME_ORIGIN
```
static final java.lang.String WEBSOCKET_REQUIRE_SAME_ORIGIN
```
    Tell Atmosphere to enforce the same origin policy for all incoming WebSocket handshakes.
    Default: true
    Value: org.atmosphere.websocket.requireSameOrigin
    
    See Also:
    Constant Field Values
  - JETTY_WEBSOCKET_MIN_VERSION
```
static final java.lang.String JETTY_WEBSOCKET_MIN_VERSION
```
    Set the minimum WebSocket version that Jetty should accept. If not set, Jetty defaults to version 13 (RFC6455).
    Jetty 7 and 8 is able to support buggy pre-draft versions of WebSocket. Set to 0 or -1 to let Jetty support all accept all supported versions.
    Default: [nothing]
    Value: org.atmosphere.websocket.jetty.minVersion
    
    See Also:
    Constant Field Values
  - ATMOSPHERE_RESOURCE
```
static final java.lang.String ATMOSPHERE_RESOURCE
```
    The AtmosphereResource.
    Default: org.atmosphere.cpr.AtmosphereResourceImpl
    Value: org.atmosphere.cpr.AtmosphereResource
  - BROADCAST_FILTER_CLASSES
```
static final java.lang.String BROADCAST_FILTER_CLASSES
```
    A list of BroadcastFilter separated by comma that will be added to every new Broadcaster.
    Default: ""
    Value: org.atmosphere.cpr.broadcastFilterClasses
  - RESUME_AND_KEEPALIVE
```
static final java.lang.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.
    Default: false (to delegate the talk to the underlying WebServer)
    Value: org.atmosphere.cpr.AtmosphereServlet.resumeAndKeepAlive
    
    See Also:
    Constant Field Values
  - RESUMED_ON_TIMEOUT
```
static final java.lang.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 time-outs (like Jetty 6)
    Default: false
    Value: org.atmosphere.cpr.AtmosphereServlet.resumedOnTimeout
    
    See Also:
    Constant Field Values
  - DISABLE_ONSTATE_EVENT
```
static final java.lang.String DISABLE_ONSTATE_EVENT
```
    Disable invoking AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) when the connection times out or get cancelled.
    Default: false
    Value: org.atmosphere.disableOnStateEvent
    
    See Also:
    Constant Field Values
  - MAX_INACTIVE
```
static final java.lang.String MAX_INACTIVE
```
    The maximum time, in milliseconds, a connection gets idle. This property can be used with Jetty and BlockingIOCometSupport. Other WebServers support detection of idle connection (idle or remotely closed)
    Default: -1 (disabled)
    Value: org.atmosphere.cpr.CometSupport.maxInactiveActivity
    
    See Also:
    Constant Field Values
  - ALLOW_QUERYSTRING_AS_REQUEST
```
static final java.lang.String ALLOW_QUERYSTRING_AS_REQUEST
```
    Allow query string as set as request's header.
    Default: true
    Value: org.atmosphere.cpr.allowQueryStreamAsPostOrGet
  - DISALLOW_MODIFY_QUERYSTRING
```
static final java.lang.String DISALLOW_MODIFY_QUERYSTRING
```
    Disallow Atmosphere to modify the query string of incoming connections.
    In some cases the Atmosphere javascript client attaches request headers as query string parameters. The default Atmosphere behaviour is to parse the query string and remove the Atmosphere parameters from the query string. This behaviour breaks at least WebSocket draft-00 / hixie-76, but by setting this value to true the query string is never modified by Atmosphere.
    Default: false
    Value: org.atmosphere.cpr.disallowModifyQueryString
  - BROADCASTER_SHARABLE_THREAD_POOLS
```
static final java.lang.String BROADCASTER_SHARABLE_THREAD_POOLS
```
    Configure Broadcaster to share the same ExecutorService among them.
    Default: true
    Value: org.atmosphere.cpr.broadcaster.shareableThreadPool
  - BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE
```
static final java.lang.String BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE
```
    The maximum number of Thread created when processing broadcast operations BroadcasterConfig.setExecutorService(java.util.concurrent.ExecutorService).
    Default: unlimited
    Value: org.atmosphere.cpr.broadcaster.maxProcessingThreads
  - BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE
```
static final java.lang.String BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE
```
    The maximum number of Thread created when writing requests BroadcasterConfig.setAsyncWriteService(java.util.concurrent.ExecutorService).
    Default: unlimited
    Value: org.atmosphere.cpr.broadcaster.maxAsyncWriteThreads
  - BROADCASTER_LIFECYCLE_POLICY_IDLETIME
```
static final java.lang.String BROADCASTER_LIFECYCLE_POLICY_IDLETIME
```
    BroadcasterLifecycle max idle time before executing.
    Default: 5 minutes
    Value: org.atmosphere.cpr.maxBroadcasterLifeCyclePolicyIdleTime
  - RECOVER_DEAD_BROADCASTER
```
static final java.lang.String RECOVER_DEAD_BROADCASTER
```
    Recover from a Broadcaster that has been destroyed.
    Default: true
    Value: org.atmosphere.cpr.recoverFromDestroyedBroadcaster
  - ATMOSPHERE_HANDLER
```
static final java.lang.String ATMOSPHERE_HANDLER
```
    Tell Atmosphere which AtmosphereHandler should be used. You can do the same using atmosphere.xml
    Default: ""
    Value: org.atmosphere.cpr.AtmosphereHandler
  - ATMOSPHERE_HANDLER_MAPPING
```
static final java.lang.String ATMOSPHERE_HANDLER_MAPPING
```
    The AtmosphereHandler defined using the property will be mapped to that value. Same as atmosphere.xml
    Default: true
    Value: org.atmosphere.cpr.AtmosphereHandler.contextRoot
  - SERVLET_CLASS
```
static final java.lang.String SERVLET_CLASS
```
    The Servlet's name where Meteor will be available.
    Default: ""
    Value: org.atmosphere.servlet
    
    See Also:
    Constant Field Values
  - FILTER_CLASS
```
static final java.lang.String FILTER_CLASS
```
    The Filter's name where Meteor will be available.
    Default: ""
    Value: org.atmosphere.filter
    
    See Also:
    Constant Field Values
  - MAPPING
```
static final java.lang.String MAPPING
```
    The Servlet's mapping value to the SERVLET_CLASS.
    Default: ""
    Value: org.atmosphere.mapping
    
    See Also:
    Constant Field Values
  - FILTER_NAME
```
static final java.lang.String FILTER_NAME
```
    The Servlet's mapping value to the FILTER_CLASS.
    Default: ""
    Value: org.atmosphere.filter.name
    
    See Also:
    Constant Field Values
  - BROADCASTER_CACHE_STRATEGY
```
static final java.lang.String BROADCASTER_CACHE_STRATEGY
```
    Define when a broadcasted message is cached. Value can be 'beforeFilter' or 'afterFilter'.
    Default: afterFilter
    Value: org.atmosphere.cpr.BroadcasterCache.strategy
  - SUPPORT_LOCATION_HEADER
```
static final java.lang.String SUPPORT_LOCATION_HEADER
```
    Support the Jersey location header for resuming. WARNING: this can cause memory leak if the connection is never resumed.
    Default: false
    Value: org.atmosphere.jersey.supportLocationHeader
    
    See Also:
    Constant Field Values
  - WEB_SOCKET_BANNED_VERSION
```
static final java.lang.String WEB_SOCKET_BANNED_VERSION
```
    WebSocket version to exclude and downgrade to comet. Versions are separated by comma.
    Default: ""
    Value: org.atmosphere.websocket.bannedVersion
    
    See Also:
    Constant Field Values
  - TOMCAT_CLOSE_STREAM
```
static final java.lang.String TOMCAT_CLOSE_STREAM
```
    Prevent Tomcat from closing connection when inputStream#read() reach the end of the stream, as documented in the tomcat documentation.
    Default: true
    Value: org.atmosphere.container.TomcatCometSupport.discardEOF
    
    See Also:
    Constant Field Values
  - WEBSOCKET_BINARY_WRITE
```
static final java.lang.String WEBSOCKET_BINARY_WRITE
```
    Write binary instead of String.
    Default: false
    Value: org.atmosphere.websocket.binaryWrite
    
    See Also:
    Constant Field Values
  - RECYCLE_ATMOSPHERE_REQUEST_RESPONSE
```
static final java.lang.String RECYCLE_ATMOSPHERE_REQUEST_RESPONSE
```
    Recycle (make them unusable) AtmosphereRequest/Response after wrapping a WebSocket message and delegating it to a Container.
    Default: false
    Value: org.atmosphere.cpr.recycleAtmosphereRequestResponse
  - ATMOSPHERE_HANDLER_PATH
```
static final java.lang.String ATMOSPHERE_HANDLER_PATH
```
    The location of classes implementing the AtmosphereHandler interface.
    Default: "/WEB-INF/classes".
    Value: org.atmosphere.cpr.atmosphereHandlerPath
  - JERSEY_CONTAINER_RESPONSE_WRITER_CLASS
```
static final java.lang.String JERSEY_CONTAINER_RESPONSE_WRITER_CLASS
```
    Jersey's ContainerResponseWriter.
    Default: ""
    Value: org.atmosphere.jersey.containerResponseWriterClass
    
    See Also:
    Constant Field Values
  - WEBSOCKET_PROTOCOL_EXECUTION
```
static final java.lang.String WEBSOCKET_PROTOCOL_EXECUTION
```
    Execute the WebSocketProtocol.onMessage(org.atmosphere.websocket.WebSocket, byte[], int, int).
    Default: false
    Value: org.atmosphere.websocket.WebSocketProtocol.executeAsync
  - DEFAULT_CONTENT_TYPE
```
static final java.lang.String DEFAULT_CONTENT_TYPE
```
    The default content-type value used when Atmosphere requires one.
    Default: "text/plain"
    Value: org.atmosphere.cpr.defaultContentType
  - ATMOSPHERE_INTERCEPTORS
```
static final java.lang.String ATMOSPHERE_INTERCEPTORS
```
    A list of AtmosphereInterceptor class name that will be invoked before the AtmosphereResource gets delivered to an application or framework.
    Default: ""
    Value: org.atmosphere.cpr.AtmosphereInterceptor
  - ATMOSPHERE_EXCLUDED_FILE
```
static final java.lang.String ATMOSPHERE_EXCLUDED_FILE
```
    Regex pattern for excluding file from being serviced by AtmosphereFilter.
    Default: AtmosphereFilter.EXCLUDE_FILES
    Value: org.atmosphere.cpr.AtmosphereFilter.excludes
  - MESSAGE_DELIMITER
```
static final java.lang.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: "|"
    Value: org.atmosphere.client.TrackMessageSizeInterceptor.delimiter
  - ATMOSPHERERESOURCE_INTERCEPTOR_METHOD
```
static final java.lang.String ATMOSPHERERESOURCE_INTERCEPTOR_METHOD
```
    The method used that trigger automatic management of AtmosphereResource when the AtmosphereResourceLifecycleInterceptor is used.
    Default: "GET"
    Value: org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor.method
  - ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT
```
static final java.lang.String ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT
```
    The timeout, in second, for configuring the time an AtmosphereResource is suspended. Same as AtmosphereResource.suspend(long, java.util.concurrent.TimeUnit) when the AtmosphereResourceLifecycleInterceptor is used.
    Default: "-1"
    Value: org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor.timeout
  - DISABLE_ATMOSPHEREINTERCEPTOR
```
static final java.lang.String DISABLE_ATMOSPHEREINTERCEPTOR
```
    Disable au-discovery of pre-installed AtmosphereInterceptors.
    Default: false
    Value: org.atmosphere.cpr.AtmosphereInterceptor.disableDefaults
  - SHARED
```
static final java.lang.String SHARED
```
    Set to true if Atmosphere is used as a library and you don't want to destroy associated static factory when undeploying.
    Default: false
    Value: org.atmosphere.runtime.shared
    
    See Also:
    Constant Field Values
  - SUSPENDED_ATMOSPHERE_RESOURCE_UUID
```
static final java.lang.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.
    Value: org.atmosphere.cpr.AtmosphereResource.suspended.uuid
  - UNIQUE_UUID_WEBSOCKET
```
static final java.lang.String UNIQUE_UUID_WEBSOCKET
```
    Use a unique UUID for all WebSocket message delivered on the same connection.
    Default: true
    Value: org.atmosphere.cpr.AtmosphereResource.uniqueUUID
  - OUT_OF_ORDER_BROADCAST
```
static final java.lang.String OUT_OF_ORDER_BROADCAST
```
    Set to true if order of message delivered to the client is not important.
    Default: false
    Value: org.atmosphere.cpr.Broadcaster.supportOutOfOrderBroadcast
  - WRITE_TIMEOUT
```
static final java.lang.String WRITE_TIMEOUT
```
    The write operation timeout, in millisecond, when using the DefaultBroadcaster. When the timeout occurs, the calling thread gets interrupted.
    Default: 5 * 60 * 1000 (5 minutes)
    Value: org.atmosphere.cpr.Broadcaster.writeTimeout
  - BROADCASTER_WAIT_TIME
```
static final java.lang.String BROADCASTER_WAIT_TIME
```
    The sleep time, in millisecond, before the DefaultBroadcaster release its reactive thread for pushing message and execute async write. Setting this value too high may create too many threads.
    Default: 1000
    Value: org.atmosphere.cpr.Broadcaster.threadWaitTime
  - BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR
```
static final java.lang.String BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR
```
    Before 1.0.12, WebSocket's AtmosphereResource manually added to Broadcaster were added without checking if the parent, e.g the AtmosphereResource's created on the first request was already added to the Broadcaster. That caused some messages to be written twice instead of once.
    Default: false
    Value: org.atmosphere.websocket.backwardCompatible.atmosphereResource
    
    See Also:
    Constant Field Values
  - ANNOTATION_PACKAGE
```
static final java.lang.String ANNOTATION_PACKAGE
```
    A list, separated by comma, of package name to scan when looking for Atmosphere's component annotated with Atmosphere's annotation.
    Default: ""
    Value: org.atmosphere.cpr.packages
    
    See Also:
    Constant Field Values
  - ANNOTATION_PROCESSOR
```
static final java.lang.String ANNOTATION_PROCESSOR
```
    The annotation processor.
    Default: org.atmosphere.cpr.DefaultAnnotationProcessor
    Value: org.atmosphere.cpr.AnnotationProcessor
  - ENDPOINT_MAPPER
```
static final java.lang.String ENDPOINT_MAPPER
```
    Define an implementation of the EndpointMapper.
    Default: org.atmosphere.cpr.DefaultEndpointMapper
    Value: org.atmosphere.cpr.EndpointMapper
  - EXCLUDED_CONTENT_TYPES
```
static final java.lang.String EXCLUDED_CONTENT_TYPES
```
    The list of content-type to exclude when delimiting message.
    Default: ""
    Value: org.atmosphere.client.TrackMessageSizeInterceptor.excludedContentType
  - BROADCASTER_POLICY
```
static final java.lang.String BROADCASTER_POLICY
```
    Allow defining the Broadcaster's Suspend Policy Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY).
    Default: FIFO
    Value: org.atmosphere.cpr.Broadcaster.POLICY
  - BROADCASTER_POLICY_TIMEOUT
```
static final java.lang.String BROADCASTER_POLICY_TIMEOUT
```
    Allow defining the Broadcaster's maximum Suspended Atmosphere Policy Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY).
    Default: -1 (unlimited)
    Value: org.atmosphere.cpr.Broadcaster.POLICY.maximumSuspended
  - HANDLER_MAPPING_REGEX
```
static final java.lang.String HANDLER_MAPPING_REGEX
```
    Change the default regex used when mapping AtmosphereHandler. Default: AtmosphereFramework.MAPPING_REGEX
    Default: "[a-zA-Z0-9-&.*_=@;\?]+"
    Value: org.atmosphere.client.ApplicationConfig.mappingRegex
  - STATE_RECOVERY_TIMEOUT
```
static final java.lang.String STATE_RECOVERY_TIMEOUT
```
    The timeout, in milliseconds, before an AtmosphereResource's state get discarded.
    Default: 300000 (5 minutes)
    Value: org.atmosphere.interceptor.AtmosphereResourceStateRecovery.timeout
  - JSR356_PATH_MAPPING_LENGTH
```
static final java.lang.String JSR356_PATH_MAPPING_LENGTH
```
    jsr356 Path mapping length for add(ServerEndpointConfig.Builder.create(JSR356Endpoint.class, "/{path}/{path/...}"). Default: 5 Value: MUST be set using System's properties: org.atmosphere.cpr.jsr356.pathMappingLength"
  - SSE_DEFAULT_CONTENTTYPE
```
static final java.lang.String SSE_DEFAULT_CONTENTTYPE
```
    Default Server Side Event content type. Default: text/event-stream Value: org.atmosphere.interceptor.SSEAtmosphereInterceptor.contentType
  - CUSTOM_ANNOTATION_PACKAGE
```
static final java.lang.String CUSTOM_ANNOTATION_PACKAGE
```
    A list, separated by comma, of package name to scan when looking for @AtmosphereAnnotation custom Annotation.
    Default: ""
    Value: org.atmosphere.annotation.packages
    
    See Also:
    Constant Field Values
  - SCAN_CLASSPATH
```
static final java.lang.String SCAN_CLASSPATH
```
    Set to false if you want Atmosphere to scan the entire classpath looking for annotation.
    Default: true
    Value: org.atmosphere.cpr.scanClassPath
  - BUILT_IN_SESSION
```
static final java.lang.String BUILT_IN_SESSION
```
    Use a build in HttpSession when using native WebSocket implementation.
    Default: false
    Value: org.atmosphere.cpr.useBuildInSession
  - JSR356_MAPPING_PATH
```
static final java.lang.String JSR356_MAPPING_PATH
```
    The JSR 356 WebSocket root path. Use this property if more than one AtmosphereServlet gets deployed inside the same application, and the guessed mapping path is not the one expected.
    Default: ""
    Value: org.atmosphere.container.JSR356AsyncSupport.mappingPath

Interface ApplicationConfig

Field Summary

Field Detail

PROPERTY_ATMOSPHERE_XML

PROPERTY_SERVLET_MAPPING

PROPERTY_BLOCKING_COMETSUPPORT

PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST

PROPERTY_NATIVE_COMETSUPPORT

WEBSOCKET_SUPPORT

WEBSOCKET_SUPPORT_SERVLET3

PROPERTY_USE_STREAM

BROADCASTER_FACTORY

BROADCASTER_CLASS

BROADCASTER_CACHE

PROPERTY_COMET_SUPPORT

PROPERTY_SESSION_SUPPORT

RESUME_ON_BROADCAST

DEFAULT_NAMED_DISPATCHER

NO_CACHE_HEADERS

DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER

BROADCASTER_LIFECYCLE_POLICY

WEBSOCKET_PROCESSOR

WEBSOCKET_PROTOCOL

WEBSOCKET_CONTENT_TYPE

SSE_CONTENT_TYPE

WEBSOCKET_METHOD

WEBSOCKET_IDLETIME

WEBSOCKET_BUFFER_SIZE

WEBSOCKET_PATH_DELIMITER

WEBSOCKET_MAXTEXTSIZE

WEBSOCKET_MAXBINARYSIZE

WEBSOCKET_REQUIRE_SAME_ORIGIN

JETTY_WEBSOCKET_MIN_VERSION

ATMOSPHERE_RESOURCE

BROADCAST_FILTER_CLASSES

RESUME_AND_KEEPALIVE

RESUMED_ON_TIMEOUT

DISABLE_ONSTATE_EVENT

MAX_INACTIVE

ALLOW_QUERYSTRING_AS_REQUEST

DISALLOW_MODIFY_QUERYSTRING

BROADCASTER_SHARABLE_THREAD_POOLS

BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE

BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE

BROADCASTER_LIFECYCLE_POLICY_IDLETIME

RECOVER_DEAD_BROADCASTER

ATMOSPHERE_HANDLER

ATMOSPHERE_HANDLER_MAPPING

SERVLET_CLASS

FILTER_CLASS

MAPPING

FILTER_NAME

BROADCASTER_CACHE_STRATEGY

SUPPORT_LOCATION_HEADER

WEB_SOCKET_BANNED_VERSION

TOMCAT_CLOSE_STREAM

WEBSOCKET_BINARY_WRITE

RECYCLE_ATMOSPHERE_REQUEST_RESPONSE

ATMOSPHERE_HANDLER_PATH

JERSEY_CONTAINER_RESPONSE_WRITER_CLASS

WEBSOCKET_PROTOCOL_EXECUTION

DEFAULT_CONTENT_TYPE

ATMOSPHERE_INTERCEPTORS

ATMOSPHERE_EXCLUDED_FILE

MESSAGE_DELIMITER

ATMOSPHERERESOURCE_INTERCEPTOR_METHOD

ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT

DISABLE_ATMOSPHEREINTERCEPTOR

SHARED

SUSPENDED_ATMOSPHERE_RESOURCE_UUID

UNIQUE_UUID_WEBSOCKET

OUT_OF_ORDER_BROADCAST

WRITE_TIMEOUT

BROADCASTER_WAIT_TIME

BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR

ANNOTATION_PACKAGE

ANNOTATION_PROCESSOR

ENDPOINT_MAPPER

EXCLUDED_CONTENT_TYPES

BROADCASTER_POLICY