Package org.spincast.plugins.routing

Class SpincastWebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

java.lang.Object

org.spincast.plugins.routing.SpincastWebsocketRoute<R,W>

All Implemented Interfaces:

WebsocketRoute<R,W>

public class SpincastWebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>
extends Object
implements WebsocketRoute<R,W>

Constructor Summary

Constructors

Constructor	Description
SpincastWebsocketRoute(boolean spicastCoreRouteOrPluginRoute, String id, String path, List<Handler<R>> beforeFilters, Set<String> filterIdsToSkip, WebsocketController<R,W> websocketController, Set<String> classes)	Constructor

Method Summary

Modifier and Type	Method	Description
List<Handler<R>>	getBeforeFilters()	The "before" filters, if any.
Set<String>	getClasses()	The WebSocket route's classes.
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SpincastWebsocketRoute

public SpincastWebsocketRoute(boolean spicastCoreRouteOrPluginRoute,
 @Nullable
 String id,
 String path,
 @Nullable
 List<Handler<R>> beforeFilters,
 @Nullable
 Set<String> filterIdsToSkip,
 WebsocketController<R,W> websocketController,
 Set<String> classes)

Constructor

Method Details

isSpicastCoreRouteOrPluginRoute

public boolean isSpicastCoreRouteOrPluginRoute()

Description copied from interface: WebsocketRoute

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

Specified by:

isSpicastCoreRouteOrPluginRoute in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getId

public String getId()

Description copied from interface: WebsocketRoute

The WebSocket route id.

Specified by:

getId in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getClasses

public Set<String> getClasses()

Description copied from interface: WebsocketRoute

The WebSocket route's classes.

Specified by:

getClasses in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getPath

public String getPath()

Description copied from interface: WebsocketRoute

The WebSocket route path.

Specified by:

getPath in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getBeforeFilters

public List<Handler<R>> getBeforeFilters()

Description copied from interface: WebsocketRoute

The "before" filters, if any.

Specified by:

getBeforeFilters in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getFilterIdsToSkip

public Set<String> getFilterIdsToSkip()

Description copied from interface: WebsocketRoute

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

Specified by:

getFilterIdsToSkip in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

getWebsocketController

public WebsocketController<R,W> getWebsocketController()

Description copied from interface: WebsocketRoute

The WebSocket controller to use.

Specified by:

getWebsocketController in interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>

toString

public String toString()

Overrides:

toString in class Object