Package org.atmosphere.cpr

Interface ApplicationConfig

public interface ApplicationConfig
Web.xml init-param configuration supported by Atmosphere.
Author:
Jeanfrancois Arcand

  • Field Details

    • PROPERTY_ATMOSPHERE_XML

      static final String PROPERTY_ATMOSPHERE_XML
      The location of the atmosphere.xml file.

      Default: META-INF/
      Value: org.atmosphere.atmosphereDotXml

      See Also:

    • PROPERTY_SERVLET_MAPPING

      static final String PROPERTY_SERVLET_MAPPING
      The path that will be used to map request to Jersey.

      Default: ""
      Value: org.atmosphere.jersey.servlet-mapping

      See Also:

    • PROPERTY_BLOCKING_COMETSUPPORT

      static final String PROPERTY_BLOCKING_COMETSUPPORT
      Set Atmosphere to use the BlockingIOCometSupport, e.g blocking I/O.

      Default: false

      Value: org.atmosphere.useBlocking

      See Also:

    • PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST

      static final String PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST
      Set Atmosphere to throw exception on cloned request

      Default: false
      Value: org.atmosphere.throwExceptionOnClonedRequest

      See Also:

    • PROPERTY_NATIVE_COMETSUPPORT

      static final String PROPERTY_NATIVE_COMETSUPPORT
      Set Atmosphere to use the container native Comet support.

      Default: false
      Value: org.atmosphere.useNative

      See Also:

    • WEBSOCKET_SUPPORT

      static final String WEBSOCKET_SUPPORT
      Force Atmosphere to use WebSocket.

      Default: true
      Value: org.atmosphere.useWebSocket

      See Also:

    • WEBSOCKET_SUPPORT_SERVLET3

      static final String WEBSOCKET_SUPPORT_SERVLET3
      Force Atmosphere to use WebSocket + Servlet 3.0 API.

      Default: false
      Value: org.atmosphere.useWebSocketAndServlet3

      See Also:

    • PROPERTY_USE_STREAM

      static final String PROPERTY_USE_STREAM
      Force Atmosphere to use stream when writing bytes.

      Default: true
      Value: org.atmosphere.useStream

      See Also:

    • BROADCASTER_FACTORY

      static final String BROADCASTER_FACTORY
      The default BroadcasterFactory class.

      Default: org.atmosphere.cpr.DefaultBroadcasterFactory
      Value: org.atmosphere.cpr.broadcasterFactory

      See Also:

    • BROADCASTER_CLASS

      static final String BROADCASTER_CLASS
      The default Broadcaster class.

      Default: org.atmosphere.cpr.DefaultBroadcaster
      Value: org.atmosphere.cpr.broadcasterClass

      See Also:

    • BROADCASTER_CACHE

      static final String BROADCASTER_CACHE
      The default BroadcasterCache class.

      Default: org.atmosphere.cache.DefaultBroadcasterCache (Doing nothing, not caching anything)
      Value: org.atmosphere.cpr.broadcasterCacheClass

      See Also:

    • PROPERTY_COMET_SUPPORT

      static final String PROPERTY_COMET_SUPPORT
      Tell Atmosphere which AsyncSupport implementation to use.

      Default: "" (Auto detected by Atmosphere)
      Value: org.atmosphere.cpr.asyncSupport

      See Also:

    • PROPERTY_SESSION_SUPPORT

      static final String PROPERTY_SESSION_SUPPORT
      Tell Atmosphere to use HttpSession.

      Default: false
      Value: org.atmosphere.cpr.sessionSupport

      See Also:

    • PROPERTY_SESSION_CREATE

      static final String PROPERTY_SESSION_CREATE
      Tell Atmosphere to create a new HttpSession when starting and when PROPERTY_SESSION_SUPPORT is set to true.

      Default: true
      Value: org.atmosphere.cpr.sessionCreate

      See Also:

    • PROPERTY_ALLOW_SESSION_TIMEOUT_REMOVAL

      static final String PROPERTY_ALLOW_SESSION_TIMEOUT_REMOVAL
      Tell Atmosphere to set session max inactive interval to -1 when an atmosphere connection exists. See HttpSession.setMaxInactiveInterval(int)

      Default: true
      Value: org.atmosphere.cpr.removeSessionTimeout

      See Also:

    • RESUME_ON_BROADCAST

      static final 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:

    • DEFAULT_NAMED_DISPATCHER

      static final String DEFAULT_NAMED_DISPATCHER
      The default Servlet used when forwarding request.

      Default: default
      Value: default

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.cpr.noCacheHeaders

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.cpr.dropAccessControlAllowOriginHeader

      See Also:

    • BROADCASTER_LIFECYCLE_POLICY

      static final String BROADCASTER_LIFECYCLE_POLICY
      The BroadcasterLifeCyclePolicy policy to use.

      Default: BroadcasterLifeCyclePolicy.NEVER
      Value: org.atmosphere.cpr.broadcasterLifeCyclePolicy

      See Also:

    • WEBSOCKET_PROCESSOR

      static final String WEBSOCKET_PROCESSOR
      Tell Atmosphere the WebSocketProcessor to use.

      Default: org.atmosphere.websocket.DefaultWebSocketProcessor
      Value: org.atmosphere.websocket.WebSocketProcessor

      See Also:

    • WEBSOCKET_PROTOCOL

      static final String WEBSOCKET_PROTOCOL
      Tell Atmosphere the WebSocketProtocol to use.

      Default: org.atmosphere.websocket.SimpleHttpProtocol
      Value: org.atmosphere.websocket.WebSocketProtocol

      See Also:

    • 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.

      Default: text/plain
      Value: org.atmosphere.websocket.messageContentType

      See Also:

    • 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.

      Default: text/event-stream
      Value: org.atmosphere.sse.contentType

      See Also:

    • WEBSOCKET_METHOD

      static final 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:

    • WEBSOCKET_IDLETIME

      static final String WEBSOCKET_IDLETIME
      Tell Atmosphere how long a WebSocket connection can stay idle.

      Default: 5 minutes
      Value: org.atmosphere.websocket.maxIdleTime

      See Also:

    • WEBSOCKET_WRITE_TIMEOUT

      static final String WEBSOCKET_WRITE_TIMEOUT
      Timeout of JSR356 write operation. See RemoteEndpoint.Async.setSendTimeout(long)

      Default: 1 minute
      Value: org.atmosphere.websocket.writeTimeout

      See Also:

    • WEBSOCKET_BUFFER_SIZE

      static final String WEBSOCKET_BUFFER_SIZE
      Tell Atmosphere the WebSocket write buffer size.

      Default: 8192
      Value: org.atmosphere.websocket.bufferSize

      See Also:

    • 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.

      Default: ""
      Value: org.atmosphere.websocket.pathDelimiter

      See Also:

    • WEBSOCKET_MAXTEXTSIZE

      static final 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:

    • WEBSOCKET_MAXBINARYSIZE

      static final String WEBSOCKET_MAXBINARYSIZE
      Set the WebSocket max text size. Size invalid input: '<' 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:

    • WEBSOCKET_REQUIRE_SAME_ORIGIN

      static final 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:

    • JETTY_WEBSOCKET_MIN_VERSION

      static final 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:

    • ATMOSPHERE_RESOURCE

      static final String ATMOSPHERE_RESOURCE
      The AtmosphereResource.

      Default: org.atmosphere.cpr.AtmosphereResourceImpl
      Value: org.atmosphere.cpr.AtmosphereResource

      See Also:

    • BROADCAST_FILTER_CLASSES

      static final 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

      See Also:

    • 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 time-outs (like Jetty 6)

      Default: false
      Value: org.atmosphere.cpr.AtmosphereServlet.resumedOnTimeout

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.disableOnStateEvent

      See Also:

    • MAX_INACTIVE

      static final String MAX_INACTIVE
      The maximum time, in milliseconds, a connection gets idle or when the WIFI disconnection wasn't detected by the underlying container. This property works with the IdleResourceInterceptor, e.g you must install that interceptor in order to use the property.

      Default: -1 (not enabled)
      Value: org.atmosphere.cpr.CometSupport.maxInactiveActivity

      See Also:

    • ALLOW_QUERYSTRING_AS_REQUEST

      static final String ALLOW_QUERYSTRING_AS_REQUEST
      Allow query string as set as request's header.

      Default: true
      Value: org.atmosphere.cpr.allowQueryStreamAsPostOrGet

      See Also:

    • DISALLOW_MODIFY_QUERYSTRING

      static final 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

      See Also:

    • BROADCASTER_SHARABLE_THREAD_POOLS

      static final String BROADCASTER_SHARABLE_THREAD_POOLS
      Configure Broadcaster to share the same ExecutorService among them.

      Default: true
      Value: org.atmosphere.cpr.broadcaster.shareableThreadPool

      See Also:

    • 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).

      Default: unlimited
      Value: org.atmosphere.cpr.broadcaster.maxProcessingThreads

      See Also:

    • 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).

      Default: 200
      Value: org.atmosphere.cpr.broadcaster.maxAsyncWriteThreads

      See Also:

    • ALLOW_CORE_THREAD_TIMEOUT

      static final String ALLOW_CORE_THREAD_TIMEOUT
      Time out threads created by the ExecutorsFactory.

      Default: true}
      Value: org.atmosphere.cpr.allowCoreThreadTimeOut #see ThreadPoolExecutor.allowCoreThreadTimeOut

      See Also:

    • SCHEDULER_THREADPOOL_MAXSIZE

      static final String SCHEDULER_THREADPOOL_MAXSIZE
      The maximum number of Thread created by the ExecutorsFactory.getScheduler(AtmosphereConfig).

      Default: Runtime.availableProcessors()
      Value: org.atmosphere.cpr.maxSchedulerThread

      See Also:

    • BROADCASTER_LIFECYCLE_POLICY_IDLETIME

      static final String BROADCASTER_LIFECYCLE_POLICY_IDLETIME
      BroadcasterLifecycle max idle time before executing.

      Default: 5 minutes
      Value: org.atmosphere.cpr.maxBroadcasterLifeCyclePolicyIdleTime

      See Also:

    • RECOVER_DEAD_BROADCASTER

      static final String RECOVER_DEAD_BROADCASTER
      Recover from a Broadcaster that has been destroyed.

      Default: true
      Value: org.atmosphere.cpr.recoverFromDestroyedBroadcaster

      See Also:

    • ATMOSPHERE_HANDLER

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

      Default: ""
      Value: org.atmosphere.cpr.AtmosphereHandler

      See Also:

    • 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

      Default: true
      Value: org.atmosphere.cpr.AtmosphereHandler.contextRoot

      See Also:

    • SERVLET_CLASS

      static final String SERVLET_CLASS
      The Servlet's name where Meteor will be available.

      Default: ""
      Value: org.atmosphere.servlet

      See Also:

    • FILTER_CLASS

      static final String FILTER_CLASS
      The Filter's name where Meteor will be available.

      Default: ""
      Value: org.atmosphere.filter

      See Also:

    • MAPPING

      static final String MAPPING
      The Servlet's mapping value to the SERVLET_CLASS.

      Default: ""
      Value: org.atmosphere.mapping

      See Also:

    • FILTER_NAME

      static final String FILTER_NAME
      The Servlet's mapping value to the FILTER_CLASS.

      Default: ""
      Value: org.atmosphere.filter.name

      See Also:

    • BROADCASTER_CACHE_STRATEGY

      static final 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

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.jersey.supportLocationHeader

      See Also:

    • WEB_SOCKET_BANNED_VERSION

      static final 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:

    • 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.

      Default: true
      Value: org.atmosphere.container.TomcatCometSupport.discardEOF

      See Also:

    • WEBSOCKET_BINARY_WRITE

      static final String WEBSOCKET_BINARY_WRITE
      Write binary instead of String.

      Default: false
      Value: org.atmosphere.websocket.binaryWrite

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.cpr.recycleAtmosphereRequestResponse

      See Also:

    • ATMOSPHERE_HANDLER_PATH

      static final String ATMOSPHERE_HANDLER_PATH
      The location of classes implementing the AtmosphereHandler interface.

      Default: "/WEB-INF/classes".
      Value: org.atmosphere.cpr.atmosphereHandlerPath

      See Also:

    • JERSEY_CONTAINER_RESPONSE_WRITER_CLASS

      static final String JERSEY_CONTAINER_RESPONSE_WRITER_CLASS
      Jersey's ContainerResponseWriter.

      Default: ""
      Value: org.atmosphere.jersey.containerResponseWriterClass

      See Also:

    • WEBSOCKET_PROTOCOL_EXECUTION

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

      Default: false
      Value: org.atmosphere.websocket.WebSocketProtocol.executeAsync

      See Also:

    • WEBSOCKET_SUPPRESS_JSR356

      static final String WEBSOCKET_SUPPRESS_JSR356
      Suppress the detection of JSR356 support. In Atmosphere 2.4.0 and newer, JSR356 has the precedence over container specific providers. This option can be used to suppress this ordering.

      Default: false
      Value: org.atmosphere.websocket.suppressJSR356

      See Also:

    • DEFAULT_CONTENT_TYPE

      static final String DEFAULT_CONTENT_TYPE
      The default content-type value used when Atmosphere requires one.

      Default: "text/plain"
      Value: org.atmosphere.cpr.defaultContentType

      See Also:

    • 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.

      Default: ""
      Value: org.atmosphere.cpr.AtmosphereInterceptor

      See Also:

    • ATMOSPHERE_EXCLUDED_FILE

      static final String ATMOSPHERE_EXCLUDED_FILE
      Regex pattern for excluding file from being serviced by AtmosphereFilter.

      Default: AtmosphereFilter.EXCLUDE_FILES
      Value: org.atmosphere.cpr.AtmosphereFilter.excludes

      See Also:

    • 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: "|"
      Value: org.atmosphere.client.TrackMessageSizeInterceptor.delimiter

      See Also:

    • ATMOSPHERERESOURCE_INTERCEPTOR_METHOD

      static final 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

      See Also:

    • ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT

      static final 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

      See Also:

    • DISABLE_ATMOSPHEREINTERCEPTOR

      static final String DISABLE_ATMOSPHEREINTERCEPTOR
      Disable au-discovery of pre-installed AtmosphereInterceptors.

      Default: false
      Value: org.atmosphere.cpr.AtmosphereInterceptor.disableDefaults

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.runtime.shared

      See Also:

    • 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.

      Value: org.atmosphere.cpr.AtmosphereResource.suspended.uuid

      See Also:

    • UNIQUE_UUID_WEBSOCKET

      static final 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

      See Also:

    • 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.

      Default: false
      Value: org.atmosphere.cpr.Broadcaster.supportOutOfOrderBroadcast

      See Also:

    • WRITE_TIMEOUT

      static final 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

      See Also:

    • BROADCASTER_WAIT_TIME

      static final 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

      See Also:

    • BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR

      static final 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:

    • ANNOTATION_PACKAGE

      static final 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:

    • ANNOTATION_PROCESSOR

      static final String ANNOTATION_PROCESSOR
      The annotation processor.

      Default: org.atmosphere.cpr.DefaultAnnotationProcessor
      Value: org.atmosphere.cpr.AnnotationProcessor

      See Also:

    • ENDPOINT_MAPPER

      static final String ENDPOINT_MAPPER
      Define an implementation of the EndpointMapper.

      Default: org.atmosphere.cpr.DefaultEndpointMapper
      Value: org.atmosphere.cpr.EndpointMapper

      See Also:

    • EXCLUDED_CONTENT_TYPES

      static final String EXCLUDED_CONTENT_TYPES
      The list of content-type to exclude when delimiting message.

      Default: ""
      Value: org.atmosphere.client.TrackMessageSizeInterceptor.excludedContentType

      See Also:

    • BROADCASTER_POLICY

      static final 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

      See Also:

    • BROADCASTER_POLICY_TIMEOUT

      static final 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

      See Also:

    • HANDLER_MAPPING_REGEX

      static final String HANDLER_MAPPING_REGEX
      Change the default regex used when mapping AtmosphereHandler. Default: AtmosphereFramework.MAPPING_REGEX

      Default: "[a-zA-Z0-9-invalid input: '&'.*_=@;\?]+"
      Value: org.atmosphere.client.ApplicationConfig.mappingRegex

      See Also:

    • STATE_RECOVERY_TIMEOUT

      static final 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

      See Also:

    • JSR356_PATH_MAPPING_LENGTH

      static final 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"
      See Also:

    • SSE_DEFAULT_CONTENTTYPE

      static final String SSE_DEFAULT_CONTENTTYPE
      Default Server-Sent Event content type. Default: text/event-stream Value: org.atmosphere.interceptor.SSEAtmosphereInterceptor.contentType
      See Also:

    • CUSTOM_ANNOTATION_PACKAGE

      static final 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:

    • SCAN_CLASSPATH

      static final 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

      See Also:

    • BUILT_IN_SESSION

      static final String BUILT_IN_SESSION
      Use a build in HttpSession when using native WebSocket implementation.

      Default: false
      Value: org.atmosphere.cpr.useBuildInSession

      See Also:

    • OBJECT_FACTORY

      static final String OBJECT_FACTORY
      The default AtmosphereObjectFactory class.

      Default: DefaultAtmosphereObjectFactory (calls newInstance() on class)
      Value: org.atmosphere.cpr.objectFactory

      See Also:

    • EXECUTORFACTORY_KEEP_ALIVE

      static final String EXECUTORFACTORY_KEEP_ALIVE
      The maximum number of time, in seconds, thread will be stay alive when created with ExecutorsFactory. Those Executor. are used by the DefaultBroadcaster's Thread Pool. See also BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE and BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE

      Default: 10 seconds
      Value: org.atmosphere.cpr.threadPool.maxKeepAliveThreads

      See Also:

    • IN_MEMORY_STREAMING_BUFFER_SIZE

      static final String IN_MEMORY_STREAMING_BUFFER_SIZE
      In Memory WebSocket buffered message size;

      Default: 2097152 (2 mg)
      Value: org.atmosphere.websocket.webSocketBufferingMaxSize

      See Also:

    • AUTODETECT_BROADCASTER

      static final String AUTODETECT_BROADCASTER
      Scan the classpath to find Broadcaster

      Default: true)
      Value: org.atmosphere.cpr.Broadcaster.scanClassPath

      See Also:

    • DISABLE_ATMOSPHEREINTERCEPTORS

      static final String DISABLE_ATMOSPHEREINTERCEPTORS
      Disables the list of AtmosphereInterceptors.

      Default: false
      Value: org.atmosphere.cpr.AtmosphereInterceptor.disable

      See Also:

    • JSR356_MAPPING_PATH

      static final 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

      See Also:

    • SESSION_MAX_INACTIVE_INTERVAL

      static final String SESSION_MAX_INACTIVE_INTERVAL
      The default HttpSession.setMaxInactiveInterval(int)

      Default: -1
      Value: org.atmosphere.cpr.session.maxInactiveInterval

      See Also:

    • CLOSED_ATMOSPHERE_THINK_TIME

      static final String CLOSED_ATMOSPHERE_THINK_TIME
      Wait X milliseconds before considering the AtmosphereResource closed. This is useful when
      invalid @link 
      {@link org.atmosphere.util.Utils#atmosphereProtocol(AtmosphereRequest r))
      } return true, and let the client send the HeaderConfig.DISCONNECT_TRANSPORT_MESSAGE message.

      Default: 500
      Value: org.atmosphere.cpr.session.delayClosingTime

      See Also:

    • UUIDBROADCASTERCACHE_CLIENT_IDLETIME

      static final String UUIDBROADCASTERCACHE_CLIENT_IDLETIME
      The maximum time, in seconds, for a message to stay cached when using the UUIDBroadcasterCache

      Default: 60
      Value: org.atmosphere.cache.UUIDBroadcasterCache.clientIdleTime

      See Also:

    • UUIDBROADCASTERCACHE_IDLE_CACHE_INTERVAL

      static final String UUIDBROADCASTERCACHE_IDLE_CACHE_INTERVAL
      The frequency, in seconds, for the UUIDBroadcasterCache is pruning cached messages.

      Default: 30
      Value: org.atmosphere.cache.UUIDBroadcasterCache.invalidateCacheInterval

      See Also:

    • INVOKE_ATMOSPHERE_INTERCEPTOR_ON_WEBSOCKET_MESSAGE

      static final String INVOKE_ATMOSPHERE_INTERCEPTOR_ON_WEBSOCKET_MESSAGE
      Invoke Atmosphere interceptor for on every websocket message.

      Default: true
      Value: org.atmosphere.websocket.DefaultWebSocketProcessor.invokeInterceptorsOnMessage

      See Also:

    • ENFORCE_ATMOSPHERE_VERSION

      static final String ENFORCE_ATMOSPHERE_VERSION
      Disable the Atmosphere Protocol version check. This can be used to support version of atmosphere-javascript lower than 2.2.1

      Default: true
      Value: org.atmosphere.interceptor.JavaScriptProtocol.enforceAtmosphereProtocol

      See Also:

    • REWRITE_WEBSOCKET_REQUESTURI

      static final String REWRITE_WEBSOCKET_REQUESTURI
      Rewrite the original handshake request URI when websocket is used, trimming the http://host:port from the value. This is required with when JSR356 is used and JAXRS like Jersey2 is used.

      Default: true
      Value: org.atmosphere.websocket.protocol.SimpleHttpProtocol.rewriteURL

      See Also:

    • HEARTBEAT_PADDING_CHAR

      static final String HEARTBEAT_PADDING_CHAR
      The heartbeat padding String.

      Default: ' '
      Value: org.atmosphere.interceptor.HeartbeatInterceptor.paddingChar

      See Also:

    • HEARTBEAT_INTERVAL_IN_SECONDS

      static final String HEARTBEAT_INTERVAL_IN_SECONDS
      The heartbeat frequency, in seconds.

      Default: 60
      Value: org.atmosphere.interceptor.HeartbeatInterceptor.heartbeatFrequencyInSeconds

      See Also:

    • CLIENT_HEARTBEAT_INTERVAL_IN_SECONDS

      static final String CLIENT_HEARTBEAT_INTERVAL_IN_SECONDS
      Configuration key for client heartbeat.

      Default: 0 (disabled)
      Value: org.atmosphere.interceptor.HeartbeatInterceptor.clientHeartbeatFrequencyInSeconds

      See Also:

    • RESUME_ON_HEARTBEAT

      static final String RESUME_ON_HEARTBEAT
      Resume the long-polling or jsonp connection on every heartbeat (I/O operations).

      Default: true
      Value: org.atmosphere.interceptor.HeartbeatInterceptor.resumeOnHeartbeat

      See Also:

    • DEFAULT_SERIALIZER

      static final String DEFAULT_SERIALIZER
      Set the default Serializer implementation AtmosphereResources use to serialize broadcasted objects.

      Default: empty (no Serialize class used)
      Value: org.atmosphere.cpr.AtmosphereResource.defaultSerializer

      See Also:

    • DISABLE_ATMOSPHERE_INITIALIZER

      static final String DISABLE_ATMOSPHERE_INITIALIZER
      Disable container managed framework auto initialization during startup lifecycle (Servlet 3.0). This is useful e.g. if special initialization or framework extensions are needed.

      Default: false (Auto initialization enabled)
      Value: org.atmosphere.cpr.AtmosphereInitializer.disabled

      Example init-param: 

      
 <init-param>
 <param-name>org.atmosphere.cpr.AtmosphereInitializer.disabled</param-name>
 <param-value>true</param-value>
 </init-param>
      See Also:

    • ANALYTICS

      static final String ANALYTICS
      Disable Google Analytics. Default: true (enabled)
      Value: org.atmosphere.cpr.AtmosphereFramework.analytics
      See Also:

    • BYTECODE_PROCESSOR

      static final String BYTECODE_PROCESSOR
      For use of (@link BytecodeBasedAnnotationProcessor} Default: false Value: org.atmosphere.cpr.annotation.useBytecodeProcessor
      See Also:

    • SERVLET_NAME

      static final String SERVLET_NAME
      The web.xml servlet-name. Default: AtmosphereServlet
      Value: org.atmosphere.servlet
      See Also:

    • READ_GET_BODY

      static final String READ_GET_BODY
      Try to read a HTTP GET body. Default: false
      Value: org.atmosphere.util.IOUtils.readGetBody
      See Also:

    • CACHE_MESSAGE_ON_IO_FLUSH_EXCEPTION

      static final String CACHE_MESSAGE_ON_IO_FLUSH_EXCEPTION
      If a I/O exception occurs during a flush() or flushBuffer() exception, cache the bytes that was previously written. When the server buffer the bytes, the bytes may or may not been properly written to the client and those will be lost if you set that value to false. If the bytes where properly written, the bytes may be cached and may be sent twice to the client. Default: true
      Value: org.atmosphere.cpr.Broadcaster.cacheOnIOFlushException
      See Also:

    • BROADCASTER_SHAREABLE_LISTENERS

      static final String BROADCASTER_SHAREABLE_LISTENERS
      Share between Broadcaster the same List of BroadcasterListener and BroadcasterLifeCyclePolicyListener. Setting the value to true may significantly reduce the memory used by those listeners if a lot of Broadcaster are created.

      Listeners MUST be Thread-Safe to use that feature.

      Default: false
      Value: org.atmosphere.cpr.Broadcaster.sharedListenersList

      See Also:

    • SUPPORT_TRACKED_BROADCASTER

      static final String SUPPORT_TRACKED_BROADCASTER
      When the PoolableBroadcasterFactory is enabled, set to true for tracking created Broadcaster and their associated id, preventing duplicate.

      Default: false Value:org.atmosphere.pool.trackPooledBroadcaster

      See Also:

    • POOLEABLE_PROVIDER

      static final String POOLEABLE_PROVIDER
      The PoolableProvider used by the PoolableBroadcasterFactory

      Default: org.atmosphere.pool.UnboundedApachePoolableProvider Value: org.atmosphere.pool.poolableProvider

      See Also:

    • BROADCASTER_FACTORY_POOL_SIZE

      static final String BROADCASTER_FACTORY_POOL_SIZE
      The size of the pool powering BoundedApachePoolableProvider

      Default: 200 Value: org.atmosphere.pool.BoundedApachePoolableProvider.size

      See Also:

    • BROADCASTER_FACTORY_EMPTY_WAIT_TIME_IN_SECONDS

      static final String BROADCASTER_FACTORY_EMPTY_WAIT_TIME_IN_SECONDS
      The time, in second, to wait for a new object from the BoundedApachePoolableProvider

      Default: 10 seconds Value: org.atmosphere.pool.BoundedApachePoolableProvider.waitingTime

      See Also:

    • META_SERVICE_PATH

      static final String META_SERVICE_PATH
      The path to the org.atmosphere.cpr.AtmosphereFramework configuration file Default: META-INF/services Value: org.atmosphere.cpr.metaServicePath
      See Also:

    • CLOSE_STREAM_ON_CANCEL

      static final String CLOSE_STREAM_ON_CANCEL
      Close the AtmosphereResponseImpl.getOutputStream() when AtmosphereResource.close() gets invoked, or when the underlying server close the connection. Default: false Value: org.atmosphere.cpr.AsynchronousProcessor.closeOnCancel
      See Also:

    • USE_SERVLET_CONTEXT_PARAMETERS

      static final String USE_SERVLET_CONTEXT_PARAMETERS
      Use init parameters specified for servlet context in addition to servlet config Default: false Value: org.atmosphere.cpr.AtmosphereConfig.getInitParameter
      See Also:

    • USE_FORJOINPOOL

      static final String USE_FORJOINPOOL
      Use
      invalid reference 
      ForkJoinPool
      for dispatching messages and executing async I/O) operation Default: true Value: org.atmosphere.useForkJoinPool
      See Also:

    • RESPONSE_COMPLETION_AWARE

      static final String RESPONSE_COMPLETION_AWARE
      The completion of response writing is reported to AtmosphereResponse. An interceptor can use the completion status of AtmosphereResponse to change the behavior of its transform method.

      Default: false

      See Also:

    • RESPONSE_COMPLETION_RESET

      static final String RESPONSE_COMPLETION_RESET
      The completion status of AtmosphereResponse is reset after each completion so that the subsequent write operations are handled as a series of new write operations.

      Default: false

      See Also:

    • TWO_STEPS_WRITE

      static final String TWO_STEPS_WRITE
      Writes the given data to the given outputstream in two steps with extra flushes to make servers notice if the connection has been closed. This enables caching the message instead of losing it, if the client is in the progress of reconnecting via a Proxy where the server fails to detect the connection has been closed.

      This value only apply to LONG-POLLING transport

      Default: false Value: org.atmosphere.cpr.AbstractReflectorAtmosphereHandler.twoStepsWrite

      See Also:

    • INJECTION_TRY

      static final String INJECTION_TRY
      How many times the InjectableObjectFactory will try to construct and inject an object from an Injectable. This happens when an Injectable returns null instead of the expected Injection

      Default: 5 Value: org.atmosphere.cpr.InjectableObjectFactory.maxTry

      See Also:

    • INJECTION_LISTENERS

      static final String INJECTION_LISTENERS
      InjectableObjectFactory listeners.

      Listeners MUST be Thread-Safe to use that feature.

      Default: null
      Value: org.atmosphere.inject.InjectableObjectFactory.listeners

      See Also:

    • DELAY_PROTOCOL_IN_MILLISECONDS

      static final String DELAY_PROTOCOL_IN_MILLISECONDS
      Delay the sending of the Atmosphere's first message protocol by X seconds

      Default: 0
      Value: org.atmosphere.interceptor.JavaScriptProtocol.delayProtocolInSeconds

      See Also:

    • FLUSH_BUFFER_HEARTBEAT

      static final String FLUSH_BUFFER_HEARTBEAT
      Invoke flushBuffer when SSE and Streaming is used with the HeartbeatInterceptor

      Default: true
      Value: org.atmosphere.interceptor.HeartbeatInterceptor.flushBuffer

      See Also:

    • CONTENT_TYPE_FIRST_RESPONSE

      static final String CONTENT_TYPE_FIRST_RESPONSE
      Set content-type header in the first response. See AtmosphereFramework.configureRequestResponse(org.atmosphere.cpr.AtmosphereRequest, org.atmosphere.cpr.AtmosphereResponse) no default value value : text/plain; charset=utf-8
      See Also:

    • ALLOW_WEBSOCKET_STATUS_CODE_1005_AS_DISCONNECT

      static final String ALLOW_WEBSOCKET_STATUS_CODE_1005_AS_DISCONNECT
      Allow the WebSocketProtocol to invoke the AsynchronousProcessor when a status of 1005 is received. This property is required since atmosphere-javascript 3.1.0 in order to prevent the WebSocketProtocol to wrongly detect an unexpected disconnect. atmosphere-javascript 3.1.0 started to use navigation.sendBeacon() API to detect disconnect from page reload. This property is for backward compatibility.

      Default: false
      Value: org.atmosphere.websocket.WebSocketProtocol.allow1005disconnectEvent

      See Also: