Module io.helidon.websocket

Package io.helidon.websocket

Annotation Interface WebSocket.OnHttpUpgrade

Enclosing class:

WebSocket

@Target(METHOD)
@Retention(CLASS)
@Documented
@Inherited
@Singleton
public static @interface WebSocket.OnHttpUpgrade

A method invoked during HTTP to WebSocket upgrade.

The annotated method may have the following parameters (only):

• HttpPrologue - request prologue
• Headers - request headers
• Parameter(s) qualified with Http.PathParam

The annotated method MUST return either void, or Headers or Optional of Headers that will provide the headers to be returned during upgrade. The returned value must not be null.