Name |
Default Value |
|
Description
When to use it |
o.a.atmosphereDotXml |
WEB-INF/atmosphere.xml |
the location of the atmosphere.xml file. |
Set a different path for the atmosphere.xml location |
o.a.jersey.servlet-mapping |
/ |
The path that will be used to map request to Jersey |
Set to a different path if you want to use a different mapping path |
o.a.useBlocking |
false |
Set Atmosphere to use the BlockingIOCometSupport, e.g blocking I/O |
Set it to true if you don't want to use Native Async Support or Servlet 3.0 Async API. Setting this to true
means a thread will be blocked when suspending response.
|
o.a.useNative |
true |
Set Atmosphere to use the container native Async support instead of using the Servlet 3.0 Async API |
Most of the time native Async support perform much better than Servlet 3.0 Async API, so it is recommended
to
set that value to true
|
o.a.useWebSocket |
true |
Force Atmosphere to use WebSocket Async support. |
Set it to false to disable WebSocket support |
o.a.useStream |
false |
Force Atmosphere to use stream when writing bytes. That means AtmosphereRequest.getOutputStream will be
called
instead of AtmosphereRequest.getWriter
|
If your application only use Stream, set that value to true and make sure you never invoke
AtmosphereRequest.getWriter
|
o.a.cpr.broadcasterFactory |
o.a.cpr.DefaultBroadcasterFactory |
The default BroadcasterFactory class. Default is DefaultBroadcasterFactory
|
Change it if you want to use your own implementation |
o.a.cpr.broadcasterClass |
o.a.cpr.DefaulBroadcaster |
The default Broadcaster class to use. Default is DefaultBroadcaster
|
Change it if you want to use your own implementation |
o.a.cpr.broadcasterCacheClass |
none |
The default BroadcasterCache class. |
Change it if you want to use your own implementation |
o.a.cpr.asyncSupport |
the one detected by Atmosphere based on the used WebServer |
The AsyncSupport class used to support Comet or WebSocket. |
Change it if you want to use your own implementation |
o.a.cpr.sessionSupport |
true |
Tell Atmosphere to use HttpSession to store its internal object. |
If you are planning to share Atmosphere's internal object like BroadcasterFactory in a cluster or accross
requests, set that value to true so Atmosphere will store those object in the session instead of request's
attributes. See the FrameworkConfig
class for a list of internal shareable object.
|
o.a.resumeOnBroadcast |
false |
Force Atmosphere to invoke
after the first Broadcaster#broadcast(Object) invocation.
|
Set the value to true if your application is using only long-polling as transport. |
o.a.cpr.noCacheHeaders |
false |
Tell Atmosphere to not write the no-cache
HTTP header.
|
Set it to false if your application handles the header itself |
o.a.cpr.dropAccessControlAllowOriginHeader |
false |
Tell Atmosphere to not write the access-control header. |
Set it to true if your application will handle itself those headers |
o.a.cpr.broadcasterLifeCyclePolicy |
NEVER |
The BroadcasterLifeCyclePolicy
policy to use
|
Read this to decide
which
value to put and prevent OOM
|
o.a.websocket.WebSocketProtocol |
o.a.websocket.protocol.SimpleWebSocketProtocol |
Tell Atmosphere the WebSocketProcessor
to use. Default is SimpleWebSocketProtocol
|
Change it if you want to use your own implementation |
o.a.websocket.messageContentType |
application/json |
Tell Atmosphere the content-type to use when a WebSocket message is dispatched as an AtmosphereRequest to
another framework (ex: Wicket, Jersey)
|
Change it if you want to use your own value |
o.a.websocket.messageMethod |
POST |
Tell Atmosphere the method to use when a WebSocket message is dispatched as an AtmosphereRequest |
Change it if you want to use PUT or custom HTTP method |
o.a.websocket.maxIdleTime |
600000 |
Tell Atmosphere how long a WebSocket connection can stay idle. Default is 5 minutes |
Change it if you want a longer/shorter timeout/td
|
o.a.websocket.bufferSize |
8192 |
Atmosphere the WebSocket write buffer size. |
Change it if you want a larger/smaller buffer/td
|
o.a.websocket.pathDelimiter |
|
Tell Atmosphere the path delimiter to use when parsing a WebSocket message. |
By default no delimiter are used. If you plan to write your own custom WebSocket protocol, you can use that
value to delimiter message. Make sure you set the same value inside your application's javascript.
|
o.a.websocket.maxTextMessageSize |
-1 |
Set the WebSocket mas text size: size 0 No aggregation of frames to messages, =0 max size of text frame
aggregation buffer in character
|
Change it if you want a larger/smaller buffer/td
|
o.a.websocket.maxBinaryMessageSize |
-1 |
Set the WebSocket mas text size: size=0 max size of text frame aggregation buffer in characters |
Change it if you want a larger/smaller buffer/td
|
o.a.cpr.AtmosphereResource |
o.a.cpr.AtmosphereResourceImpl |
The Atmosphere resource to use. |
Change it if you want to use your own implementation |
o.a.cpr.broadcastFilterClasses |
|
A list of BroadcastFilter
separated with coma that will be added to every new Broadcaster
|
Read the BroadcastFilter
and
PerRequestBroadcaster
API to lean about them.
|
o.a.cpr.AtmosphereServlet.resumeAndKeepAlive |
false |
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.
|
Carefully use that property as it can cause memory leak. It is recommend to NOT change that value |
o.a.cpr.AtmosphereServlet.resumedOnTimeout |
false |
This 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)
|
It is recommend to not change that value if you aren't planning to use Jetty 6 |
o.a.disableOnStateEvent |
false |
Disable invoking AtmosphereHandler#onStateChange)
when the connection times out or get cancelled.
|
Set it to true if and only if you are using a Serializer
|
o.a.cpr.CometSupport.maxInactiveActivity |
-1 |
The maximum time, in mili second, a connection gets idle. |
This properly can be used with Jetty and BlockingIOCometSupport. Other WebServer supports detection of idle
connection (idle or remotely closed) should not use that property.
|
o.a.cpr.allowQueryStreamAsPostOrGet |
true |
Allow query string to be decoded and passed as request's header as well as query string. |
Set it to false only if you are planning to never use Internet Explorer, WebSocket and Server Side Events
|
o.a.cpr.padding |
ATMOSPHERE |
Configure the padding used when streaming is used. Value can be atmosphere or whitespace. Default is
ATMOSPHERE
AtmosphereResourceImpl#createStreamingPadding(String))
|
Change it only if the default padding is causing issue |
o.a.cpr.broadcaster.shareableThreadPool |
false |
Configure Broadcaster to share the same java.util.concurrent.ExecutorService amongs them. |
Set that value to true if you are planning to create a lot of Broadcaster
|
o.a.cpr.broadcaster.maxProcessingThreads |
unbounded |
The maximum number of Thread created when processing broadcast operations BroadcasterConfig#setExecutorService(java.util.concurrent.ExecutorService))
|
Make sure to set the appropriate value as it can cause broadcast pause if not enough threads are availaible
when
broadcasting.
|
o.a.cpr.broadcaster.maxAsyncWriteThreads |
unbounded |
The maximum number of Thread created when writing requests BroadcasterConfig#setAsyncWriteService(java.util.concurrent.ExecutorService))
|
Make sure to set the appropriate value as it can cause broadcast pause if not enough threads are availaible
when
broadcasting.
|
o.a.cpr.maxBroadcasterLifeCyclePolicyIdleTime |
300000 |
BroadcasterLifecycle max idle time before executing. Default is 5 minutes. |
Make sure you read this
before changing the value
|
o.a.cpr.recoverFromDestroyedBroadcaster |
true |
Recover from a Broadcaster that has been destroyed and needs to be re-used. Default is true. |
When Broadcaster are getting marked for destroy, re-use them if they are still available event if they are
marked as destroyable.
|
o.a.cpr.AtmosphereHandler |
|
Tell Atmosphere which AtmosphereHandler should be used. You can do the same using atmosphere.xml |
Shortcut to avoid using atmosphere.xml |
o.a.cpr.AtmosphereHandler.contextRoot |
/ |
The AtmosphereHandler defined using the property will be mapped to that value. Same as atmosphere.xml |
Shortcut to avoid using atmosphere.xml |
o.a.servlet |
|
The Servlet's name to which Atmosphere will dispatch Meteor to.
|
|
o.a.filter |
|
The Filter's name to which Atmosphere will dispatch Meteor to.
|
|
o.a.mapping |
/
|
The Servlet's mapping value to the o.a.servlet |
|
o.a.filter.name |
/ |
The Filter's mapping value to the o.a.filter |
|
o.a.cpr.BroadcasterCache.strategy |
afterFilter |
Define when a broadcasted message is cached. Value can be 'beforeFilter' or 'afterFilter'. Default is
afterFilter
|
Set it to beforeFilter if you want to cache the original message instead of the one transformed by
BroadcastFilter
|
o.a.jersey.supportLocationHeader |
false |
Support the Jersey location header for resuming. WARNING: this can cause memory leak if the connection is
never
|
If enabled, make sure your application resume all it's suspended connection because AtmosphereResource will
stay
in memory forever and can cause OOM
|
o.a.websocket.bannedVersion |
|
WebSocket version to exclude and downgrade to comet. Version are separated by comma. Use this property with
the
WebSocketHandshakeFilter
|
Set it to -1 if you want to force Atmosphere to re-negotiate the transport with browsers implementing old
version of the WebSocket spec (like Safari 5.1)
|
o.a.container.TomcatCometSupport.discardEOF |
true |
Prevent Tomcat from closing connection when inputStream#read() reach the end of the stream, as documented in
the
tomcat documentation
|
Set it to true if you want Atmosphere to publish disconnect event when the inputstream is fully read (not
recommended)
|
o.a.websocket.binaryWrite |
false |
Use the binary API for writing WevSocket message instead of text. |
Some browser may not work when set to true. Make sure you test before. |
o.a.cpr.recycleAtmosphereRequestResponse |
false |
Recycle (make them unusable) AtmosphereRequest/Response after wrapping a WebSocket message and delegating it
to
a Container
|
Set it to true if you are planning to re-use AtmosphereResource after the websocket messages has been
digested
by your application.
|
o.a.cpr.atmosphereHandlerPath |
/WEB-INF/classes |
The location of classes implementing the AtmosphereHandler interface. Default to "/WEB-INF/classes". |
|
o.a.jersey.containerResponseWriterClass |
|
Change Jersey's ContainerResponseWriter. |
See this as an example |
o.a.websocket.WebSocketProtocol.executeAsync |
true |
Execute the WebSocketProtocol#dispatch)
asynchronously.
|
Set it to true if you want your application to gets invoked serialialy with websocket messages |
o.a.cpr.defaultContextType |
text/plain |
The default content-type value used when Atmosphere requires one and none are specified. Default is
text/plain.
|
|
o.a.cpr.AtmosphereInterceptor |
|
A comma-separated list of AtmosphereInterceptor
instances to be installed.
|
|