コンストラクターの詳細

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy()

  デフォルトのコンストラクターを介して WebSocketServerFactory を作成するデフォルトのコンストラクター。デフォルトの WebSocketPolicy を使用します。

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy(org.eclipse.jetty.websocket.api.WebSocketPolicy policy)

  WebSocketServerFactory インスタンスの作成時に使用される WebSocketPolicy を受け入れるコンストラクター。

  パラメーター:

  policy - 使用するポリシー

  導入:

  4.3.5

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy(org.eclipse.jetty.websocket.server.WebSocketServerFactory factory)

  WebSocketServerFactory を受け入れるコンストラクター。

  パラメーター:

  factory - 使用する事前構成済みのファクトリ

メソッドの詳細

• 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 

  戻り値:

  コンポーネントが現在実行中かどうか

• getSupportedVersions

  public StringSE[] getSupportedVersions()

  インターフェースからコピーされた説明: RequestUpgradeStrategy
  サポートされている WebSocket プロトコルバージョンを返します。

  次で指定:

  インターフェース RequestUpgradeStrategy の getSupportedVersions 

• getSupportedExtensions

  public ListSE<WebSocketExtension> getSupportedExtensions(ServerHttpRequest request)

  インターフェースからコピーされた説明: RequestUpgradeStrategy
  基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。

  次で指定:

  インターフェース RequestUpgradeStrategy の getSupportedExtensions 

• upgrade

  public void upgrade(ServerHttpRequest request,
                      ServerHttpResponse response,
                      @Nullable
                      StringSE selectedProtocol,
                      ListSE<WebSocketExtension> selectedExtensions,
                      @Nullable
                      PrincipalSE user,
                      WebSocketHandler wsHandler,
                      MapSE<StringSE,ObjectSE> attributes)
               throws HandshakeFailureException

  インターフェースからコピーされた説明: RequestUpgradeStrategy
  ランタイム固有の手順を実行して、アップグレードを完了します。ハンドシェイクリクエストのネゴシエーションが成功した後に呼び出されます。

  次で指定:

  インターフェース RequestUpgradeStrategy の upgrade 

  パラメーター:

  request - 現在のリクエスト

  response - 現在のレスポンス

  selectedProtocol - 選択されたサブプロトコル（存在する場合）

  selectedExtensions - 選択された WebSocket プロトコル拡張

  user - WebSocket セッションに関連付けるユーザー

  wsHandler - WebSocket メッセージのハンドラー

  attributes - ハンドシェイクは、HandshakeInterceptor を介して WebSocket セッションで設定され、WebSocketHandler で利用可能になる特定の属性をリクエストします。

  例外:

  HandshakeFailureException - ハンドシェイクリクエストの要件のネゴシエーションに失敗したのではなく、内部の回復不可能なエラー、つまりサーバーエラーが原因でハンドシェイク処理が完了しなかった場合にスローされます。