org.atmosphere.config.service
Annotation Type AtmosphereService

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface AtmosphereService

An annotation which exactly acts as a ManagedService annotated resource, but that can be used with framework like Jersey, Wicket or any framework running the Atmosphere Framework. The annotation allow configuring Atmosphere's components like Broadcaster, AtmosphereInterceptor, etc. This annotation doesn't install any Atmosphere Component like ManagedService, AtmosphereHandler or WebSocketHandler. The framework supporting the annotation must deploy itself an Atmosphere's Service.

Optional Element Summary

String[]	atmosphereConfig Atmosphere's config 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.

listeners

public abstract Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}

broadcastFilters

public abstract Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

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 , TrackMessageSizeInterceptor and HeartbeatInterceptor

Default:

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

atmosphereConfig

public abstract String[] atmosphereConfig

Atmosphere's config that will be passed to the associated AtmosphereHandler. Atmosphere's config are defined delimited using "=" and separated using coma.

Returns:

Atmosphere's config that will be passed to the associated AtmosphereHandler. Atmosphere's config are defined delimited using "=" and separated using coma.

Default:

{}

broadcasterCache

public abstract Class<? extends BroadcasterCache> broadcasterCache

The BroadcasterCache class name

Returns:

The Broadcaster class name. Default is UUIDBroadcasterCache

Default:

org.atmosphere.cache.UUIDBroadcasterCache.class