WebSocketHttpRequestHandler (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

実装されたすべてのインターフェース:
Aware, Lifecycle, ServletContextAware, HttpRequestHandler
```
public class WebSocketHttpRequestHandler
extends ObjectSE
implements HttpRequestHandler, Lifecycle, ServletContextAware
```
WebSocket ハンドシェイクリクエストを処理するための HttpRequestHandler。
これは、特定の URL でサーバー WebSocket を構成するときに使用するメインクラスです。これは、WebSocketHandler および HandshakeHandler の非常に薄いラッパーで、HttpServletRequestEE および HttpServletResponseEE をそれぞれ ServerHttpRequest および ServerHttpResponse に適合させます。
導入:
4.0
作成者:
Rossen Stoyanchev

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`WebSocketHttpRequestHandler(WebSocketHandler wsHandler)`
`WebSocketHttpRequestHandler(WebSocketHandler wsHandler, HandshakeHandler handshakeHandler)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected WebSocketHandler`	`decorate(WebSocketHandler handler)` コンストラクターに渡された `WebSocketHandler` を装飾します。
`HandshakeHandler`	`getHandshakeHandler()` HandshakeHandler を返します。
`ListSE<HandshakeInterceptor>`	`getHandshakeInterceptors()` 構成された WebSocket ハンドシェイクリクエストインターセプターを返します。
`WebSocketHandler`	`getWebSocketHandler()` WebSocketHandler を返します。
`void`	`handleRequest(HttpServletRequestEE servletRequest, HttpServletResponseEE servletResponse)` 指定されたリクエストを処理し、レスポンスを生成します。
`boolean`	`isRunning()` このコンポーネントが現在実行されているかどうかを確認します。
`void`	`setHandshakeInterceptors(ListSE<HandshakeInterceptor> interceptors)` 1 つ以上の WebSocket ハンドシェイクリクエストインターセプターを構成します。
`void`	`setServletContext(ServletContextEE servletContext)` このオブジェクトが実行される `ServletContext`EE を設定します。
`void`	`start()` このコンポーネントを起動します。
`void`	`stop()` このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。

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

- コンストラクターの詳細
  - WebSocketHttpRequestHandler
```
public WebSocketHttpRequestHandler(WebSocketHandler wsHandler)
```
  - WebSocketHttpRequestHandler
```
public WebSocketHttpRequestHandler(WebSocketHandler wsHandler,
                                   HandshakeHandler handshakeHandler)
```
- メソッドの詳細
  - decorate
```
protected WebSocketHandler decorate(WebSocketHandler handler)
```
    コンストラクターに渡された WebSocketHandler を装飾します。
    デフォルトでは、LoggingWebSocketHandlerDecorator および ExceptionWebSocketHandlerDecorator が追加されます。
    導入:
    5.2.2
  - getWebSocketHandler
```
public WebSocketHandler getWebSocketHandler()
```
    WebSocketHandler を返します。
  - getHandshakeHandler
```
public HandshakeHandler getHandshakeHandler()
```
    HandshakeHandler を返します。
  - setHandshakeInterceptors
```
public void setHandshakeInterceptors(@Nullable
                                     ListSE<HandshakeInterceptor> interceptors)
```
    1 つ以上の WebSocket ハンドシェイクリクエストインターセプターを構成します。
  - getHandshakeInterceptors
```
public ListSE<HandshakeInterceptor> getHandshakeInterceptors()
```
    構成された WebSocket ハンドシェイクリクエストインターセプターを返します。
  - setServletContext
```
public void setServletContext(ServletContextEE servletContext)
```
    インターフェースからコピーされた説明: ServletContextAware
    このオブジェクトが実行される ServletContextEE を設定します。
    通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware の setApplicationContext の後に呼び出されます。
    次で指定:
    インターフェース ServletContextAware の setServletContext
    パラメーター:
    servletContext - このオブジェクトによって使用される ServletContext オブジェクト
    関連事項:
    InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
  - start
```
public void start()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントを起動します。
    コンポーネントがすでに実行されている場合は、例外をスローしないでください。
    コンテナーの場合、これは適用されるすべてのコンポーネントに開始信号を伝播します。
    次で指定:
    インターフェース Lifecycle の start
    関連事項:
    SmartLifecycle.isAutoStartup()
  - stop
```
public void stop()
```
    インターフェースからコピーされた説明: Lifecycle
    このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。
    この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、Lifecycle Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止信号を事前に考慮することなく呼び出されます。
    コンポーネントが実行されていない（まだ開始されていない）場合は、例外をスローしないでください。
    コンテナーの場合、これは停止信号を適用するすべてのコンポーネントに伝播します。
    次で指定:
    インターフェース Lifecycle の stop
    関連事項:
    SmartLifecycle.stop(Runnable), DisposableBean.destroy()
  - isRunning
```
public boolean isRunning()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントが現在実行されているかどうかを確認します。
    コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。
    次で指定:
    インターフェース Lifecycle の isRunning
    戻り値:
    コンポーネントが現在実行中かどうか
  - handleRequest
```
public void handleRequest(HttpServletRequestEE servletRequest,
                          HttpServletResponseEE servletResponse)
                   throws ServletExceptionEE,
                          IOExceptionSE
```
    インターフェースからコピーされた説明: HttpRequestHandler
    指定されたリクエストを処理し、レスポンスを生成します。
    次で指定:
    インターフェース HttpRequestHandler の handleRequest
    パラメーター:
    servletRequest - 現在の HTTP リクエスト
    servletResponse - 現在の HTTP レスポンス
    例外:
    ServletExceptionEE - 一般的なエラーの場合
    IOExceptionSE - I/O エラーの場合

クラス WebSocketHttpRequestHandler

コンストラクターのサマリー

メソッドのサマリー

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

コンストラクターの詳細

WebSocketHttpRequestHandler

WebSocketHttpRequestHandler

メソッドの詳細

decorate

getWebSocketHandler

getHandshakeHandler

setHandshakeInterceptors

getHandshakeInterceptors

setServletContext

start

stop

isRunning

handleRequest