org.spincast.core.websocket

Interface IWebsocketRouteBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

All Known Implementing Classes:

WebsocketRouteBuilder

public interface IWebsocketRouteBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

Builder for WebSocket routes.

Method Summary

Modifier and Type	Method and Description
IWebsocketRouteBuilder<R,W>	before(IHandler<R> beforeFilter) Adds a before filter.
IWebsocketRoute<R,W>	create(IWebsocketController<R,W> websocketController) Creates and returns the WebSocket route without adding it to the router.
IWebsocketRouteBuilder<R,W>	id(String id) The WebSocket route id.
IWebsocketRouteBuilder<R,W>	path(String path) The path that trigger the beginning of that HTTP to WebSocket connection.
void	save(IWebsocketController<R,W> websocketController) Saves the WebSocket route on the router.
IWebsocketRouteBuilder<R,W>	skip(String beforeFilterId) Skip a "before" filter for this WebSocket route ("after" filters are never run).

Method Detail

path

IWebsocketRouteBuilder<R,W> path(String path)

The path that trigger the beginning of that HTTP to WebSocket connection.

id

IWebsocketRouteBuilder<R,W> id(String id)

The WebSocket route id.

before

IWebsocketRouteBuilder<R,W> before(IHandler<R> beforeFilter)

Adds a before filter. Those will be run before the WebSocket connection handshake is started.

Note that there are no "after" filters because once a WebSocket connection is established, the HTTP one is no more.

skip

IWebsocketRouteBuilder<R,W> skip(String beforeFilterId)

Skip a "before" filter for this WebSocket route ("after" filters are never run).

This is useful when you set a global filter but want to skip it one a specific route only.

save

void save(IWebsocketController<R,W> websocketController)

Saves the WebSocket route on the router.

create

IWebsocketRoute<R,W> create(IWebsocketController<R,W> websocketController)

Creates and returns the WebSocket route without adding it to the router. NOTE : use save(...) instead to save the route to the router at the end of the build process!