Package org.atmosphere.config.service

Annotation Interface WebSocketHandlerService

@Target(TYPE)
@Retention(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	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 WebSocketEventListener>[]	listeners	Add AtmosphereResourceEventListener to track internal events.
String	path	The mapping path or context-root used to map this WebSocketHandler

Element Details

broadcastFilters

Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

Default:

{}

broadcasterCache

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

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

Class<? extends Broadcaster> broadcaster

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class

interceptors

Class<? extends AtmosphereInterceptor>[] interceptors

A list of AtmosphereInterceptor to install

Default:

{}

atmosphereConfig

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

Class<? extends WebSocketEventListener>[] listeners

Add AtmosphereResourceEventListener to track internal events.

Default:

{}