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
java.lang.String[]	atmosphereConfig Atmosphere's config that will be passed to the associated AtmosphereHandler.
java.lang.Class<? extends Broadcaster>	broadcaster The Broadcaster class name
java.lang.Class<? extends BroadcastFilter>[]	broadcastFilters A list of BroadcastFilter
java.lang.Class<? extends AtmosphereInterceptor>[]	interceptors A list of AtmosphereInterceptor to install
java.lang.String	path The url mapping for the associated Meteor
boolean	supportSession Does this AtmosphereHandler support session

Element Detail

path

public abstract java.lang.String path

The url mapping for the associated Meteor

Returns:

url mapping for the associated Meteor

Default:

"/"

broadcastFilters

public abstract java.lang.Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

Default:

{}

broadcaster

public abstract java.lang.Class<? extends Broadcaster> broadcaster

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class

supportSession

public abstract boolean supportSession

Does this AtmosphereHandler support session

Returns:

true if session are supported.

Default:

false

atmosphereConfig

public abstract java.lang.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:

{}

interceptors

public abstract java.lang.Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install

Default:

{}