Package org.atmosphere.config.service

Annotation Interface ManagedService

@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface ManagedService

A Meta annotation that configure Atmosphere with

• The UUIDBroadcasterCachefor caching message.
• The AtmosphereResourceLifecycleInterceptor for managing the connection lifecycle
• The TrackMessageSizeInterceptor for making sure messages are delivered entirely

Annotating your AtmosphereHandler is the same as doing:

Author:

Jeanfrancois Arcand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	atmosphereConfig	Atmosphere's configuration that will be passed to the associated AtmosphereHandler.
Class<? extends Broadcaster>	broadcaster	The Broadcaster class name
Class<? extends BroadcasterCache>	broadcasterCache	The BroadcasterCache class name
Class<? extends BroadcastFilter>[]	broadcastFilters	A list of BroadcastFilter
Class<? extends AtmosphereInterceptor>[]	interceptors	A list of AtmosphereInterceptor to install.
Class<? extends AtmosphereResourceEventListener>[]	listeners	Add AtmosphereResourceEventListener to track internal events.
String	path	The mapping path or context-root used to map this AtmosphereHandler

Element Details

path

String path

The mapping path or context-root used to map this AtmosphereHandler

Returns:

mapping path or context-root used to map this AtmosphereHandler

Default:

"/"

listeners

Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}

broadcaster

Class<? extends Broadcaster> broadcaster

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class

interceptors

Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install. Defined interceptor will be appended to the default set: AtmosphereResourceLifecycleInterceptor, ManagedServiceInterceptor, TrackMessageSizeInterceptor, HeartbeatInterceptor and SuspendTrackerInterceptor

Default:

{}

atmosphereConfig

String[] atmosphereConfig

Atmosphere's configuration that will be passed to the associated AtmosphereHandler. Configuration name and value is delimited by "=", and different configuration lines are separated by comma.

Default:

{}

broadcasterCache

Class<? extends BroadcasterCache> broadcasterCache

The BroadcasterCache class name

Default is UUIDBroadcasterCache.

Returns:

The Broadcaster class name.

Default:

org.atmosphere.cache.UUIDBroadcasterCache.class

broadcastFilters

Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

Default:

{}