パッケージ jakarta.websocket.server
インターフェース HandshakeRequest
public interface HandshakeRequest
ハンドシェイクリクエストは、WebSocket セッションの開始ハンドシェイクに対する WebSocket 定義の HTTP GET リクエストを表します。- 作成者:
- dannycoward
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static StringSE
SEC_WEBSOCKET_EXTENSIONS
Sec-WebSocket-Extensions ヘッダー名static StringSE
SEC_WEBSOCKET_KEY
Sec-WebSocket-Key ヘッダー名static StringSE
SEC_WEBSOCKET_PROTOCOL
Sec-WebSocket-Protocol ヘッダー名static StringSE
SEC_WEBSOCKET_VERSION
Sec-WebSocket-Version ヘッダー名
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 MapSE<StringSE,ListSE<StringSE>>
getHeaders()
HTTP ヘッダーの読み取り専用マップを、ハンドシェイクリクエストに付属のヘッダー値に返します。ObjectSE
getHttpSession()
実装が Java EE Web コンテナーの一部である場合は、この会話を開始した Web ソケットハンドシェイクが含まれていた HttpSession への参照を返します。MapSE<StringSE,ListSE<StringSE>>
getParameterMap()
リクエストに関連付けられているリクエストパラメーターを返します。StringSE
getQueryString()
リクエストに関連付けられたクエリ文字列を返します。URISE
getRequestURI()
ハンドシェイクリクエストのリクエスト URI を返します。PrincipalSE
getUserPrincipal()
このハンドシェイクに対して認証されたユーザーがいない場合は、認証されたユーザーまたはnull
を返します。boolean
isUserInRole(StringSE role)
現在のユーザーが指定されたロールに属しているかどうかを確認します。
メソッドの詳細
getHeaders
MapSE<StringSE,ListSE<StringSE>> getHeaders()
HTTP ヘッダーの読み取り専用マップを、ハンドシェイクリクエストに付属のヘッダー値に返します。ヘッダー名のルックアップでは、大文字と小文字が区別されない方法で実行されることに注意してください。- 戻り値:
- ヘッダーのリスト。
getUserPrincipal
PrincipalSE getUserPrincipal()
このハンドシェイクに対して認証されたユーザーがいない場合は、認証されたユーザーまたはnull
を返します。- 戻り値:
- ユーザープリンシパル。
getRequestURI
URISE getRequestURI()
ハンドシェイクリクエストのリクエスト URI を返します。- 戻り値:
- ハンドシェイクリクエストのリクエスト uri。
isUserInRole
boolean isUserInRole(StringSE role)
現在のユーザーが指定されたロールに属しているかどうかを確認します。ロールとロールメンバーシップは、Java EE Web コンテナーで実行されている場合、含まれている WAR ファイルのデプロイ記述子を使用して定義できます。ユーザーが認証されていない場合、メソッドはfalse
を返します。- パラメーター:
role
- チェックされるロール。- 戻り値:
- 認証されたユーザーがロールに含まれているかどうか、ユーザーが認証されていない場合は false。
getHttpSession
ObjectSE getHttpSession()
実装が Java EE Web コンテナーの一部である場合は、この会話を開始した Web ソケットハンドシェイクが含まれていた HttpSession への参照を返します。- 戻り値:
- WebSocket 実装が Java EE Web コンテナーの一部ではない場合、または開始ハンドシェイクリクエストに関連付けられた HttpSession がない場合は、http セッションまたは
null
。
getParameterMap
MapSE<StringSE,ListSE<StringSE>> getParameterMap()
リクエストに関連付けられているリクエストパラメーターを返します。- 戻り値:
- リクエストパラメーターの変更不可能なマップ。
getQueryString
StringSE getQueryString()
リクエストに関連付けられたクエリ文字列を返します。- 戻り値:
- クエリ文字列。