java.lang.Object
- org.springframework.web.socket.handler.WebSocketHandlerDecorator

All Implemented Interfaces:
WebSocketHandler
Direct Known Subclasses:
ExceptionWebSocketHandlerDecorator, LoggingWebSocketHandlerDecorator
```
public class WebSocketHandlerDecorator
extends Object
implements WebSocketHandler
```
Wraps another WebSocketHandler instance and delegates to it.
Also provides a getDelegate() method to return the decorated handler as well as a getLastHandler() method to go through all nested delegates and return the "last" handler.
Since:
4.0
Author:
Rossen Stoyanchev

Constructor Summary
Constructors
Constructor Description
WebSocketHandlerDecorator(WebSocketHandler delegate)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`	Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.
`void`	`afterConnectionEstablished(WebSocketSession session)`	Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.
`WebSocketHandler`	`getDelegate()`
`WebSocketHandler`	`getLastHandler()`
`void`	`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`	Invoked when a new WebSocket message arrives.
`void`	`handleTransportError(WebSocketSession session, Throwable exception)`	Handle an error from the underlying WebSocket message transport.
`boolean`	`supportsPartialMessages()`	Whether the WebSocketHandler handles partial messages.
`String`	`toString()`
`static WebSocketHandler`	`unwrap(WebSocketHandler handler)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WebSocketHandlerDecorator
```
public WebSocketHandlerDecorator(WebSocketHandler delegate)
```
- Method Detail
  - getDelegate
```
public WebSocketHandler getDelegate()
```
  - getLastHandler
```
public WebSocketHandler getLastHandler()
```
  - unwrap
```
public static WebSocketHandler unwrap(WebSocketHandler handler)
```
  - afterConnectionEstablished
```
public void afterConnectionEstablished(WebSocketSession session)
                                throws Exception
```
    Description copied from interface: WebSocketHandler
    Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.
    Specified by:
    afterConnectionEstablished in interface WebSocketHandler
    Throws:
    Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.
  - handleMessage
```
public void handleMessage(WebSocketSession session,
                          WebSocketMessage<?> message)
                   throws Exception
```
    Description copied from interface: WebSocketHandler
    Invoked when a new WebSocket message arrives.
    Specified by:
    handleMessage in interface WebSocketHandler
    Throws:
    Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.
  - handleTransportError
```
public void handleTransportError(WebSocketSession session,
                                 Throwable exception)
                          throws Exception
```
    Description copied from interface: WebSocketHandler
    Handle an error from the underlying WebSocket message transport.
    Specified by:
    handleTransportError in interface WebSocketHandler
    Throws:
    Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.
  - afterConnectionClosed
```
public void afterConnectionClosed(WebSocketSession session,
                                  CloseStatus closeStatus)
                           throws Exception
```
    Description copied from interface: WebSocketHandler
    Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.
    Specified by:
    afterConnectionClosed in interface WebSocketHandler
    Throws:
    Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.
  - supportsPartialMessages
```
public boolean supportsPartialMessages()
```
    Description copied from interface: WebSocketHandler
    Whether the WebSocketHandler handles partial messages. If this flag is set to true and the underlying WebSocket server supports partial messages, then a large WebSocket message, or one of an unknown size may be split and maybe received over multiple calls to WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage). The flag WebSocketMessage.isLast() indicates if the message is partial and whether it is the last part.
    Specified by:
    supportsPartialMessages in interface WebSocketHandler
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class WebSocketHandlerDecorator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebSocketHandlerDecorator

Method Detail

getDelegate

getLastHandler

unwrap

afterConnectionEstablished

handleMessage

handleTransportError

afterConnectionClosed

supportsPartialMessages

toString