パッケージ org.springframework.web.socket.sockjs.transport.session

クラス WebSocketServerSockJsSession

java.lang.ObjectSE
org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
実装されたすべてのインターフェース:
CloseableSE、AutoCloseableSE、NativeWebSocketSession、SockJsSession、WebSocketSession
public class WebSocketServerSockJsSession extends AbstractSockJsSession implements NativeWebSocketSession
WebSocket トランスポートで使用する SockJS セッション。
導入:
4.0
作成者:
Rossen Stoyanchev, Juergen Hoeller

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

  • メソッドの詳細

    • getUri

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

    • getHandshakeHeaders

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

    • getPrincipal

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

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

      次で指定:
      インターフェース WebSocketSession の getPrincipal 

    • getLocalAddress

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

    • getRemoteAddress

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

    • getAcceptedProtocol

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

    • setTextMessageSizeLimit

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

    • getTextMessageSizeLimit

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

    • setBinaryMessageSizeLimit

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

    • getBinaryMessageSizeLimit

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

    • getExtensions

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

    • getNativeSession

      public ObjectSE getNativeSession()
      インターフェースからコピーされた説明: NativeWebSocketSession
      基礎となるネイティブ WebSocketSession を返します。
      次で指定:
      インターフェース NativeWebSocketSession の getNativeSession 

    • getNativeSession

      @Nullable public <T> T getNativeSession(@Nullable ClassSE<T> requiredType)
      インターフェースからコピーされた説明: NativeWebSocketSession
      使用可能な場合、基礎となるネイティブ WebSocketSession を返します。
      次で指定:
      インターフェース NativeWebSocketSession の getNativeSession 
      パラメーター:
      requiredType - 必要なセッションの型
      戻り値:
      必要な型のネイティブセッション、または利用できない場合は null 

    • initializeDelegateSession

      public void initializeDelegateSession(WebSocketSession session)

    • isActive

      public boolean isActive()
      クラスからコピーされた説明: AbstractSockJsSession
      ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。この「ダウンタイム」の間、セッションはまだ開いていますが、非アクティブであり、メッセージを送信できないため、メッセージを一時的にバッファする必要があります。対照的に、WebSocket セッションはステートフルであり、閉じられるまでアクティブのままです。
      次で指定:
      クラス AbstractSockJsSession の isActive 

    • handleMessage

      public void handleMessage(TextMessage message, WebSocketSession wsSession) throws ExceptionSE
      例外:
      ExceptionSE

    • sendMessageInternal

      public void sendMessageInternal(StringSE message) throws SockJsTransportFailureException
      次で指定:
      クラス AbstractSockJsSession の sendMessageInternal 
      例外:
      SockJsTransportFailureException

    • writeFrameInternal

      protected void writeFrameInternal(SockJsFrame frame) throws IOExceptionSE
      次で指定:
      クラス AbstractSockJsSession の writeFrameInternal 
      例外:
      IOExceptionSE

    • disconnect

      protected void disconnect(CloseStatus status) throws IOExceptionSE
      クラスからコピーされた説明: AbstractSockJsSession
      実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。
      次で指定:
      クラス AbstractSockJsSession の disconnect 
      例外:
      IOExceptionSE