org.atmosphere.config.service

Annotation Type ManagedService

@Target(value=TYPE)
@Retention(value=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
• The HeartbeatInterceptor for keeping the connection active

Annotating your AtmosphereHandler is the same as doing:

Author:

Jeanfrancois Arcand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and 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 Default is UUIDBroadcasterCache.
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 Detail

path

public abstract 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

public abstract Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}

broadcaster

public abstract Class<? extends Broadcaster> broadcaster

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class

interceptors

public abstract Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install. Default are AtmosphereResourceLifecycleInterceptor, ManagedServiceInterceptor, TrackMessageSizeInterceptor, HeartbeatInterceptor and SuspendTrackerInterceptor

Default:

{org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor.class, org.atmosphere.client.TrackMessageSizeInterceptor.class, org.atmosphere.interceptor.HeartbeatInterceptor.class, org.atmosphere.interceptor.SuspendTrackerInterceptor.class}

atmosphereConfig

public abstract 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

public abstract Class<? extends BroadcasterCache> broadcasterCache

The BroadcasterCache class name

Default is UUIDBroadcasterCache.

Returns:

The Broadcaster class name.

Default:

org.atmosphere.cache.UUIDBroadcasterCache.class

broadcastFilters

public abstract Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

Default:

{}