パッケージ jakarta.websocket.server

インターフェース ServerApplicationConfig


public interface ServerApplicationConfig
開発者は、実装がデプロイする必要のあるアーカイブ内の WebSocket エンドポイントを指定するために、WebSocket エンドポイント(WAR ファイルまたは WAR ファイル内の JAR ファイル)を含むアーカイブに ServerApplicationConfig の実装を含めます。プログラムエンドポイントとアノテーション付きエンドポイントには別々の方法があります。
作成者:
dannycoward
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    サーバーコンテナーがデプロイする必要のあるアノテーション付きエンドポイントクラスのセットを返します。
    getEndpointConfigs(SetSE<ClassSE<? extends Endpoint>> endpointClasses)
    サーバーコンテナーがプログラムによるエンドポイントのデプロイに使用する ServerEndpointConfig インスタンスのセットを返します。
  • メソッドの詳細

    • getEndpointConfigs

      SetSE<ServerEndpointConfig> getEndpointConfigs(SetSE<ClassSE<? extends Endpoint>> endpointClasses)
      サーバーコンテナーがプログラムによるエンドポイントのデプロイに使用する ServerEndpointConfig インスタンスのセットを返します。このメソッドに渡されるエンドポイントクラスのセットは、この ServerApplicationConfig の実装を含むアーカイブをスキャンすることによって取得されたセットです。渡されたこのセットは、ServerEndpointConfig インスタンスのセットをビルドして、デプロイのコンテナーに戻すために使用できます。
      パラメーター:
      endpointClasses - このインターフェースの実装を含むアーカイブ内のすべてのエンドポイントクラスのセット。
      戻り値:
      サーバーにデプロイする ServerEndpointConfig の null 以外のセット。空のセットを使用して、何もないことを示します。
    • getAnnotatedEndpointClasses

      SetSE<ClassSE<?>> getAnnotatedEndpointClasses(SetSE<ClassSE<?>> scanned)
      サーバーコンテナーがデプロイする必要のあるアノテーション付きエンドポイントクラスのセットを返します。このメソッドに渡されるクラスのセットは、このインターフェースの実装を含むアーカイブをスキャンして取得したセットです。渡されるこのセットには、このインターフェースの実装を含む JAR または WAR ファイル内のすべてのアノテーション付きエンドポイントクラスが含まれます。渡されたこのセットは、デプロイのコンテナーに戻るためのセットのビルドに使用できます。
      パラメーター:
      scanned - このインターフェースの実装を含む、アーカイブ内のすべてのアノテーション付きエンドポイントクラスのセット。
      戻り値:
      サーバーにデプロイするアノテーション付きエンドポイントクラスの null 以外のセット。空のセットを使用して、何もないことを示します。