AbstractClientSockJsSession (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

実装されているすべてのインターフェース:
CloseableSE, AutoCloseableSE, WebSocketSession
既知の直属サブクラス
WebSocketClientSockJsSession, XhrClientSockJsSession
```
public abstract class AbstractClientSockJsSession
extends ObjectSE
implements WebSocketSession
```
WebSocketSession の SockJS クライアント実装の基本クラス。受信 SockJS メッセージフレームの処理を提供し、ライフサイクルイベントとメッセージを（アプリケーション）WebSocketHandler に委譲します。サブクラスは、実際の送信と切断ロジックを実装します。
導入:
4.1
作成者:
Rossen Stoyanchev, Juergen Hoeller

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterTransportClosed(CloseStatus closeStatus)`
`void`	`close()` ステータス 1000 で WebSocket 接続を閉じます。
`void`	`close(CloseStatus status)` 指定されたクローズ状態で WebSocket 接続を閉じます。
`protected void`	`closeInternal(CloseStatus status)`
`protected abstract void`	`disconnect(CloseStatus status)`
`MapSE<StringSE, ObjectSE>`	`getAttributes()` WebSocket セッションに関連付けられた属性を持つマップを返します。
`HttpHeaders`	`getHandshakeHeaders()` ハンドシェイクリクエストで使用されるヘッダーを返します（非 `null`）。
`StringSE`	`getId()` 一意のセッション識別子を返します。
`SockJsMessageCodec`	`getMessageCodec()`
`PrincipalSE`	`getPrincipal()` 認証されたユーザーの名前を含む `Principal`SE インスタンスを返します。
`URISE`	`getUri()` WebSocket 接続を開くために使用される URI を返します。
`WebSocketHandler`	`getWebSocketHandler()`
`void`	`handleFrame(StringSE payload)`
`void`	`handleTransportError(ThrowableSE error)`
`boolean`	`isDisconnected()`
`boolean`	`isOpen()` 基になる接続が開いているかどうか。
`protected abstract void`	`sendInternal(TextMessage textMessage)`
`void`	`sendMessage(WebSocketMessage<?> message)` WebSocket メッセージを送信する: `TextMessage` または `BinaryMessage` のいずれか。
`StringSE`	`toString()`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.web.socket.WebSocketSession から継承されたメソッド
getAcceptedProtocol, getBinaryMessageSizeLimit, getExtensions, getLocalAddress, getRemoteAddress, getTextMessageSizeLimit, setBinaryMessageSizeLimit, setTextMessageSizeLimit

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractClientSockJsSession
```
protected AbstractClientSockJsSession(TransportRequest request,
                                      WebSocketHandler handler,
                                      SettableListenableFuture<WebSocketSession> connectFuture)
```
- メソッドの詳細
  - getId
```
public StringSE getId()
```
    インターフェースからコピーされた説明: WebSocketSession
    一意のセッション識別子を返します。
    次で指定:
    インターフェース WebSocketSession の getId
  - getUri
```
public URISE getUri()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket 接続を開くために使用される URI を返します。
    次で指定:
    インターフェース WebSocketSession の getUri
  - getHandshakeHeaders
```
public HttpHeaders getHandshakeHeaders()
```
    インターフェースからコピーされた説明: WebSocketSession
    ハンドシェイクリクエストで使用されるヘッダーを返します（非 null）。
    次で指定:
    インターフェース WebSocketSession の getHandshakeHeaders
  - getAttributes
```
public MapSE<StringSE,ObjectSE> getAttributes()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket セッションに関連付けられた属性を持つマップを返します。
    サーバー側では、最初に HandshakeInterceptor を介してマップにデータを入力できます。クライアント側では、WebSocketClient ハンドシェイクメソッドを介してマップにデータを入力できます。
    次で指定:
    インターフェース WebSocketSession の getAttributes
    戻り値:
    セッション属性を持つマップ (非 null)
  - getPrincipal
```
public PrincipalSE getPrincipal()
```
    インターフェースからコピーされた説明: WebSocketSession
    認証されたユーザーの名前を含む PrincipalSE インスタンスを返します。
    ユーザーが認証されていない場合、メソッドは null を返します。
    次で指定:
    インターフェース WebSocketSession の getPrincipal
  - getMessageCodec
```
public SockJsMessageCodec getMessageCodec()
```
  - getWebSocketHandler
```
public WebSocketHandler getWebSocketHandler()
```
  - isOpen
```
public boolean isOpen()
```
    インターフェースからコピーされた説明: WebSocketSession
    基になる接続が開いているかどうか。
    次で指定:
    インターフェース WebSocketSession の isOpen
  - isDisconnected
```
public boolean isDisconnected()
```
  - sendMessage
```
public final void sendMessage(WebSocketMessage<?> message)
                       throws IOExceptionSE
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket メッセージを送信する: TextMessage または BinaryMessage のいずれか。
    注意 : 基盤となる標準の WebSocket セッション（JSR-356）では、同時送信は許可されていません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、WebSocketSession を ConcurrentWebSocketSessionDecorator でラップすることです。
    次で指定:
    インターフェース WebSocketSession の sendMessage
    例外:
    IOExceptionSE
    関連事項:
    ConcurrentWebSocketSessionDecorator
  - sendInternal
```
protected abstract void sendInternal(TextMessage textMessage)
                              throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - close
```
public final void close()
                 throws IOExceptionSE
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket 接続をステータス 1000 で閉じます。
```
 session.close(CloseStatus.NORMAL);
 
```
    次で指定:
    インターフェース CloseableSE の closeSE
    次で指定:
    インターフェース AutoCloseableSE の closeSE
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    IOExceptionSE
  - close
```
public final void close(CloseStatus status)
                 throws IOExceptionSE
```
    インターフェースからコピーされた説明: WebSocketSession
    指定されたクローズ状態で WebSocket 接続を閉じます。
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    IOExceptionSE
  - closeInternal
```
protected void closeInternal(CloseStatus status)
                      throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - disconnect
```
protected abstract void disconnect(CloseStatus status)
                            throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - handleFrame
```
public void handleFrame(StringSE payload)
```
  - handleTransportError
```
public void handleTransportError(ThrowableSE error)
```
  - afterTransportClosed
```
public void afterTransportClosed(@Nullable
                                 CloseStatus closeStatus)
```
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス AbstractClientSockJsSession

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

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

フィールドの詳細

logger

コンストラクターの詳細

AbstractClientSockJsSession

メソッドの詳細

getId

getUri

getHandshakeHeaders

getAttributes

getPrincipal

getMessageCodec

getWebSocketHandler

isOpen

isDisconnected

sendMessage

sendInternal

close

close

closeInternal

disconnect

handleFrame

handleTransportError

afterTransportClosed

toString