DefaultStompSession (Spring Framework 4.3.23.RELEASE API)

java.lang.ObjectSE
- org.springframework.messaging.simp.stomp.DefaultStompSession

実装されているすべてのインターフェース:
ConnectionHandlingStompSession, StompSession, TcpConnectionHandler<byte[]>
```
public class DefaultStompSession
extends ObjectSE
implements ConnectionHandlingStompSession
```
ConnectionHandlingStompSession のデフォルト実装。
導入:
4.2
作成者:
Rossen Stoyanchev

ネストされたクラスの要約
- インターフェース org.springframework.messaging.simp.stomp.StompSession から継承されたネストクラス / インターフェース
  StompSession.Receiptable, StompSession.Subscription

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static byte[] EMPTY_PAYLOAD

フィールド
修飾子と型	フィールドと説明
`static byte[]`	`EMPTY_PAYLOAD`

コンストラクターの概要
コンストラクター
コンストラクターと説明
DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)
新しいセッションを作成します。

コンストラクター
コンストラクターと説明
`DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)` 新しいセッションを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StompSession.Receiptable`	`acknowledge(StringSE messageId, boolean consumed)` メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。
`void`	`afterConnected(TcpConnection<byte[]> connection)` 接続が正常に確立された後に呼び出されます。
`void`	`afterConnectFailure(ThrowableSE ex)` 接続に失敗したときに呼び出されます。
`void`	`afterConnectionClosed()` 接続が閉じた後に呼び出されます。
`void`	`disconnect()` DISCONNECT フレームを送信してセッションを切断します。
`MessageConverter`	`getMessageConverter()` 設定された `MessageConverter` を返します。
`long`	`getReceiptTimeLimit()` レシートの有効期限が切れる前に、構成された制限時間を返します。
`ListenableFuture<StompSession>`	`getSessionFuture()` セッションが使用可能になったときに完了するフューチャーを返します。
`StompSessionHandler`	`getSessionHandler()` 設定されたセッションハンドラーを返します。
`StringSE`	`getSessionId()` セッションの ID を返します。
`TaskScheduler`	`getTaskScheduler()` 構成済みの TaskScheduler を受け取り、レシート追跡に使用します。
`void`	`handleFailure(ThrowableSE ex)` 接続の失敗を処理します。
`void`	`handleMessage(Message<byte[]> message)` リモートホストから受信したメッセージを処理します。
`boolean`	`isAutoReceiptEnabled()` 受信ヘッダーを自動的に追加するかどうか。
`boolean`	`isConnected()` セッションが接続されているかどうか。
`StompSession.Receiptable`	`send(StompHeaders stompHeaders, ObjectSE payload)` 宛先だけではなく、完全な `StompHeaders` を備えた `StompSession.send(String, Object)` のオーバーロードバージョン。
`StompSession.Receiptable`	`send(StringSE destination, ObjectSE payload)` `MessageConverter` を使用してペイロードを `byte[]` に変換し、指定された宛先にメッセージを送信します。
`void`	`setAutoReceipt(boolean autoReceiptEnabled)` 有効にすると、このセッションの今後の `send` および `subscribe` 操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。
`void`	`setMessageConverter(MessageConverter messageConverter)` オブジェクト型または予期されるオブジェクト型と "content-type" ヘッダーに基づいて、受信メッセージと発信メッセージのペイロードを `byte[]` との間で変換するために使用する `MessageConverter` を設定します。
`void`	`setReceiptTimeLimit(long receiptTimeLimit)` レシートが期限切れになるまでの時間をミリ秒単位で構成します。
`void`	`setTaskScheduler(TaskScheduler taskScheduler)` 領収書の追跡に使用する TaskScheduler を構成します。
`StompSession.Subscription`	`subscribe(StompHeaders stompHeaders, StompFrameHandler handler)` 宛先だけではなく、完全な `StompHeaders` を備えた `StompSession.subscribe(String, StompFrameHandler)` のオーバーロードバージョン。
`StompSession.Subscription`	`subscribe(StringSE destination, StompFrameHandler handler)` SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定された `StompFrameHandler` で受信メッセージを処理します。

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

- フィールドの詳細
  - EMPTY_PAYLOAD
```
public static final byte[] EMPTY_PAYLOAD
```
- コンストラクターの詳細
  - DefaultStompSession
```
public DefaultStompSession(StompSessionHandler sessionHandler,
                           StompHeaders connectHeaders)
