## Uses of Interface
org.springframework.web.socket.server.HandshakeInterceptor

- Packages that use HandshakeInterceptor
  Package | Description
  --- | ---
  org.springframework.web.socket.config.annotation | Support for annotation-based WebSocket setup in configuration classes.
  org.springframework.web.socket.server.support | Server-side support classes including container-specific strategies for upgrading a request.
  org.springframework.web.socket.sockjs.transport | Server-side support for SockJS transports including `TransportHandler` implementations for processing incoming requests, their `session` counterparts for sending messages over the various transports, and `DefaultSockJsService`.

- - ### Uses of HandshakeInterceptor in org.springframework.web.socket.config.annotation

    Methods in org.springframework.web.socket.config.annotation that return HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `protected HandshakeInterceptor[]` | AbstractWebSocketHandlerRegistration.`getInterceptors()`
    `protected HandshakeInterceptor[]` | WebMvcStompWebSocketEndpointRegistration.`getInterceptors()`

    Methods in org.springframework.web.socket.config.annotation with parameters of type HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `WebSocketHandlerRegistration` | AbstractWebSocketHandlerRegistration.`addInterceptors(HandshakeInterceptor... interceptors)`
    `StompWebSocketEndpointRegistration` | WebMvcStompWebSocketEndpointRegistration.`addInterceptors(HandshakeInterceptor... interceptors)`
    `StompWebSocketEndpointRegistration` | StompWebSocketEndpointRegistration.`addInterceptors(HandshakeInterceptor... interceptors)` Configure the HandshakeInterceptor's to use.
    `WebSocketHandlerRegistration` | WebSocketHandlerRegistration.`addInterceptors(HandshakeInterceptor... interceptors)` Configure interceptors for the handshake request.
    `protected void` | ServletWebSocketHandlerRegistration.`addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler,String> mappings, WebSocketHandler webSocketHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)`
    `protected abstract void` | AbstractWebSocketHandlerRegistration.`addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)`
    `SockJsServiceRegistration` | SockJsServiceRegistration.`setInterceptors(HandshakeInterceptor... interceptors)`

  - ### Uses of HandshakeInterceptor in org.springframework.web.socket.server.support

    Classes in org.springframework.web.socket.server.support that implement HandshakeInterceptor
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HttpSessionHandshakeInterceptor` An interceptor to copy information from the HTTP session to the "handshake attributes" map to made available via`WebSocketSession.getAttributes()`.
    `class` | `OriginHandshakeInterceptor` An interceptor to check request `Origin` header value against a collection of allowed origins.

    Methods in org.springframework.web.socket.server.support that return types with arguments of type HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `List<HandshakeInterceptor>` | WebSocketHttpRequestHandler.`getHandshakeInterceptors()` Return the configured WebSocket handshake request interceptors.

    Method parameters in org.springframework.web.socket.server.support with type arguments of type HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | WebSocketHttpRequestHandler.`setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)` Configure one or more WebSocket handshake request interceptors.

    Constructor parameters in org.springframework.web.socket.server.support with type arguments of type HandshakeInterceptor
    Constructor and Description
    `HandshakeInterceptorChain(List<HandshakeInterceptor> interceptors, WebSocketHandler wsHandler)`

  - ### Uses of HandshakeInterceptor in org.springframework.web.socket.sockjs.transport

    Methods in org.springframework.web.socket.sockjs.transport that return types with arguments of type HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `List<HandshakeInterceptor>` | TransportHandlingSockJsService.`getHandshakeInterceptors()` Return the configured WebSocket handshake request interceptors.

    Method parameters in org.springframework.web.socket.sockjs.transport with type arguments of type HandshakeInterceptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | TransportHandlingSockJsService.`setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)` Configure one or more WebSocket handshake request interceptors.