public class WebSocketSessionDecorator extends ObjectSE implements WebSocketSession
WebSocketSession
インスタンスをラップし、それに委譲します。 また、装飾されたセッションを返す getDelegate()
メソッドと、すべてのネストされたデリゲートを通過して「最後の」セッションを返す getLastSession()
メソッドも提供します。
コンストラクターと説明 |
---|
WebSocketSessionDecorator(WebSocketSession session) |
修飾子と型 | メソッドと説明 |
---|---|
void | close() ステータス 1000 で WebSocket 接続を閉じます。 |
void | close(CloseStatus status) 指定されたクローズ状態で WebSocket 接続を閉じます。 |
StringSE | getAcceptedProtocol() ネゴシエートされたサブプロトコルを返します。 |
MapSE<StringSE, ObjectSE> | getAttributes() WebSocket セッションに関連付けられた属性を持つマップを返します。 |
int | getBinaryMessageSizeLimit() 受信バイナリメッセージの構成済みの最大サイズを取得します。 |
WebSocketSession | getDelegate() |
ListSE<WebSocketExtension> | getExtensions() ネゴシエートされた拡張機能を決定します。 |
HttpHeaders | getHandshakeHeaders() ハンドシェイクリクエストで使用されるヘッダーを返します(非 null )。 |
StringSE | getId() 一意のセッション識別子を返します。 |
WebSocketSession | getLastSession() |
InetSocketAddressSE | getLocalAddress() リクエストが受信されたアドレスを返します。 |
PrincipalSE | getPrincipal() 認証されたユーザーの名前を含む Principal SE インスタンスを返します。 |
InetSocketAddressSE | getRemoteAddress() リモートクライアントのアドレスを返します。 |
int | getTextMessageSizeLimit() 受信テキストメッセージの構成済みの最大サイズを取得します。 |
URISE | getUri() WebSocket 接続を開くために使用される URI を返します。 |
boolean | isOpen() 基になる接続が開いているかどうか。 |
void | sendMessage(WebSocketMessage<?> message) WebSocket メッセージを送信する: TextMessage または BinaryMessage のいずれか。 |
void | setBinaryMessageSizeLimit(int messageSizeLimit) 受信バイナリメッセージの最大サイズを構成します。 |
void | setTextMessageSizeLimit(int messageSizeLimit) 受信テキストメッセージの最大サイズを構成します。 |
StringSE | toString() |
static WebSocketSession | unwrap(WebSocketSession session) |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE
public WebSocketSessionDecorator(WebSocketSession session)
public WebSocketSession getDelegate()
public WebSocketSession getLastSession()
public static WebSocketSession unwrap(WebSocketSession session)
public StringSE getId()
WebSocketSession
WebSocketSession
の getId
@Nullable public URISE getUri()
WebSocketSession
WebSocketSession
の getUri
public HttpHeaders getHandshakeHeaders()
WebSocketSession
null
)。WebSocketSession
の getHandshakeHeaders
public MapSE<StringSE,ObjectSE> getAttributes()
WebSocketSession
サーバー側では、最初に HandshakeInterceptor
を介してマップにデータを入力できます。クライアント側では、WebSocketClient
ハンドシェイクメソッドを介してマップにデータを入力できます。
WebSocketSession
の getAttributes
null
)public PrincipalSE getPrincipal()
WebSocketSession
Principal
SE インスタンスを返します。 ユーザーが認証されていない場合、メソッドは null
を返します。
WebSocketSession
の getPrincipal
public InetSocketAddressSE getLocalAddress()
WebSocketSession
WebSocketSession
の getLocalAddress
public InetSocketAddressSE getRemoteAddress()
WebSocketSession
WebSocketSession
の getRemoteAddress
public StringSE getAcceptedProtocol()
WebSocketSession
WebSocketSession
の getAcceptedProtocol
null
public ListSE<WebSocketExtension> getExtensions()
WebSocketSession
WebSocketSession
の getExtensions
public void setTextMessageSizeLimit(int messageSizeLimit)
WebSocketSession
WebSocketSession
の setTextMessageSizeLimit
public int getTextMessageSizeLimit()
WebSocketSession
WebSocketSession
の getTextMessageSizeLimit
public void setBinaryMessageSizeLimit(int messageSizeLimit)
WebSocketSession
WebSocketSession
の setBinaryMessageSizeLimit
public int getBinaryMessageSizeLimit()
WebSocketSession
WebSocketSession
の getBinaryMessageSizeLimit
public boolean isOpen()
WebSocketSession
WebSocketSession
の isOpen
public void sendMessage(WebSocketMessage<?> message) throws IOExceptionSE
WebSocketSession
TextMessage
または BinaryMessage
のいずれか。 注意 : 基礎となる標準 WebSocket セッション(JSR-356)は同時送信を許可しません。送信を同期する必要があります。これを確実にするための 1 つのオプションは、WebSocketSession
を ConcurrentWebSocketSessionDecorator
でラップすることです。
WebSocketSession
の sendMessage
IOExceptionSE
ConcurrentWebSocketSessionDecorator
public void close() throws IOExceptionSE
WebSocketSession
session.close(CloseStatus.NORMAL);
CloseableSE
の closeSE
AutoCloseableSE
の closeSE
WebSocketSession
の close
IOExceptionSE
public void close(CloseStatus status) throws IOExceptionSE
WebSocketSession
WebSocketSession
の close
IOExceptionSE
public StringSE toString()
ObjectSE
の toStringSE