AbstractSockJsSession (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

実装されたすべてのインターフェース:
CloseableSE, AutoCloseableSE, SockJsSession, WebSocketSession
既知の直属サブクラス
AbstractHttpSockJsSession, WebSocketServerSockJsSession
```
public abstract class AbstractSockJsSession
extends ObjectSE
implements SockJsSession
```
SockJsSession を実装する SockJS セッションの抽象基本クラス。
導入:
4.0
作成者:
Rossen Stoyanchev, Sam Brannen

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DISCONNECTED_CLIENT_LOG_CATEGORY` クライアントが去った後にネットワーク IO 例外で使用するログカテゴリ。
`protected static Log`	`disconnectedClientLogger` クライアントが去った後、ネットワーク IO 障害で使用する別のロガー。
`protected Log`	`logger`
`protected ObjectSE`	`responseLock`

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

コンストラクター
コンストラクターと説明
`AbstractSockJsSession(StringSE id, SockJsServiceConfig config, WebSocketHandler handler, MapSE<StringSE, ObjectSE> attributes)` 新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`cancelHeartbeat()`
`void`	`close()` クリーンアップを実行し、`WebSocketHandler` に通知します。
`void`	`close(CloseStatus status)` クリーンアップを実行し、`WebSocketHandler` に通知します。
`void`	`delegateConnectionClosed(CloseStatus status)` 基本となる接続が閉じられたときに呼び出されます。
`void`	`delegateConnectionEstablished()`
`void`	`delegateError(ThrowableSE ex)`
`void`	`delegateMessages(StringSE... messages)`
`void`	`disableHeartbeat()` SockJS ハートビートを無効にします。これは、おそらく上位レベルのプロトコルですでにセッションに対してハートビートが有効になっているためです。
`protected abstract void`	`disconnect(CloseStatus status)` 実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。
`MapSE<StringSE, ObjectSE>`	`getAttributes()` WebSocket セッションに関連付けられた属性を持つマップを返します。
`StringSE`	`getId()` 一意のセッション識別子を返します。
`protected SockJsMessageCodec`	`getMessageCodec()`
`SockJsServiceConfig`	`getSockJsServiceConfig()`
`long`	`getTimeSinceLastActive()` セッションが最後にアクティブになってからの時間（ミリ秒単位）を返します。セッションが新しい場合は、セッションが作成されてからの時間を返します。
`abstract boolean`	`isActive()` ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。
`boolean`	`isClosed()`
`boolean`	`isNew()`
`boolean`	`isOpen()` 基になる接続が開いているかどうか。
`protected void`	`scheduleHeartbeat()`
`protected void`	`sendHeartbeat()`
`void`	`sendMessage(WebSocketMessage<?> message)` WebSocket メッセージを送信する: `TextMessage` または `BinaryMessage` のいずれか。
`protected abstract void`	`sendMessageInternal(StringSE message)`
`StringSE`	`toString()`
`void`	`tryCloseWithSockJsTransportError(ThrowableSE error, CloseStatus closeStatus)` SockJS トランスポートの処理に起因するエラーのため、終了します。
`protected void`	`updateLastActiveTime()` セッションが非アクティブになるたびに呼び出されます。
`protected void`	`writeFrame(SockJsFrame frame)` TransportHandler および（TransportHandler 固有の）セッションクラス内で内部的に使用します。
`protected abstract void`	`writeFrameInternal(SockJsFrame frame)`

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

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

- フィールドの詳細
  - DISCONNECTED_CLIENT_LOG_CATEGORY
```
public static final StringSE DISCONNECTED_CLIENT_LOG_CATEGORY
```
    クライアントが去った後にネットワーク IO 例外で使用するログカテゴリ。
    サーブレットコンテナーは、クライアントが切断したコールバックを公開しません。eclipse-ee4j/servlet-api#44 を参照してください。クライアントが去ったためにネットワーク IO 障害が発生する可能性があり、不要なスタックトレースでログがいっぱいになる可能性があります。
    サーバーごとにこのようなネットワーク障害を特定し、別のログカテゴリに記録するよう最善を尽くしています。完全なスタックトレースが TRACE レベルで表示されている間、単純な 1 行のメッセージがデバッグレベルでログに記録されます。
    関連事項:
    disconnectedClientLogger, 定数フィールド値
  - disconnectedClientLogger
```
protected static final Log disconnectedClientLogger
```
    クライアントが去った後、ネットワーク IO 障害で使用する別のロガー。
    関連事項:
    DISCONNECTED_CLIENT_LOG_CATEGORY
  - logger
```
protected final Log logger
```
  - responseLock
```
protected final ObjectSE responseLock
```
- コンストラクターの詳細
  - AbstractSockJsSession
```
public AbstractSockJsSession(StringSE id,
                             SockJsServiceConfig config,
                             WebSocketHandler handler,
                             @Nullable
                             MapSE<StringSE,ObjectSE> attributes)
```
    新しいインスタンスを作成します。
    パラメーター:
    id - セッション ID
    config - SockJS サービス構成オプション
    handler - SockJS メッセージの受信者
    attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。
- メソッドの詳細
  - getId
```
public StringSE getId()
```
    インターフェースからコピーされた説明: WebSocketSession
    一意のセッション識別子を返します。
    次で指定:
    インターフェース WebSocketSession の getId
  - getMessageCodec
```
protected SockJsMessageCodec getMessageCodec()
```
  - getSockJsServiceConfig
```
public SockJsServiceConfig getSockJsServiceConfig()
```
  - getAttributes
```
public MapSE<StringSE,ObjectSE> getAttributes()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket セッションに関連付けられた属性を持つマップを返します。
    サーバー側では、最初に HandshakeInterceptor を介してマップにデータを入力できます。クライアント側では、WebSocketClient ハンドシェイクメソッドを介してマップにデータを入力できます。
    次で指定:
    インターフェース WebSocketSession の getAttributes
    戻り値:
    セッション属性を持つマップ (非 null)
  - sendMessage
```
public final void sendMessage(WebSocketMessage<?> message)
                       throws IOExceptionSE
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket メッセージを送信する: TextMessage または BinaryMessage のいずれか。
    注意 : 基礎となる標準 WebSocket セッション（JSR-356）は同時送信を許可しません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、WebSocketSession を ConcurrentWebSocketSessionDecorator でラップすることです。
    次で指定:
    インターフェース WebSocketSession の sendMessage
    例外:
    IOExceptionSE
    関連事項:
    ConcurrentWebSocketSessionDecorator
  - sendMessageInternal
```
protected abstract void sendMessageInternal(StringSE message)
                                     throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - isNew
```
public boolean isNew()
```
  - isOpen
```
public boolean isOpen()
```
    インターフェースからコピーされた説明: WebSocketSession
    基になる接続が開いているかどうか。
    次で指定:
    インターフェース WebSocketSession の isOpen
  - isClosed
```
public boolean isClosed()
```
  - close
```
public final void close()
                 throws IOExceptionSE
```
    クリーンアップを実行し、WebSocketHandler に通知します。
    次で指定:
    インターフェース CloseableSE の closeSE
    次で指定:
    インターフェース AutoCloseableSE の closeSE
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    IOExceptionSE
  - close
```
public final void close(CloseStatus status)
                 throws IOExceptionSE
```
    クリーンアップを実行し、WebSocketHandler に通知します。
    次で指定:
    インターフェース WebSocketSession の close
    例外:
    IOExceptionSE
  - getTimeSinceLastActive
```
public long getTimeSinceLastActive()
```
    インターフェースからコピーされた説明: SockJsSession
    セッションが最後にアクティブになってからの時間（ミリ秒単位）を返します。セッションが新しい場合は、セッションが作成されてからの時間を返します。
    次で指定:
    インターフェース SockJsSession の getTimeSinceLastActive
  - updateLastActiveTime
```
protected void updateLastActiveTime()
```
    セッションが非アクティブになるたびに呼び出されます。
  - disableHeartbeat
```
public void disableHeartbeat()
```
    インターフェースからコピーされた説明: SockJsSession
    SockJS ハートビートを無効にします。これは、おそらく上位レベルのプロトコルですでにセッションに対してハートビートが有効になっているためです。プロキシが接続がハングしていないことを知るのに役立つため、これを無効にすることはお勧めしません。
    次で指定:
    インターフェース SockJsSession の disableHeartbeat
  - sendHeartbeat
```
protected void sendHeartbeat()
                      throws SockJsTransportFailureException
```
    例外:
    SockJsTransportFailureException
  - scheduleHeartbeat
```
protected void scheduleHeartbeat()
```
  - cancelHeartbeat
```
protected void cancelHeartbeat()
```
  - isActive
```
public abstract boolean isActive()
```
    ポーリングセッションとストリーミングセッションは、定期的に現在の HTTP リクエストを閉じ、次のリクエストが送信されるのを待ちます。この「ダウンタイム」の間、セッションはまだ開いていますが、非アクティブであり、メッセージを送信できないため、メッセージを一時的にバッファする必要があります。対照的に、WebSocket セッションはステートフルであり、閉じられるまでアクティブのままです。
  - disconnect
```
protected abstract void disconnect(CloseStatus status)
                            throws IOExceptionSE
```
    実際に基になる WebSocket セッションを閉じるか、HTTP トランスポートの場合は基になるリクエストを完了します。
    例外:
    IOExceptionSE
  - writeFrame
```
protected void writeFrame(SockJsFrame frame)
                   throws SockJsTransportFailureException
```
    TransportHandler および（TransportHandler 固有の）セッションクラス内で内部的に使用します。
    例外:
    SockJsTransportFailureException
  - writeFrameInternal
```
protected abstract void writeFrameInternal(SockJsFrame frame)
                                    throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - delegateConnectionEstablished
```
public void delegateConnectionEstablished()
                                   throws ExceptionSE
```
    例外:
    ExceptionSE
  - delegateMessages
```
public void delegateMessages(StringSE... messages)
                      throws SockJsMessageDeliveryException
```
    例外:
    SockJsMessageDeliveryException
  - delegateConnectionClosed
```
public final void delegateConnectionClosed(CloseStatus status)
                                    throws ExceptionSE
```
    基本となる接続が閉じられたときに呼び出されます。
    例外:
    ExceptionSE
  - tryCloseWithSockJsTransportError
```
public void tryCloseWithSockJsTransportError(ThrowableSE error,
                                             CloseStatus closeStatus)
```
    SockJS トランスポートの処理に起因するエラーのため、終了します。
  - delegateError
```
public void delegateError(ThrowableSE ex)
                   throws ExceptionSE
```
    例外:
    ExceptionSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス AbstractSockJsSession

フィールドサマリー

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

メソッドのサマリー

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

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

フィールドの詳細

DISCONNECTED_CLIENT_LOG_CATEGORY

disconnectedClientLogger

logger

responseLock

コンストラクターの詳細

AbstractSockJsSession

メソッドの詳細

getId

getMessageCodec

getSockJsServiceConfig

getAttributes

sendMessage

sendMessageInternal

isNew

isOpen

isClosed

close

close

getTimeSinceLastActive

updateLastActiveTime

disableHeartbeat

sendHeartbeat

scheduleHeartbeat

cancelHeartbeat

isActive

disconnect

writeFrame

writeFrameInternal

delegateConnectionEstablished

delegateMessages

delegateConnectionClosed

tryCloseWithSockJsTransportError

delegateError

toString