パッケージ jakarta.websocket

インターフェース EndpointConfig

すべての既知のサブインターフェース:
ClientEndpointConfig, ServerEndpointConfig
public interface EndpointConfig
エンドポイント構成には、このエンドポイントのハンドシェイクプロセス中に必要なすべての情報が含まれています。すべてのエンドポイントは、たとえば URI を指定します。サーバーエンドポイントの場合、URI はエンドポイントがマップされる URI を示します。クライアントアプリケーションの場合、URI は、クライアントエンドポイントが接続を試みるサーバーの URI を示します。
作成者:
dannycoward

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    ListSE<ClassSE<? extends Decoder>>
    getDecoders()
    構成されたデコーダー実装クラスを返します。
    ListSE<ClassSE<? extends Encoder>>
    getEncoders()
    構成されたエンコーダ実装クラスを返します。
    MapSE<StringSE,ObjectSE>
    getUserProperties()
    このメソッドは、開発者がこの構成インスタンスを使用するエンドポイントに関連するアプリケーション固有の情報を格納するために使用できる変更可能なマップを返します。

  • メソッドの詳細

    • getEncoders

      ListSE<ClassSE<? extends Encoder>> getEncoders()
      構成されたエンコーダ実装クラスを返します。これらはコンテナーによってインスタンス化され、リモートエンドポイントの send() メソッドに渡されるカスタムオブジェクトをエンコードします。
      戻り値:
      エンコーダ実装クラス、存在しない場合は空のリスト。

    • getDecoders

      ListSE<ClassSE<? extends Decoder>> getDecoders()
      構成されたデコーダー実装クラスを返します。これらはコンテナーによってインスタンス化され、MessageHandler.Whole.onMessage(Object) コールバックで受信メッセージを予期されるカスタムオブジェクトにデコードします。
      戻り値:
      デコーダー実装クラス、存在しない場合は空のリスト。

    • getUserProperties

      MapSE<StringSE,ObjectSE> getUserProperties()
      このメソッドは、開発者がこの構成インスタンスを使用するエンドポイントに関連するアプリケーション固有の情報を格納するために使用できる変更可能なマップを返します。Web コンテナーの分散実装で実行されている Web ソケットアプリケーションは、ここに格納されているアプリケーション固有のオブジェクトを java.io.Serializable にする必要があります。そうしないと、フェイルオーバー後にオブジェクトが再作成されない場合があります。
      戻り値:
      アプリケーションデータの変更可能なマップ。