public interface ApplicationConfig
| 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 |
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 |
BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR
Before 1.0.12, WebSocket's AtmosphereResource manually added to
Broadcaster where 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 with 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 instead among them. |
static java.lang.String |
BROADCASTER_WAIT_TIME
The sleep time, in milliseconds, before the
DefaultBroadcaster release its reactive thread for pushing message
and execute async write. |
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
AtmosphereInterceptors. |
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 |
DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER
Tell Atmosphere to not write the access-control header.
|
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 |
JERSEY_CONTAINER_RESPONSE_WRITER_CLASS
Jersey's ContainerResponseWriter.
|
static java.lang.String |
MAPPING
The Servlet's mapping value to the SERVLET_CLASS.
|
static java.lang.String |
MAX_INACTIVE
The maximum time, in miliseconds, a connection can 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_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 |
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 |
STREAMING_PADDING_MODE
Configure the padding used when streaming is used.
|
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 mas text size: size<0 No aggregation of frames to messages, >=0 max size of text frame aggregation buffer in characters.
|
static java.lang.String |
WEBSOCKET_MAXTEXTSIZE
Set the WebSocket mas text size: size lower than 0 No aggregation of frames to messages, larger than 0 max size of text frame aggregation buffer in characters.
|
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
|
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. |
static final java.lang.String PROPERTY_ATMOSPHERE_XML
Default: META-INF/
Value: "org.atmosphere.atmosphereDotXml"
static final java.lang.String PROPERTY_SERVLET_MAPPING
Default: ""
Value: "org.atmosphere.jersey.servlet-mapping"
static final java.lang.String PROPERTY_BLOCKING_COMETSUPPORT
BlockingIOCometSupport, e.g blocking I/O.
Default: false
Value: "org.atmosphere.useBlocking"
static final java.lang.String PROPERTY_NATIVE_COMETSUPPORT
Default: false
Value: "org.atmosphere.useNative"
static final java.lang.String WEBSOCKET_SUPPORT
Default: true
Value: "org.atmosphere.useWebSocket"
static final java.lang.String WEBSOCKET_SUPPORT_SERVLET3
Default: false
Value: "org.atmosphere.useWebSocketAndServlet3"
static final java.lang.String PROPERTY_USE_STREAM
Default: true
Value: "org.atmosphere.useStream"
static final java.lang.String BROADCASTER_FACTORY
BroadcasterFactory class.
Default: org.atmosphere.cpr.DefaultBroadcasterFactory
Value: "org.atmosphere.cpr.broadcasterFactory"
static final java.lang.String BROADCASTER_CLASS
Broadcaster class.
Default: org.atmosphere.cpr.DefaultBroadcaster
Value: "org.atmosphere.cpr.broadcasterClass"
static final java.lang.String BROADCASTER_CACHE
BroadcasterCache class.
Default: "" (Not installed by default)
Value: "org.atmosphere.cpr.broadcasterCacheClass"
static final java.lang.String PROPERTY_COMET_SUPPORT
AsyncSupport implementation to use.
Default: "" (Autodetected by Atmosphere)
Value: "org.atmosphere.cpr.asyncSupport"
static final java.lang.String PROPERTY_SESSION_SUPPORT
HttpSession.
Default: false
Value: "org.atmosphere.cpr.sessionSupport"
static final java.lang.String RESUME_ON_BROADCAST
AtmosphereResource.resume() after the first Broadcaster.broadcast(Object) invocation.
Default: false
Value: "org.atmosphere.resumeOnBroadcast"
static final java.lang.String DEFAULT_NAMED_DISPATCHER
Default: default
Value: "default"
static final java.lang.String NO_CACHE_HEADERS
Default: false
Value: "org.atmosphere.cpr.noCacheHeaders"
static final java.lang.String DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER
Default: false
Value: "org.atmosphere.cpr.dropAccessControlAllowOriginHeader"
static final java.lang.String BROADCASTER_LIFECYCLE_POLICY
BroadcasterLifeCyclePolicy policy to use.
Default: BroadcasterLifeCyclePolicy.NEVER
Value: "org.atmosphere.cpr.broadcasterLifeCyclePolicy"
static final java.lang.String WEBSOCKET_PROCESSOR
WebSocketProcessor to use.
Default: org.atmosphere.websocket.DefaultWebSocketProcessor
Value: "org.atmosphere.websocket.WebSocketProcessor"
static final java.lang.String WEBSOCKET_PROTOCOL
WebSocketProtocol to use.
Default: org.atmosphere.websocket.SimpleHttpProtocol Value: "org.atmosphere.websocket.WebSocketProtocol"
static final java.lang.String WEBSOCKET_CONTENT_TYPE
Default: text/plain
Value: "org.atmosphere.websocket.messageContentType"
static final java.lang.String SSE_CONTENT_TYPE
Default: text/event-stream
Value: "org.atmosphere.sse.contentType"
static final java.lang.String WEBSOCKET_METHOD
Default: POST
Value: "org.atmosphere.websocket.messageMethod"
static final java.lang.String WEBSOCKET_IDLETIME
Default: 5 minutes
Value: "org.atmosphere.websocket.maxIdleTime"
static final java.lang.String WEBSOCKET_BUFFER_SIZE
Default: 8192
Value: "org.atmosphere.websocket.bufferSize"
static final java.lang.String WEBSOCKET_PATH_DELIMITER
Default: ""
Value: "org.atmosphere.websocket.pathDelimiter"
static final java.lang.String WEBSOCKET_MAXTEXTSIZE
Default: 8192
Value: "org.atmosphere.websocket.maxTextMessageSize"
static final java.lang.String WEBSOCKET_MAXBINARYSIZE
Default: 8192
Value: "org.atmosphere.websocket.maxBinaryMessageSize"
static final java.lang.String WEBSOCKET_REQUIRE_SAME_ORIGIN
Default: true
Value: "org.atmosphere.websocket.requireSameOrigin"
static final java.lang.String ATMOSPHERE_RESOURCE
AtmosphereResource.
Default: org.atmosphere.cpr.AtmosphereResourceImpl
Value: "org.atmosphere.cpr.AtmosphereResource"
static final java.lang.String BROADCAST_FILTER_CLASSES
BroadcastFilter separated with comma that will be added to every new Broadcaster.
Default: ""
Value: "org.atmosphere.cpr.broadcastFilterClasses"
static final java.lang.String RESUME_AND_KEEPALIVE
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"
static final java.lang.String RESUMED_ON_TIMEOUT
AsyncSupport if the AtmosphereResource was resumed on timeout or by an application.
This attribute is for WebServer that doesn't support timeouts (like Jetty 6).
Default: false
Value: "org.atmosphere.cpr.AtmosphereServlet.resumedOnTimeout"
static final java.lang.String DISABLE_ONSTATE_EVENT
AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) when the connection times out or get cancelled.
Default: false
Value: "org.atmosphere.disableOnStateEvent"
static final java.lang.String MAX_INACTIVE
Default: -1 (disabled)
Value: "org.atmosphere.cpr.CometSupport.maxInactiveActivity"
static final java.lang.String ALLOW_QUERYSTRING_AS_REQUEST
Default: true
Value: "org.atmosphere.cpr.allowQueryStreamAsPostOrGet"
static final java.lang.String STREAMING_PADDING_MODE
AtmosphereResourceImpl.createStreamingPadding(String) ()}
Default: returned by AtmosphereResourceImpl.createStreamingPadding
Value: "org.atmosphere.cpr.padding"
static final java.lang.String BROADCASTER_SHARABLE_THREAD_POOLS
Broadcaster to share the same ExecutorService instead among them.
Default: true
Value: "org.atmosphere.cpr..broadcaster.shareableThreadPool"
static final java.lang.String BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE
BroadcasterConfig.setExecutorService(java.util.concurrent.ExecutorService).
Default: unlimited
Value: "org.atmosphere.cpr.broadcaster.maxProcessingThreads"
static final java.lang.String BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE
BroadcasterConfig.setAsyncWriteService(java.util.concurrent.ExecutorService).
Default: unlimited
Value: "org.atmosphere.cpr..broadcaster.maxAsyncWriteThreads"
static final java.lang.String BROADCASTER_LIFECYCLE_POLICY_IDLETIME
Default: 5 minutes
Value: "org.atmosphere.cpr.maxBroadcasterLifeCyclePolicyIdleTime"
static final java.lang.String RECOVER_DEAD_BROADCASTER
Broadcaster that has been destroyed.
Default: true
Value: "org.atmosphere.cpr.recoverFromDestroyedBroadcaster"
static final java.lang.String ATMOSPHERE_HANDLER
Default: ""
Value: "org.atmosphere.cpr.AtmosphereHandler"
static final java.lang.String ATMOSPHERE_HANDLER_MAPPING
Default: true
Value: "org.atmosphere.cpr.AtmosphereHandler.contextRoot"
static final java.lang.String SERVLET_CLASS
Meteor will be available.
Default: ""
Value: "org.atmosphere.servlet"
static final java.lang.String FILTER_CLASS
Meteor will be available.
Default: ""
Value: "org.atmosphere.filter"
static final java.lang.String MAPPING
Default: ""
Value: "org.atmosphere.mapping"
static final java.lang.String FILTER_NAME
Default: ""
Value: "org.atmosphere.filter.name"
static final java.lang.String BROADCASTER_CACHE_STRATEGY
Default: afterFilter
Value: "org.atmosphere.cpr.BroadcasterCache.strategy"
static final java.lang.String SUPPORT_LOCATION_HEADER
Default: false
Value: "org.atmosphere.jersey.supportLocationHeader"
static final java.lang.String WEB_SOCKET_BANNED_VERSION
Default: ""
Value: "org.atmosphere.websocket.bannedVersion"
static final java.lang.String TOMCAT_CLOSE_STREAM
Default: true
Value: "org.atmosphere.container.TomcatCometSupport.discardEOF"
static final java.lang.String WEBSOCKET_BINARY_WRITE
Default: false
Value: "org.atmosphere.websocket.binaryWrite"
static final java.lang.String RECYCLE_ATMOSPHERE_REQUEST_RESPONSE
Default: false
Value: "org.atmosphere.cpr.recycleAtmosphereRequestResponse"
static final java.lang.String ATMOSPHERE_HANDLER_PATH
AtmosphereHandler interface.
Default: "/WEB-INF/classes"
Value: "org.atmosphere.cpr.atmosphereHandlerPath"
static final java.lang.String JERSEY_CONTAINER_RESPONSE_WRITER_CLASS
Default: ""
Value: "org.atmosphere.jersey.containerResponseWriterClass"
static final java.lang.String WEBSOCKET_PROTOCOL_EXECUTION
WebSocketProtocol.onMessage(org.atmosphere.websocket.WebSocket, byte[], int, int).
Default: false
Value: "org.atmosphere.websocket.WebSocketProtocol.executeAsync"
static final java.lang.String DEFAULT_CONTENT_TYPE
Default: "text/plain"
Value: "org.atmosphere.cpr.defaultContextType"
static final java.lang.String ATMOSPHERE_INTERCEPTORS
AtmosphereInterceptor class name that will be invoked before the AtmosphereResource
gets delivered to an application or framework.
Default: ""
Value: "org.atmosphere.cpr.AtmosphereInterceptor"
static final java.lang.String ATMOSPHERE_EXCLUDED_FILE
AtmosphereFilter.
Default: AtmosphereFilter.EXCLUDE_FILES
Value: "org.atmosphere.cpr.AtmosphereFilter.excludes"
static final java.lang.String MESSAGE_DELIMITER
Default: "|"
Value: "org.atmosphere.client.MessageLengthInterceptor.delimiter"
static final java.lang.String ATMOSPHERERESOURCE_INTERCEPTOR_METHOD
AtmosphereResource when the AtmosphereResourceLifecycleInterceptor
is used.
Default: "GET"
Value: "org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor.method"
static final java.lang.String DISABLE_ATMOSPHEREINTERCEPTOR
AtmosphereInterceptors.
Default: false
Value: "org.atmosphere.cpr.AtmosphereInterceptor.disableDefaults
static final java.lang.String SHARED
static final java.lang.String SUSPENDED_ATMOSPHERE_RESOURCE_UUID
HeaderConfig.X_ATMOSPHERE_TRACKING_ID
but available to all transport.
Value: "org.atmosphere.cpr.AtmosphereResource.suspended.uuid"
static final java.lang.String UNIQUE_UUID_WEBSOCKET
Default: true
Value: "org.atmosphere.cpr.AtmosphereResource.uniqueUUID"
static final java.lang.String OUT_OF_ORDER_BROADCAST
Default: false
Value: "org.atmosphere.cpr.Broadcaster.supportOutOfOrderBroadcast"
static final java.lang.String WRITE_TIMEOUT
DefaultBroadcaster. When the timeout occurs, the calling threads gets interrupted.
Default: 5 * 60 * 1000 (5 minutes)
Value: "org.atmosphere.cpr.Broadcaster.supportOutOfOrderBroadcast"
static final java.lang.String BROADCASTER_WAIT_TIME
DefaultBroadcaster release its reactive thread for pushing message
and execute async write. Setting that value too high may create too many threads.
Default: 1000
Value: "org.atmosphere.cpr.Broadcaster.threadWaitTime"
static final java.lang.String BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR
Broadcaster where 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 one.
Default: false
Value: "org.atmosphere.websocket.backwardCompatible.atmosphereResource"
static final java.lang.String ANNOTATION_PACKAGE
Default: ""
Value: "org.atmosphere.cpr.packages"
static final java.lang.String BROADCASTER_POLICY
Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY).
Default: FIFO
Value: "org.atmosphere.cpr.Broadcaster.POLICY"
static final java.lang.String BROADCASTER_POLICY_TIMEOUT
Broadcaster.setSuspendPolicy(long, org.atmosphere.cpr.Broadcaster.POLICY).
Default: -1 (unlimited)
Value: "org.atmosphere.cpr.Broadcaster.POLICY.maximumSuspended"
Copyright © 2018. All Rights Reserved.