パッケージ org.springframework.web.socket.adapter.standard

クラス StandardWebSocketSession

java.lang.ObjectSE
org.springframework.web.socket.adapter.AbstractWebSocketSession<SessionEE>
org.springframework.web.socket.adapter.standard.StandardWebSocketSession
実装されたすべてのインターフェース:
CloseableSE、AutoCloseableSE、NativeWebSocketSession、WebSocketSession
public class StandardWebSocketSession extends AbstractWebSocketSession<SessionEE>
Java API の標準 WebSocket で使用する WebSocketSession。
導入:
4.0
作成者:
Rossen Stoyanchev

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

    • StandardWebSocketSession

      public StandardWebSocketSession(@Nullable HttpHeaders headers, @Nullable MapSE<StringSE,ObjectSE> attributes, @Nullable InetSocketAddressSE localAddress, @Nullable InetSocketAddressSE remoteAddress)
      標準の WebSocket セッションのコンストラクター。
      パラメーター:
      headers - ハンドシェイクリクエストのヘッダー
      attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。
      localAddress - リクエストが受信されたアドレス
      remoteAddress - リモートクライアントのアドレス

    • StandardWebSocketSession

      public StandardWebSocketSession(@Nullable HttpHeaders headers, @Nullable MapSE<StringSE,ObjectSE> attributes, @Nullable InetSocketAddressSE localAddress, @Nullable InetSocketAddressSE remoteAddress, @Nullable PrincipalSE user)
      ユーザーを WebSocket セッションに関連付けるコンストラクター。
      パラメーター:
      headers - ハンドシェイクリクエストのヘッダー
      attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性
      localAddress - リクエストが受信されたアドレス
      remoteAddress - リモートクライアントのアドレス
      user - セッションに関連付けられたユーザー。null の場合、基礎となる WebSocket セッションで利用可能なユーザーにフォールバックします

  • メソッドの詳細

    • getId

      public StringSE getId()
      インターフェースからコピーされた説明: WebSocketSession
      一意のセッション識別子を返します。

    • getUri

      @Nullable public URISE getUri()
      インターフェースからコピーされた説明: WebSocketSession
      WebSocket 接続を開くために使用される URI を返します。

    • getHandshakeHeaders

      public HttpHeaders getHandshakeHeaders()
      インターフェースからコピーされた説明: WebSocketSession
      ハンドシェイクリクエストで使用されるヘッダーを返します（非 null）。

    • getAcceptedProtocol

      @Nullable public StringSE getAcceptedProtocol()
      インターフェースからコピーされた説明: WebSocketSession
      ネゴシエートされたサブプロトコルを返します。
      戻り値:
      プロトコル識別子、またはプロトコルが指定されていないか正常にネゴシエートされた場合は null 

    • getExtensions

      public ListSE<WebSocketExtension> getExtensions()
      インターフェースからコピーされた説明: WebSocketSession
      ネゴシエートされた拡張機能を決定します。
      戻り値:
      拡張機能のリスト、または拡張機能が指定されていないか正常にネゴシエートされていない場合は空のリスト

    • getPrincipal

      @Nullable public PrincipalSE getPrincipal()
      インターフェースからコピーされた説明: WebSocketSession
      認証されたユーザーの名前を含む PrincipalSE インスタンスを返します。

      ユーザーが認証されていない場合、メソッドは null を返します。

    • getLocalAddress

      @Nullable public InetSocketAddressSE getLocalAddress()
      インターフェースからコピーされた説明: WebSocketSession
      リクエストが受信されたアドレスを返します。

      注意 : localAddress には常にアクセスできるとは限りません。これは、標準 WebSocket クライアントの場合に当てはまります。6.2.x では、StandardWebSocketClient はローカルホストとターゲットアドレスのポート (ローカルポートと同じではありません) に基づいてアドレスを返します。7.0 では、代わりに null を返します。

    • getRemoteAddress

      @Nullable public InetSocketAddressSE getRemoteAddress()
      インターフェースからコピーされた説明: WebSocketSession
      リモートクライアントのアドレスを返します。

    • setTextMessageSizeLimit

      public void setTextMessageSizeLimit(int messageSizeLimit)
      インターフェースからコピーされた説明: WebSocketSession
      受信テキストメッセージの最大サイズを構成します。

    • getTextMessageSizeLimit

      public int getTextMessageSizeLimit()
      インターフェースからコピーされた説明: WebSocketSession
      受信テキストメッセージの構成済みの最大サイズを取得します。

    • setBinaryMessageSizeLimit

      public void setBinaryMessageSizeLimit(int messageSizeLimit)
      インターフェースからコピーされた説明: WebSocketSession
      受信バイナリメッセージの最大サイズを構成します。

    • getBinaryMessageSizeLimit

      public int getBinaryMessageSizeLimit()
      インターフェースからコピーされた説明: WebSocketSession
      受信バイナリメッセージの構成済みの最大サイズを取得します。

    • isOpen

      public boolean isOpen()
      インターフェースからコピーされた説明: WebSocketSession
      基になる接続が開いているかどうか。

    • initializeNativeSession

      public void initializeNativeSession(SessionEE session)
      オーバーライド:
      クラス AbstractWebSocketSession<SessionEE> の initializeNativeSession 

    • sendTextMessage

      protected void sendTextMessage(TextMessage message) throws IOExceptionSE
      次で指定:
      クラス AbstractWebSocketSession<SessionEE> の sendTextMessage 
      例外:
      IOExceptionSE

    • sendBinaryMessage

      protected void sendBinaryMessage(BinaryMessage message) throws IOExceptionSE
      次で指定:
      クラス AbstractWebSocketSession<SessionEE> の sendBinaryMessage 
      例外:
      IOExceptionSE

    • sendPingMessage

      protected void sendPingMessage(PingMessage message) throws IOExceptionSE
      次で指定:
      クラス AbstractWebSocketSession<SessionEE> の sendPingMessage 
      例外:
      IOExceptionSE

    • sendPongMessage

      protected void sendPongMessage(PongMessage message) throws IOExceptionSE
      次で指定:
      クラス AbstractWebSocketSession<SessionEE> の sendPongMessage 
      例外:
      IOExceptionSE

    • closeInternal

      protected void closeInternal(CloseStatus status) throws IOExceptionSE
      次で指定:
      クラス AbstractWebSocketSession<SessionEE> の closeInternal 
      例外:
      IOExceptionSE