パッケージ org.springframework.mock.web.server

クラス MockWebSession

java.lang.ObjectSE
org.springframework.mock.web.server.MockWebSession
実装されたすべてのインターフェース:
WebSession
public class MockWebSession extends ObjectSE implements WebSession
InMemoryWebSessionStore を介して取得したセッションインスタンスに委譲する WebSession の実装。

これは、MockServerWebExchange ビルダーの session(WebSession) メソッドで使用することを目的としており、WebSessionManager または WebSessionStore を完全に使用する必要がありません。

導入:
5.1
作成者:
Rossen Stoyanchev

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

    • MockWebSession

      public MockWebSession()

    • MockWebSession

      public MockWebSession(@Nullable ClockSE clock)

  • メソッドの詳細

    • getId

      public StringSE getId()
      インターフェースからコピーされた説明: WebSession
      一意のセッション識別子を返します。
      次で指定:
      インターフェース WebSession の getId 

    • getAttributes

      public MapSE<StringSE,ObjectSE> getAttributes()
      インターフェースからコピーされた説明: WebSession
      セッション属性を保持するマップを返します。
      次で指定:
      インターフェース WebSession の getAttributes 

    • start

      public void start()
      インターフェースからコピーされた説明: WebSession
      WebSession.save() が呼び出されたときにセッション ID が送信されるように、セッションを強制的に作成します。
      次で指定:
      インターフェース WebSession の start 

    • isStarted

      public boolean isStarted()
      インターフェースからコピーされた説明: WebSession
      クライアントとのセッションが WebSession.start() を介して明示的に開始されたか、セッション属性を追加して暗黙的に開始されたか。"false" の場合、セッション ID はクライアントに送信されず、WebSession.save() メソッドは基本的に何もしません。
      次で指定:
      インターフェース WebSession の isStarted 

    • changeSessionId

      public reactor.core.publisher.Mono<VoidSE> changeSessionId()
      インターフェースからコピーされた説明: WebSession
      セッションの新しい ID を生成し、基になるセッションストレージを更新して新しい ID を反映させます。呼び出しが成功した後、WebSession.getId() は新しいセッション ID を反映します。
      次で指定:
      インターフェース WebSession の changeSessionId 
      戻り値:
      完了通知 (成功またはエラー)

    • invalidate

      public reactor.core.publisher.Mono<VoidSE> invalidate()
      インターフェースからコピーされた説明: WebSession
      現在のセッションを無効にし、セッションストレージをクリアします。
      次で指定:
      インターフェース WebSession の invalidate 
      戻り値:
      完了通知 (成功またはエラー)

    • save

      public reactor.core.publisher.Mono<VoidSE> save()
      インターフェースからコピーされた説明: WebSession
      次のように、WebSessionStore を介してセッションを保存します。
      • セッションが新しい（つまり、作成されたが永続化されていない）場合は、WebSession.start() を介して明示的に開始されているか、属性を追加することによって暗黙的に開始されている必要があります。そうでない場合、このメソッドは効果がありません。
      • セッションが WebSessionStore を介して取得された場合、このメソッドの実装は、セッションが invalidated であったかどうかを確認し、そうであった場合はエラーを返す必要があります。

      このメソッドは、アプリケーションで直接使用するためのものではないことに注意してください。代わりに、レスポンスがコミットされる直前に自動的に呼び出されます。

      次で指定:
      インターフェース WebSession の save 
      戻り値:
      Mono は、成功またはエラーで完了を示します

    • isExpired

      public boolean isExpired()
      インターフェースからコピーされた説明: WebSession
      maxIdleTime の経過後にセッションが期限切れになった場合は、true を返します。

      通常、セッションがアクセスされたときに有効期限チェックが自動的に行われ、必要に応じて新しい WebSession インスタンスがリクエスト処理の開始時に作成されるため、アプリケーションはデフォルトで期限切れのセッションについて心配する必要がありません。

      次で指定:
      インターフェース WebSession の isExpired 

    • getCreationTime

      public InstantSE getCreationTime()
      インターフェースからコピーされた説明: WebSession
      セッションが作成された時刻を返します。
      次で指定:
      インターフェース WebSession の getCreationTime 

    • getLastAccessTime

      public InstantSE getLastAccessTime()
      インターフェースからコピーされた説明: WebSession
      HTTP リクエストなどのユーザーアクティビティの結果として、セッションアクセスの最後の時間を返します。maxIdleTimeInSeconds と一緒に使用すると、いつセッションが expired であるかを判別できます。
      次で指定:
      インターフェース WebSession の getLastAccessTime 

    • setMaxIdleTime

      public void setMaxIdleTime(DurationSE maxIdleTime)
      インターフェースからコピーされた説明: WebSession
      lastAccessTime の後、セッションが期限切れと見なされるまでの最大時間を設定します。負の値は、セッションが期限切れにならないことを示します。
      次で指定:
      インターフェース WebSession の setMaxIdleTime 

    • getMaxIdleTime

      public DurationSE getMaxIdleTime()
      インターフェースからコピーされた説明: WebSession
      lastAccessTime の後、セッションが期限切れになるまでの最大時間を返します。負の時間は、セッションが期限切れにならないことを示します。
      次で指定:
      インターフェース WebSession の getMaxIdleTime