クラス SimpAttributes
java.lang.ObjectSE
org.springframework.messaging.simp.SimpAttributes
SiMP セッション (WebSocket セッションなど) に関連付けられた属性にアクセスするためのラッパークラス。
- 導入:
- 4.1
- 作成者:
- Rossen Stoyanchev
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターコンストラクター説明SimpAttributes
(StringSE sessionId, MapSE<StringSE, ObjectSE> attributes) 指定されたセッション属性マップをラップするコンストラクター。メソッドのサマリー
修飾子と型メソッド説明static SimpAttributes
fromMessage
(Message<?> message) 指定されたメッセージから SiMP セッション属性を抽出し、SimpAttributes
インスタンスにラップします。getAttribute
(StringSE name) 指定された名前の属性の値があれば、それを返します。StringSE[]
すべての属性の名前を取得します。関連付けられたセッションの ID を返します。基になるセッションで同期するオブジェクトを公開します。boolean
sessionCompleted()
がすでに呼び出されたかどうか。void
registerDestructionCallback
(StringSE name, RunnableSE callback) 指定された属性の破棄時に実行するコールバックを登録します。void
removeAttribute
(StringSE name) 指定された名前の属性が存在する場合は削除します。void
セッションが完了すると呼び出されます。void
setAttribute
(StringSE name, ObjectSE value) 既存の値(存在する場合)を置き換えて、指定された名前で値を設定します。
フィールドの詳細
SESSION_MUTEX_NAME
mutex セッション属性のキー。SESSION_COMPLETED_NAME
セッションの完了後に設定されるキー。DESTRUCTION_CALLBACK_NAME_PREFIX
破棄コールバックを格納するために使用されるセッション属性の名前の接頭辞。
コンストラクターの詳細
SimpAttributes
指定されたセッション属性マップをラップするコンストラクター。- パラメーター:
sessionId
- 関連付けられたセッションの IDattributes
- 属性
メソッドの詳細
getAttribute
指定された名前の属性の値があれば、それを返します。- パラメーター:
name
- 属性の名前- 戻り値:
- 現在の属性値。見つからない場合は
null
setAttribute
既存の値(存在する場合)を置き換えて、指定された名前で値を設定します。- パラメーター:
name
- 属性の名前value
- 属性の値
removeAttribute
指定された名前の属性が存在する場合は削除します。また、指定された属性に登録されている破棄コールバックがあれば、それも削除します。ただし、コールバックは実行されません。削除されたオブジェクトは、引き続き適切なタイミングで独立して使用および破棄されることが想定されています。
- パラメーター:
name
- 属性の名前
getAttributeNames
すべての属性の名前を取得します。- 戻り値:
- 属性名は文字列配列として、
null
にはなりません
registerDestructionCallback
指定された属性の破棄時に実行するコールバックを登録します。コールバックは、セッションが閉じられたときに実行されます。- パラメーター:
name
- コールバックを登録する属性の名前callback
- 実行される破棄コールバック
getSessionId
関連付けられたセッションの ID を返します。- 戻り値:
- String としてのセッション ID (非
null
)
getSessionMutex
基になるセッションで同期するオブジェクトを公開します。- 戻り値:
- 使用するセッションミューテックス (非
null
)
isSessionCompleted
public boolean isSessionCompleted()sessionCompleted()
がすでに呼び出されたかどうか。sessionCompleted
public void sessionCompleted()セッションが完了すると呼び出されます。実行された完了コールバック。fromMessage
指定されたメッセージから SiMP セッション属性を抽出し、SimpAttributes
インスタンスにラップします。- パラメーター:
message
- セッション属性を抽出するメッセージ