org.atmosphere.config.service

Annotation Type MeteorService

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface MeteorService

Annotate a Meteor implementation so Atmosphere can install it at runtime.

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.
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 url mapping for the associated Meteor
boolean	supportSession Set to true if this AtmosphereHandler supports sessions

Element Detail

path

public abstract String path

The url mapping for the associated Meteor

Returns:

url mapping for the associated Meteor

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

supportSession

public abstract boolean supportSession

Set to true if this AtmosphereHandler supports sessions

Returns:

true if sessions are supported.

Default:

false

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:

{}

interceptors

public abstract Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install

Default:

{}

broadcasterCache

public abstract Class<? extends BroadcasterCache> broadcasterCache

The BroadcasterCache class name. By default, a no-ops DefaultBroadcasterCache is installed. It is strongly recommended to install the UUIDBroadcasterCache to prevent messages being lost.

Returns:

The Broadcaster class name

Default:

org.atmosphere.cache.DefaultBroadcasterCache.class

listeners

public abstract Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}