org.spincast.core.websocket

Interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

All Known Subinterfaces:

DefaultWebsocketRoute

public interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

A WebSocket route.

Method Summary

Modifier and Type	Method and Description
List<Handler<R>>	getBeforeFilters() The "before" filters, if any.
Set<String>	getFilterIdsToSkip() The ids of the filters that should be skipped for this route.
String	getId() The WebSocket route id.
String	getPath() The WebSocket route path.
WebsocketController<R,W>	getWebsocketController() The WebSocket controller to use.
boolean	isSpicastCoreRouteOrPluginRoute() Is this a route added by Spincast itself or by a plugin? Otherwise, the route is considered as an application route.

Method Detail

getId

String getId()

The WebSocket route id.

isSpicastCoreRouteOrPluginRoute

boolean isSpicastCoreRouteOrPluginRoute()

Is this a route added by Spincast itself or by a plugin? Otherwise, the route is considered as an application route.

getPath

String getPath()

The WebSocket route path.

getBeforeFilters

List<Handler<R>> getBeforeFilters()

The "before" filters, if any.

getWebsocketController

WebsocketController<R,W> getWebsocketController()

The WebSocket controller to use.

getFilterIdsToSkip

Set<String> getFilterIdsToSkip()

The ids of the filters that should be skipped for this route.