```
    新しいセッションを作成します。
    パラメーター:
    sessionHandler - セッションのアプリケーションハンドラー
    connectHeaders - STOMP CONNECT フレームのヘッダー
- メソッドの詳細
  - getSessionId
```
public StringSE getSessionId()
```
    インターフェースからコピーされた説明: StompSession
    セッションの ID を返します。
    次で指定:
    インターフェース StompSession の getSessionId
  - getSessionHandler
```
public StompSessionHandler getSessionHandler()
```
    設定されたセッションハンドラーを返します。
  - getSessionFuture
```
public ListenableFuture<StompSession> getSessionFuture()
```
    インターフェースからコピーされた説明: ConnectionHandlingStompSession
    セッションが使用可能になったときに完了するフューチャーを返します。
    次で指定:
    インターフェース ConnectionHandlingStompSession の getSessionFuture
  - setMessageConverter
```
public void setMessageConverter(MessageConverter messageConverter)
```
    オブジェクト型または予期されるオブジェクト型と "content-type" ヘッダーに基づいて、受信メッセージと発信メッセージのペイロードを byte[] との間で変換するために使用する MessageConverter を設定します。
    デフォルトでは、SimpleMessageConverter が構成されています。
    パラメーター:
    messageConverter - 使用するメッセージコンバーター
  - getMessageConverter
```
public MessageConverter getMessageConverter()
```
    設定された MessageConverter を返します。
  - setTaskScheduler
```
public void setTaskScheduler(TaskScheduler taskScheduler)
```
    領収書の追跡に使用する TaskScheduler を構成します。
  - getTaskScheduler
```
public TaskScheduler getTaskScheduler()
```
    構成済みの TaskScheduler を受け取り、レシート追跡に使用します。
  - setReceiptTimeLimit
```
public void setReceiptTimeLimit(long receiptTimeLimit)
```
    レシートが期限切れになるまでの時間をミリ秒単位で構成します。
    デフォルトでは 15,000 (15 秒に設定されています）。
  - getReceiptTimeLimit
```
public long getReceiptTimeLimit()
```
    レシートの有効期限が切れる前に、構成された制限時間を返します。
  - setAutoReceipt
```
public void setAutoReceipt(boolean autoReceiptEnabled)
```
    インターフェースからコピーされた説明: StompSession
    有効にすると、このセッションの今後の send および subscribe 操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。アプリケーションは、操作から返された Receiptable を使用して、領収書を追跡できます。
    StompHeaders を受け入れるオーバーロードされたメソッドを使用して、受信ヘッダーを手動で追加することもできます。
    次で指定:
    インターフェース StompSession の setAutoReceipt
  - isAutoReceiptEnabled
```
public boolean isAutoReceiptEnabled()
```
    受信ヘッダーを自動的に追加するかどうか。
  - isConnected
```
public boolean isConnected()
```
    インターフェースからコピーされた説明: StompSession
    セッションが接続されているかどうか。
    次で指定:
    インターフェース StompSession の isConnected
  - send
```
public StompSession.Receiptable send(StringSE destination,
                                     ObjectSE payload)
```
    インターフェースからコピーされた説明: StompSession
    MessageConverter を使用してペイロードを byte[] に変換し、指定された宛先にメッセージを送信します。
    次で指定:
    インターフェース StompSession の send
    パラメーター:
    destination - メッセージの送信先
    payload - メッセージペイロード
    戻り値:
    領収書を追跡するための Receiptable
  - send
```
public StompSession.Receiptable send(StompHeaders stompHeaders,
                                     ObjectSE payload)
```
    インターフェースからコピーされた説明: StompSession
    宛先だけではなく、完全な StompHeaders を備えた StompSession.send(String, Object) のオーバーロードバージョン。ヘッダーには宛先が含まれている必要があり、ブローカーがサブスクライバーに伝搬するための「コンテンツ型」やカスタムヘッダーなどの他のヘッダー、またはブローカー固有の非標準ヘッダーが含まれる場合もあります。
    次で指定:
    インターフェース StompSession の send
    パラメーター:
    stompHeaders - メッセージヘッダー
    payload - メッセージペイロード
    戻り値:
    領収書を追跡するための Receiptable
  - subscribe
```
public StompSession.Subscription subscribe(StringSE destination,
                                           StompFrameHandler handler)
