インターフェース HandshakeRequest

メソッドの詳細

• 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()

  リクエストに関連付けられたクエリ文字列を返します。

  戻り値:

  クエリ文字列。