パッケージ jakarta.faces.event

クラス WebsocketEvent

java.lang.ObjectSE
jakarta.faces.event.WebsocketEvent
実装されているすべてのインターフェース:
SerializableSE
public final class WebsocketEvent extends ObjectSE implements SerializableSE

この Web ソケットイベントは、新しい <f:websocket> が @WebsocketEvent.Opened または @WebsocketEvent.Closed になったときに発生します。アプリケーションスコープの CDI Bean は、@Observes できます。

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

導入:
2.3
関連事項:

  • コンストラクターの詳細

  • メソッドの詳細

    • getChannel

      public StringSE getChannel()
      <f:websocket channel> を返します。
      戻り値:
      Web ソケットチャネル名。

    • getUser

      public <S extends SerializableSE> S getUser()
      <f:websocket user> がある場合は、それを返します。
      型パラメーター:
      S - ユーザー ID の総称型。
      戻り値:
      Web ソケットのユーザー識別子（ある場合）。
      例外:
      ClassCastExceptionSE - S の型が間違っている場合。

    • getCloseCode

      public CloseReason.CloseCode getCloseCode()
      クローズコードを返します。これが null を返す場合、WebsocketEvent.Opened でした。これが非 null を返す場合、WebsocketEvent.Closed でした。
      戻り値:
      クローズコード。

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • equals

      public boolean equals(ObjectSE other)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString