PerConnectionWebSocketHandler (Spring Framework 5.2.9.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.socket.handler.PerConnectionWebSocketHandler

実装されているすべてのインターフェース:
Aware, BeanFactoryAware, WebSocketHandler
```
public class PerConnectionWebSocketHandler
extends ObjectSE
implements WebSocketHandler, BeanFactoryAware
```
各 WebSocket 接続の WebSocketHandler インスタンスを初期化および破棄し、他のすべてのメソッドをそれに委譲する WebSocketHandler。
基本的に、このクラスのインスタンスを 1 回作成し、接続ごとに作成する WebSocketHandler クラスの型を提供してから、それを WebSocketHandler を必要とするすべての API メソッドに渡します。
ターゲット WebSocketHandler 型を初期化するために Spring BeanFactory が必要な場合は、それに応じて setBeanFactory(BeanFactory) プロパティを使用します。このクラスを Spring Bean として宣言するだけでそれが可能になります。それ以外の場合、デフォルトのコンストラクターを使用して、ターゲット型の WebSocketHandler インスタンスが作成されます。
導入:
4.0
作成者:
Rossen Stoyanchev

コンストラクターの概要

コンストラクター
コンストラクターと説明
`PerConnectionWebSocketHandler(ClassSE<? extends WebSocketHandler> handlerType)`
`PerConnectionWebSocketHandler(ClassSE<? extends WebSocketHandler> handlerType, boolean supportsPartialMessages)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)` WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。
`void`	`afterConnectionEstablished(WebSocketSession session)` WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。
`void`	`handleMessage(WebSocketSession session, WebSocketMessage<?> message)` 新しい WebSocket メッセージが到着すると呼び出されます。
`void`	`handleTransportError(WebSocketSession session, ThrowableSE exception)` 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。
`void`	`setBeanFactory(BeanFactory beanFactory)` 所有ファクトリを Bean インスタンスに提供するコールバック。
`boolean`	`supportsPartialMessages()` WebSocketHandler が部分的なメッセージを処理するかどうか。
`StringSE`	`toString()`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - PerConnectionWebSocketHandler
```
public PerConnectionWebSocketHandler(ClassSE<? extends WebSocketHandler> handlerType)
```
  - PerConnectionWebSocketHandler
```
public PerConnectionWebSocketHandler(ClassSE<? extends WebSocketHandler> handlerType,
                                     boolean supportsPartialMessages)
```
- メソッドの詳細
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
```
    インターフェースからコピーされた説明: BeanFactoryAware
    所有ファクトリを Bean インスタンスに提供するコールバック。
    通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init-method などの初期化コールバックの前に呼び出されます。
    次で指定:
    インターフェース BeanFactoryAware の setBeanFactory
    パラメーター:
    beanFactory - 所有 BeanFactory（非 null）。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。
    関連事項:
    BeanInitializationException
  - afterConnectionEstablished
```
public void afterConnectionEstablished(WebSocketSession session)
                                throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。
    次で指定:
    インターフェース WebSocketHandler の afterConnectionEstablished
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - handleMessage
```
public void handleMessage(WebSocketSession session,
                          WebSocketMessage<?> message)
                   throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    新しい WebSocket メッセージが到着すると呼び出されます。
    次で指定:
    インターフェース WebSocketHandler の handleMessage
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - handleTransportError
```
public void handleTransportError(WebSocketSession session,
                                 ThrowableSE exception)
                          throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    基礎となる WebSocket メッセージトランスポートからのエラーを処理します。
    次で指定:
    インターフェース WebSocketHandler の handleTransportError
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - afterConnectionClosed
```
public void afterConnectionClosed(WebSocketSession session,
                                  CloseStatus closeStatus)
                           throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocket 接続がどちらかの側で閉じられた後、または転送エラーが発生した後に呼び出されます。セッションは技術的にはまだ開いている可能性がありますが、基盤となる実装によっては、この時点でメッセージを送信することはお勧めできません。おそらく成功しません。
    次で指定:
    インターフェース WebSocketHandler の afterConnectionClosed
    例外:
    ExceptionSE - このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
  - supportsPartialMessages
```
public boolean supportsPartialMessages()
```
    インターフェースからコピーされた説明: WebSocketHandler
    WebSocketHandler が部分的なメッセージを処理するかどうか。このフラグが true に設定され、基礎となる WebSocket サーバーが部分メッセージをサポートする場合、大きな WebSocket メッセージまたは不明なサイズのメッセージが分割され、WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage) への複数の呼び出しで受信される可能性があります。フラグ WebSocketMessage.isLast() は、メッセージが部分的であるかどうか、およびメッセージが最後の部分であるかどうかを示します。
    次で指定:
    インターフェース WebSocketHandler の supportsPartialMessages
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス PerConnectionWebSocketHandler

コンストラクターの概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

PerConnectionWebSocketHandler

PerConnectionWebSocketHandler

メソッドの詳細

setBeanFactory

afterConnectionEstablished

handleMessage

handleTransportError

afterConnectionClosed

supportsPartialMessages

toString