Package org.spincast.core.websocket

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

All Known Subinterfaces:
DefaultWebsocketRoute
All Known Implementing Classes:
SpincastWebsocketRoute
public interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>
A WebSocket route.

  • Method Details

    • getId

      String getId()
      The WebSocket route id.

    • getClasses

      Set<String> getClasses()
      The WebSocket route's classes.

    • 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.