public.javadoc.org.spincast.plugins.routing.SpincastWebsocketRoute.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastWebsocketRoute (org.spincast:spincast-framework 1.13.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 and Description


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










Method Summary

All Methods Instance Methods Concrete Methods 

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.



String
toString() 






Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait














Constructor Detail





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









Method Detail





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<?>>








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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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.
`String`	`toString()`