Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface WebSocketRoute<A extends ExchangeContext>

Type Parameters:

A - the type of the exchange context

All Superinterfaces:

AcceptAware, ContentAware, InterceptableRoute<A,WebExchange<A>>, MethodAware, PathAware, Route<A,WebExchange<A>>, WebRoute<A>, WebSocketProtocolAware

public interface WebSocketRoute<A extends ExchangeContext>
extends WebRoute<A>, WebSocketProtocolAware

A web route that upgrade to the WebSocket procotol.

A WebSocket route specified a WebSocketExchangeHandler used to handle a Web2SocketExchange once the WebSocket connection has been established. The method shall always be GET and consume, produce and handler always null.

Since:

1.5

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
default String	getConsume()	Always returns null.
default ReactiveExchangeHandler<A,WebExchange<A>>	getHandler()	Always returns null.
default Method	getMethod()	Always returns GET.
default String	getProduce()	Always returns null.
WebSocketExchangeHandler<A,Web2SocketExchange<A>>	getWebSocketHandler()	Returns the route WebSocket handler used to process a WebSocket exchange for a WebSocket upgrade request matching the route's criteria.

Methods inherited from interface io.inverno.mod.web.server.spi.InterceptableRoute

getInterceptors, setInterceptors

Methods inherited from interface io.inverno.mod.web.server.spi.Route

disable, enable, isDisabled, remove

Methods inherited from interface io.inverno.mod.web.server.WebRoute

getLanguage, getPath, getPathPattern

Methods inherited from interface io.inverno.mod.web.server.WebSocketProtocolAware

getSubProtocol

Method Details

getMethod

default Method getMethod()

Always returns GET.

Specified by:

getMethod in interface MethodAware

Specified by:

getMethod in interface WebRoute<A extends ExchangeContext>

Returns:

a HTTP method or null

getConsume

default String getConsume()

Always returns null.

Specified by:

getConsume in interface ContentAware

Specified by:

getConsume in interface WebRoute<A extends ExchangeContext>

Returns:

a media range or null

getProduce

default String getProduce()

Always returns null.

Specified by:

getProduce in interface AcceptAware

Specified by:

getProduce in interface WebRoute<A extends ExchangeContext>

Returns:

a media type or null

getHandler

default ReactiveExchangeHandler<A,WebExchange<A>> getHandler()

Always returns null.

Specified by:

getHandler in interface Route<A extends ExchangeContext,WebExchange<A extends ExchangeContext>>

Returns:

an exchange handler

getWebSocketHandler

WebSocketExchangeHandler<A,Web2SocketExchange<A>> getWebSocketHandler()

Returns the route WebSocket handler used to process a WebSocket exchange for a WebSocket upgrade request matching the route's criteria.

Returns:

a WebSocket exchange handler