Annotation Interface HandleSocketHandshake

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@HandleWeb(value="",
           method="WS_HANDSHAKE")
public @interface HandleSocketHandshake

Handles a WebSocket handshake request, invoked when a client first attempts to connect using a specialised GET request.

See Also:

• HandleWeb

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	disabled	If true, disables this handler during discovery.
boolean	passive	If true, the handler will not publish a response to the WebResponse log.
String[]	value	One or more path patterns this handler applies to (e.g.

Element Details

value

String[] value

One or more path patterns this handler applies to (e.g. /users, /accounts/*). If empty, the path is based on the Path annotation.

Default:

{}

disabled

boolean disabled

If true, disables this handler during discovery.

Default:

false

passive

boolean passive

If true, the handler will not publish a response to the WebResponse log.

Default:

false