```
    インターフェースからコピーされた説明: StompSession
    SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定された StompFrameHandler で受信メッセージを処理します。
    次で指定:
    インターフェース StompSession の subscribe
    パラメーター:
    destination - 購読する宛先
    handler - 受信したメッセージのハンドラー
    戻り値:
    領収書の登録解除および / または追跡に使用するハンドル
  - subscribe
```
public StompSession.Subscription subscribe(StompHeaders stompHeaders,
                                           StompFrameHandler handler)
```
    インターフェースからコピーされた説明: StompSession
    宛先だけではなく、完全な StompHeaders を備えた StompSession.subscribe(String, StompFrameHandler) のオーバーロードバージョン。
    次で指定:
    インターフェース StompSession の subscribe
    パラメーター:
    stompHeaders - サブスクライブメッセージフレームのヘッダー
    handler - 受信したメッセージのハンドラー
    戻り値:
    領収書の登録解除および / または追跡に使用するハンドル
  - acknowledge
```
public StompSession.Receiptable acknowledge(StringSE messageId,
                                            boolean consumed)
```
    インターフェースからコピーされた説明: StompSession
    メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。
    注意 : サブスクライブするときにこれを使用するには、これを使用するために、ack ヘッダーを "client" または "client-individual" に設定する必要があります。
    次で指定:
    インターフェース StompSession の acknowledge
    パラメーター:
    messageId - メッセージの ID
    consumed - メッセージが消費されたかどうか
    戻り値:
    領収書を追跡するための Receiptable
  - disconnect
```
public void disconnect()
```
    インターフェースからコピーされた説明: StompSession
    DISCONNECT フレームを送信してセッションを切断します。
    次で指定:
    インターフェース StompSession の disconnect
  - afterConnected
```
public void afterConnected(TcpConnection<byte[]> connection)
```
    インターフェースからコピーされた説明: TcpConnectionHandler
    接続が正常に確立された後に呼び出されます。
    次で指定:
    インターフェース TcpConnectionHandler<byte[]> の afterConnected
    パラメーター:
    connection - 接続
  - afterConnectFailure
```
public void afterConnectFailure(ThrowableSE ex)
```
    インターフェースからコピーされた説明: TcpConnectionHandler
    接続に失敗したときに呼び出されます。
    次で指定:
    インターフェース TcpConnectionHandler<byte[]> の afterConnectFailure
    パラメーター:
    ex - 例外
  - handleMessage
```
public void handleMessage(Message<byte[]> message)
```
    インターフェースからコピーされた説明: TcpConnectionHandler
    リモートホストから受信したメッセージを処理します。
    次で指定:
    インターフェース TcpConnectionHandler<byte[]> の handleMessage
    パラメーター:
    message - メッセージ
  - handleFailure
```
public void handleFailure(ThrowableSE ex)
```
    インターフェースからコピーされた説明: TcpConnectionHandler
    接続の失敗を処理します。
    次で指定:
    インターフェース TcpConnectionHandler<byte[]> の handleFailure
    パラメーター:
    ex - 例外
  - afterConnectionClosed
```
public void afterConnectionClosed()
```
    インターフェースからコピーされた説明: TcpConnectionHandler
    接続が閉じた後に呼び出されます。
    次で指定:
    インターフェース TcpConnectionHandler<byte[]> の afterConnectionClosed

クラス DefaultStompSession

ネストされたクラスの要約

インターフェース org.springframework.messaging.simp.stomp.StompSession から継承されたネストクラス / インターフェース

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

フィールドの詳細

EMPTY_PAYLOAD

コンストラクターの詳細

DefaultStompSession

メソッドの詳細

getSessionId

getSessionHandler

getSessionFuture

setMessageConverter

getMessageConverter

setTaskScheduler

getTaskScheduler

setReceiptTimeLimit

getReceiptTimeLimit

setAutoReceipt

isAutoReceiptEnabled

isConnected

send

send

subscribe

subscribe

acknowledge

disconnect

afterConnected

afterConnectFailure

handleMessage

handleFailure

afterConnectionClosed