org.atmosphere.config.service

Annotation Type AtmosphereHandlerService

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

An annotation for AtmosphereHandler

Author:

Jeanfrancois Arcand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	atmosphereConfig Atmosphere's configuration that will be passed to the associated AtmosphereHandler.
java.lang.Class<? extends Broadcaster>	broadcaster The Broadcaster class name
java.lang.Class<? extends BroadcasterCache>	broadcasterCache The BroadcasterCache 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.Class<? extends AtmosphereResourceEventListener>[]	listeners Add AtmosphereResourceEventListener to track internal events.
java.lang.String	path The mapping path or context-root used to map this AtmosphereHandler
java.lang.String[]	properties Properties that will be passed to the associated AtmosphereHandler.
boolean	supportSession Set to true if this AtmosphereHandler supports sessions

Element Detail

broadcaster

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

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class

broadcastFilters

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

A list of BroadcastFilter

Default:

{}

path

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

"/"

properties

public abstract java.lang.String[] properties

Properties that will be passed to the associated AtmosphereHandler. Properties are defined delimited using "=" and separated using comma.

Returns:

an array of properties that will be passed to the associated AtmosphereHandler

Default:

{}

supportSession

public abstract boolean supportSession

Set to true if this AtmosphereHandler supports sessions

Returns:

true if session are supported.

Default:

false

atmosphereConfig

public abstract java.lang.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 java.lang.Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install

Default:

{}

broadcasterCache

public abstract java.lang.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 message being lost.

Returns:

The Broadcaster class name

Default:

org.atmosphere.cache.DefaultBroadcasterCache.class

listeners

public abstract java.lang.Class<? extends AtmosphereResourceEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}