Annotation Interface HandleSocketHandshake

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@HandleWeb(value="",
           method="WS_HANDSHAKE",
           skipExpiredRequests=false)
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.
MissingProtectedDataPolicy	onMissingProtectedData	Determines how the handler responds when referenced protected data is no longer available.
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

onMissingProtectedData

MissingProtectedDataPolicy onMissingProtectedData

Determines how the handler responds when referenced protected data is no longer available.

Default:

DEFAULT

value

String[] value

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

Patterns support literal path parts, {name} parameters, {name:regex} constrained parameters, and * wildcards. A non-final * matches within a single path segment, while a final * matches the rest of the path. Optional path fragments can be declared with square brackets, for example /users[/{id}]. Trailing slashes on non-root paths are ignored.

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