Annotation Interface ClientWebSocket
@Documented
@Retention(RUNTIME)
@Target({TYPE,ANNOTATION_TYPE})
@WebSocketComponent
@Introduction(interfaces=WebSocketSessionAware.class)
@Type(ClientWebSocketInterceptor.class)
@DefaultScope(Prototype.class)
public @interface ClientWebSocket
Annotation declared on the client to indicate the class handles web socket frames.
- Since:
- 1.0
- Author:
- graemerocher
-
Optional Element Summary
Modifier and TypeOptional ElementDescription
-
Element Details
-
value
@AliasFor(member="uri") @AliasFor(annotation=WebSocketComponent.class,member="value") @AliasFor(annotation=WebSocketComponent.class,member="uri") String value- Returns:
- The URI of the action
- Default:
- "/ws"
-
uri
@AliasFor(member="value") @AliasFor(annotation=WebSocketComponent.class,member="value") @AliasFor(annotation=WebSocketComponent.class,member="uri") String uri- Returns:
- The URI of the action
- Default:
- "/ws"
-
version
- Returns:
- The WebSocket version to use to connect
- Default:
- V13
-
subprotocol
String subprotocol- Returns:
- The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake.
- Default:
- ""
-