Annotation Interface HandleSocketMessage

@Documented
@Retention(RUNTIME)
@Target({METHOD,CONSTRUCTOR})
@HandleWeb(value="",
           method="WS_MESSAGE",
           skipExpiredRequests=false)
public @interface HandleSocketMessage

Handles an incoming WebSocket message.

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/{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