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

フィールドサマリー
クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたフィールド
DISCONNECTED_CLIENT_LOG_CATEGORY, logger, responseLock
コンストラクターのサマリー
コンストラクター
コンストラクター
説明
WebSocketServerSockJsSession(StringSE id, SockJsServiceConfig config, WebSocketHandler handler, MapSE<StringSE,ObjectSE> attributes)
メソッドのサマリー
修飾子と型
メソッド
説明
protected void
disconnect(CloseStatus status)
実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。
StringSE
getAcceptedProtocol()
ネゴシエートされたサブプロトコルを返します。
int
getBinaryMessageSizeLimit()
受信バイナリメッセージの構成済みの最大サイズを取得します。
ListSE<WebSocketExtension>
getExtensions()
ネゴシエートされた拡張機能を決定します。
HttpHeaders
getHandshakeHeaders()
ハンドシェイクリクエストで使用されるヘッダーを返します（非 null）。
InetSocketAddressSE
getLocalAddress()
リクエストが受信されたアドレスを返します。
ObjectSE
getNativeSession()
基礎となるネイティブ WebSocketSession を返します。
<T> T
getNativeSession(ClassSE<T> requiredType)
使用可能な場合、基礎となるネイティブ WebSocketSession を返します。
PrincipalSE
getPrincipal()
認証されたユーザーの名前を含む PrincipalSE インスタンスを返します。
InetSocketAddressSE
getRemoteAddress()
リモートクライアントのアドレスを返します。
int
getTextMessageSizeLimit()
受信テキストメッセージの構成済みの最大サイズを取得します。
URISE
getUri()
WebSocket 接続を開くために使用される URI を返します。
void
handleMessage(TextMessage message, WebSocketSession wsSession)
void
initializeDelegateSession(WebSocketSession session)
boolean
isActive()
ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。
void
sendMessageInternal(StringSE message)
void
setBinaryMessageSizeLimit(int messageSizeLimit)
受信バイナリメッセージの最大サイズを構成します。
void
setTextMessageSizeLimit(int messageSizeLimit)
受信テキストメッセージの最大サイズを構成します。
protected void
writeFrameInternal(SockJsFrame frame)
クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたメソッド
cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, disableHeartbeat, getAttributes, getId, getMessageCodec, getSockJsServiceConfig, getTimeSinceLastActive, isClosed, isNew, isOpen, scheduleHeartbeat, sendHeartbeat, sendMessage, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
close, close, getAttributes, getId, isOpen, sendMessage

コンストラクターの詳細
- WebSocketServerSockJsSession
  public WebSocketServerSockJsSession(StringSE id, SockJsServiceConfig config, WebSocketHandler handler, @Nullable MapSE<StringSE,ObjectSE> attributes)
メソッドの詳細
- getUri
  @Nullable public URISE getUri()
  インターフェースからコピーされた説明: WebSocketSession
  WebSocket 接続を開くために使用される URI を返します。
  次で指定:
  インターフェース WebSocketSession の getUri
- getHandshakeHeaders
  public HttpHeaders getHandshakeHeaders()
  インターフェースからコピーされた説明: WebSocketSession
  ハンドシェイクリクエストで使用されるヘッダーを返します（非 null）。
  次で指定:
  インターフェース WebSocketSession の getHandshakeHeaders
- getPrincipal
  @Nullable public PrincipalSE getPrincipal()
  インターフェースからコピーされた説明: WebSocketSession
  認証されたユーザーの名前を含む PrincipalSE インスタンスを返します。
  ユーザーが認証されていない場合、メソッドは null を返します。
  次で指定:
  インターフェース WebSocketSession の getPrincipal
- getLocalAddress
  @Nullable public InetSocketAddressSE getLocalAddress()
  インターフェースからコピーされた説明: WebSocketSession
  リクエストが受信されたアドレスを返します。
  次で指定:
  インターフェース WebSocketSession の getLocalAddress
- getRemoteAddress
  @Nullable public InetSocketAddressSE getRemoteAddress()
  インターフェースからコピーされた説明: WebSocketSession
  リモートクライアントのアドレスを返します。
  次で指定:
  インターフェース WebSocketSession の getRemoteAddress
- getAcceptedProtocol
  @Nullable 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

クラス WebSocketServerSockJsSession

フィールドサマリー

クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド

コンストラクターの詳細

WebSocketServerSockJsSession

メソッドの詳細

getUri

getHandshakeHeaders

getPrincipal

getLocalAddress

getRemoteAddress

getAcceptedProtocol

setTextMessageSizeLimit

getTextMessageSizeLimit

setBinaryMessageSizeLimit

getBinaryMessageSizeLimit

getExtensions

getNativeSession

getNativeSession

initializeDelegateSession

isActive

handleMessage

sendMessageInternal

writeFrameInternal

disconnect