パッケージ jakarta.faces.push

インターフェース PushContext

すべてのスーパーインターフェース:
SerializableSE
public interface PushContext extends SerializableSE

@Push で識別されるプッシュソケットチャネルにメッセージオブジェクトを送信するための CDI インターフェース。これは、WAR のコンテナー管理アーティファクトに @Push を介して注入できます。

 @Inject
 @Push
 private PushContext channelName;

詳しい使用方法については、@Push javadoc を参照してください。

導入:
2.3
関連事項:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME
    起動時に Web ソケットエンドポイントを明示的に有効にするブールコンテキストパラメーター名。
    static final StringSE
    URI_PREFIX
    エンドポイントがリッスンする必要があるコンテキスト相対 Web ソケット URI プレフィックス。
    static final StringSE
    WEBSOCKET_ENDPOINT_PORT_PARAM_NAME
    HTTP ポートとは異なる場合に WebSocket エンドポイントポートを指定する整数コンテキストパラメーター名。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    SetSE<FutureSE<VoidSE>>
    send(ObjectSE message)
    @Push で識別されるように、指定されたメッセージオブジェクトをプッシュソケットチャネルに送信します。
    <S extends SerializableSE>
    MapSE<S,SetSE<FutureSE<VoidSE>>>
    send(ObjectSE message, CollectionSE<S> users)
    <f:websocket user> で識別される特定のユーザーを対象として、@Push で識別されるプッシュソケットチャネルに特定のメッセージオブジェクトを送信します。
    <S extends SerializableSE>
    SetSE<FutureSE<VoidSE>>
    send(ObjectSE message, S user)
    <f:websocket user> で識別される特定のユーザーを対象として、@Push で識別されるプッシュソケットチャネルに指定されたメッセージオブジェクトを送信します。

  • フィールドの詳細

    • ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME

      static final StringSE ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME
      起動時に Web ソケットエンドポイントを明示的に有効にするブールコンテキストパラメーター名。
      関連事項:

    • WEBSOCKET_ENDPOINT_PORT_PARAM_NAME

      static final StringSE WEBSOCKET_ENDPOINT_PORT_PARAM_NAME
      HTTP ポートとは異なる場合に WebSocket エンドポイントポートを指定する整数コンテキストパラメーター名。
      関連事項:

    • URI_PREFIX

      static final StringSE URI_PREFIX
      エンドポイントがリッスンする必要があるコンテキスト相対 Web ソケット URI プレフィックス。
      関連事項:

  • メソッドの詳細

    • send

      SetSE<FutureSE<VoidSE>> send(ObjectSE message)
      @Push で識別されるように、指定されたメッセージオブジェクトをプッシュソケットチャネルに送信します。メッセージオブジェクトは JSON としてエンコードされ、<f:websocket onmessage> で宣言された JavaScript リスナー関数の最初の引数として使用できます。
      パラメーター:
      message - プッシュメッセージオブジェクト。
      戻り値:
      送信操作の結果。空のセットが返される場合、指定されたソケットチャネルに関連付けられた開いている Web ソケットセッションはありませんでした。返される先物は、メッセージが正常に配信された場合は Future.get() で null を返し、それ以外の場合は ExecutionExceptionSE をスローします。
      例外:
      IllegalArgumentExceptionSE - 指定されたメッセージオブジェクトを JSON としてエンコードできない場合。
      関連事項:

    • send

      <S extends SerializableSE> SetSE<FutureSE<VoidSE>> send(ObjectSE message, S user)
      <f:websocket user> で識別される特定のユーザーを対象として、@Push で識別されるプッシュソケットチャネルに指定されたメッセージオブジェクトを送信します。メッセージオブジェクトは JSON としてエンコードされ、<f:websocket onmessage> で宣言された JavaScript リスナー関数の最初の引数として使用できます。
      型パラメーター:
      S - ユーザー ID の総称型。
      パラメーター:
      message - プッシュメッセージオブジェクト。
      user - プッシュメッセージオブジェクトの配信先となるユーザー。
      戻り値:
      送信操作の結果。空のセットが返される場合、指定されたソケットチャネルとユーザーに関連付けられた開いている Web ソケットセッションはありませんでした。返される先物は、メッセージが正常に配信された場合は Future.get() で null を返し、それ以外の場合は ExecutionExceptionSE をスローします。
      例外:
      IllegalArgumentExceptionSE - 指定されたメッセージオブジェクトを JSON としてエンコードできない場合。
      関連事項:

    • send

      <S extends SerializableSE> MapSE<S,SetSE<FutureSE<VoidSE>>> send(ObjectSE message, CollectionSE<S> users)
      <f:websocket user> で識別される特定のユーザーを対象として、@Push で識別されるプッシュソケットチャネルに特定のメッセージオブジェクトを送信します。メッセージオブジェクトは JSON としてエンコードされ、<f:websocket onmessage> で宣言された JavaScript リスナー関数の最初の引数として使用できます。
      型パラメーター:
      S - ユーザー ID の総称型。
      パラメーター:
      message - プッシュメッセージオブジェクト。
      users - プッシュメッセージオブジェクトの配信先となるユーザー。
      戻り値:
      ユーザーごとにグループ化された送信操作の結果。空のセットが含まれている場合、指定されたソケットチャネルとユーザーに関連付けられた開いている Web ソケットセッションはありませんでした。返される先物は、メッセージが正常に配信された場合は Future.get() で null を返し、それ以外の場合は ExecutionExceptionSE をスローします。
      例外:
      IllegalArgumentExceptionSE - 指定されたメッセージオブジェクトを JSON としてエンコードできない場合。
      関連事項: