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

Class<? extends Broadcaster>	broadcaster The Broadcaster class name
Class<? extends BroadcasterCache>	broadcasterCache The BroadcasterCache class name
Class<? extends BroadcastFilter>[]	broadcastFilters A list of BroadcastFilter
String	path The mapping path, or context-root used to map this WebSocketHandler

broadcastFilters

public abstract Class<? extends BroadcastFilter>[] broadcastFilters

A list of BroadcastFilter

Default:

{}

broadcasterCache

public abstract Class<? extends BroadcasterCache> broadcasterCache

The BroadcasterCache class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.BroadcasterConfig.DefaultBroadcasterCache.class

path

public abstract 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 Class<? extends Broadcaster> broadcaster

The Broadcaster class name

Returns:

The Broadcaster class name

Default:

org.atmosphere.cpr.DefaultBroadcaster.class