org.atmosphere.config.service

Annotation Type WebSocketHandlerService

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

An annotation for telling Atmosphere which WebSocketHandler class to use by default.

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 WebSocketEventListener>[]	listeners Add AtmosphereResourceEventListener to track internal events.
java.lang.String	path The mapping path or context-root used to map this WebSocketHandler

Element Detail

broadcastFilters

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

A list of BroadcastFilter

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 messages being lost.

Returns:

The Broadcaster class name

Default:

org.atmosphere.cache.DefaultBroadcasterCache.class

path

public abstract java.lang.String path

The mapping path or context-root used to map this WebSocketHandler

Returns:

mapping path or context-root used to map this WebSocketHandler

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

interceptors

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

A list of AtmosphereInterceptor to install

Default:

{}

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:

{}

listeners

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

Add AtmosphereResourceEventListener to track internal events.

Default:

{}