パッケージ org.springframework.session.web.http

クラス HeaderHttpSessionIdResolver

java.lang.ObjectSE
org.springframework.session.web.http.HeaderHttpSessionIdResolver
実装されたすべてのインターフェース:
HttpSessionIdResolver
public class HeaderHttpSessionIdResolver extends ObjectSE implements HttpSessionIdResolver
ヘッダーを使用してセッション ID を解決する HttpSessionIdResolver。具体的には、この実装では、HeaderHttpSessionIdResolver(String) を使用してヘッダー名を指定できます。"X-Auth-Token" や "Authentication-Info" などの一般的なヘッダー名を使用するインスタンスを作成するための便利なファクトリメソッドも利用できます。

セッションが作成されると、HTTP レスポンスには、指定された名前とセッション ID の値のレスポンスヘッダーが含まれます。例：

 HTTP/1.1 200 OK
 X-Auth-Token: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
クライアントは、リクエストに同じヘッダーを指定して、各リクエストにセッションを含める必要があります。例：
 GET /messages/ HTTP/1.1
 Host: example.com
 X-Auth-Token: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
セッションが無効になると、サーバーはヘッダー名と空白の値を持つ HTTP レスポンスを送信します。例：
 HTTP/1.1 200 OK
 X-Auth-Token:
導入:
1.0

  • コンストラクターの詳細

    • HeaderHttpSessionIdResolver

      public HeaderHttpSessionIdResolver(StringSE headerName)
      セッション ID を取得するヘッダーの名前。
      パラメーター:
      headerName - セッション ID を取得するヘッダーの名前。

  • メソッドの詳細

    • xAuthToken

      public static HeaderHttpSessionIdResolver xAuthToken()
      "X-Auth-Token" ヘッダーを使用する HeaderHttpSessionIdResolver を作成するための便利なファクトリ。
      戻り値:
      "X-Auth-Token" ヘッダーを使用するように構成されたインスタンス

    • authenticationInfo

      public static HeaderHttpSessionIdResolver authenticationInfo()
      "Authentication-Info" ヘッダーを使用する HeaderHttpSessionIdResolver を作成するための便利なファクトリ。
      戻り値:
      "Authentication-Info" ヘッダーを使用するように構成されたインスタンス

    • resolveSessionIds

      public ListSE<StringSE> resolveSessionIds(jakarta.servlet.http.HttpServletRequest request)
      インターフェースからコピーされた説明: HttpSessionIdResolver
      提供された HttpServletRequest に関連付けられているセッション ID を解決します。例: セッション ID は Cookie またはリクエストヘッダーから取得される場合があります。
      次で指定:
      インターフェース HttpSessionIdResolver の resolveSessionIds 
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      セッション ID

    • setSessionId

      public void setSessionId(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, StringSE sessionId)
      インターフェースからコピーされた説明: HttpSessionIdResolver
      指定されたセッション ID をクライアントに送信します。このメソッドは、新しいセッションが作成されたときに呼び出され、新しいセッション ID が何であるかをクライアントに通知する必要があります。例: セッション ID を含む新しい Cookie を作成したり、新しいセッション ID の値を使用して HTTP レスポンスヘッダーを設定したりする場合があります。
      次で指定:
      インターフェース HttpSessionIdResolver の setSessionId 
      パラメーター:
      request - 現在のリクエスト
      response - 現在のレスポンス
      sessionId - セッション ID

    • expireSession

      public void expireSession(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      インターフェースからコピーされた説明: HttpSessionIdResolver
      現在のセッションを終了するようにクライアントに指示します。このメソッドは、セッションが無効になったときに呼び出され、セッション ID が無効になったことをクライアントに通知する必要があります。例: セッション ID を含む Cookie を削除したり、そのセッション ID を送信しないようにクライアントに示す空の値を含む HTTP レスポンスヘッダーを設定したりする場合があります。
      次で指定:
      インターフェース HttpSessionIdResolver の expireSession 
      パラメーター:
      request - 現在のリクエスト
      response - 現在のレスポンス