MockWebSession (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- org.springframework.mock.web.server.MockWebSession

実装済みのインターフェース一覧:
WebSession
```
public class MockWebSession
extends java.lang.Object
implements WebSession
```
InMemoryWebSessionStore を介して取得したセッションインスタンスに委譲する WebSession の実装。
これは、MockServerWebExchange ビルダーの session(WebSession) メソッドで使用することを目的としており、WebSessionManager または WebSessionStore を完全に使用する必要がありません。
導入:
5.1
作成者:
Rossen Stoyanchev

コンストラクター概要
コンストラクター
コンストラクターと説明
MockWebSession()
MockWebSession(java.time.Clock clock)

コンストラクター
コンストラクターと説明
`MockWebSession()`
`MockWebSession(java.time.Clock clock)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`reactor.core.publisher.Mono<java.lang.Void>`	`changeSessionId()` セッションの新しい ID を生成し、基になるセッションストレージを更新して新しい ID を反映させます。
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` セッション属性を保持するマップを返します。
`java.time.Instant`	`getCreationTime()` セッションが作成された時刻を返します。
`java.lang.String`	`getId()` 一意のセッション識別子を返します。
`java.time.Instant`	`getLastAccessTime()` HTTP リクエストなどのユーザーアクティビティの結果として、セッションアクセスの最後の時間を返します。
`java.time.Duration`	`getMaxIdleTime()` `lastAccessTime` の後、セッションが期限切れになるまでの最大時間を返します。
`reactor.core.publisher.Mono<java.lang.Void>`	`invalidate()` 現在のセッションを無効にし、セッションストレージをクリアします。
`boolean`	`isExpired()` `maxIdleTime` の経過後にセッションが期限切れになった場合は、`true` を返します。
`boolean`	`isStarted()` クライアントとのセッションが `WebSession.start()` を介して明示的に開始されたか、セッション属性を追加して暗黙的に開始されたか。
`reactor.core.publisher.Mono<java.lang.Void>`	`save()` 次のように `WebSessionStore` を介してセッションを保存します。セッションが新しい場合（つまり
`void`	`setMaxIdleTime(java.time.Duration maxIdleTime)` `lastAccessTime` の後、セッションが期限切れと見なされるまでの最大時間を設定します。
`void`	`start()` `WebSession.save()` が呼び出されたときにセッション ID が送信されるように、セッションを強制的に作成します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インターフェース org.springframework.web.server.WebSession から継承されたメソッド
getAttribute, getAttributeOrDefault, getRequiredAttribute

- コンストラクターの詳細
  - MockWebSession
```
public MockWebSession()
```
  - MockWebSession
```
public MockWebSession(@Nullable
                      java.time.Clock clock)
```
- メソッドの詳細
  - getId
```
public java.lang.String getId()
```
    インターフェースからコピーされた説明: WebSession
    一意のセッション識別子を返します。
    次で指定:
    インターフェース WebSession 内の getId
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> 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<java.lang.Void> changeSessionId()
```
    インターフェースからコピーされた説明: WebSession
    セッションの新しい ID を生成し、基になるセッションストレージを更新して新しい ID を反映させます。呼び出しが成功した後、WebSession.getId() は新しいセッション ID を反映します。
    次で指定:
    インターフェース WebSession 内の changeSessionId
    戻り値:
    完了通知 (成功またはエラー)
  - invalidate
```
public reactor.core.publisher.Mono<java.lang.Void> invalidate()
```
    インターフェースからコピーされた説明: WebSession
    現在のセッションを無効にし、セッションストレージをクリアします。
    次で指定:
    インターフェース WebSession 内の invalidate
    戻り値:
    完了通知 (成功またはエラー)
  - save
```
public reactor.core.publisher.Mono<java.lang.Void> save()
```
    インターフェースからコピーされた説明: WebSession
    次のように、WebSessionStore を介してセッションを保存します。
    - セッションが新しい（つまり、作成されたが永続化されていない）場合は、WebSession.start() を介して明示的に開始されているか、属性を追加することによって暗黙的に開始されている必要があります。そうでない場合、このメソッドは効果がありません。
    - セッションが WebSessionStore を介して取得された場合、このメソッドの実装は、セッションが invalidated であったかどうかを確認し、そうであった場合はエラーを返す必要があります。
    このメソッドは、アプリケーションで直接使用するためのものではないことに注意してください。代わりに、レスポンスがコミットされる直前に自動的に呼び出されます。
    次で指定:
    インターフェース WebSession 内の save
    戻り値:
    Mono は、成功またはエラーで完了を示します
  - isExpired
```
public boolean isExpired()
```
    インターフェースからコピーされた説明: WebSession
    maxIdleTime の経過後にセッションが期限切れになった場合は、true を返します。
    通常、セッションがアクセスされたときに有効期限チェックが自動的に行われ、必要に応じて新しい WebSession インスタンスがリクエスト処理の開始時に作成されるため、アプリケーションはデフォルトで期限切れのセッションについて心配する必要がありません。
    次で指定:
    インターフェース WebSession 内の isExpired
  - getCreationTime
```
public java.time.Instant getCreationTime()
```
    インターフェースからコピーされた説明: WebSession
    セッションが作成された時刻を返します。
    次で指定:
    インターフェース WebSession 内の getCreationTime
  - getLastAccessTime
```
public java.time.Instant getLastAccessTime()
```
    インターフェースからコピーされた説明: WebSession
    HTTP リクエストなどのユーザーアクティビティの結果として、セッションアクセスの最後の時間を返します。maxIdleTimeInSeconds と一緒に使用すると、いつセッションが expired であるかを判別できます。
    次で指定:
    インターフェース WebSession 内の getLastAccessTime
  - setMaxIdleTime
```
public void setMaxIdleTime(java.time.Duration maxIdleTime)
```
    インターフェースからコピーされた説明: WebSession
    lastAccessTime の後、セッションが期限切れと見なされるまでの最大時間を設定します。負の値は、セッションが期限切れにならないことを示します。
    次で指定:
    インターフェース WebSession 内の setMaxIdleTime
  - getMaxIdleTime
```
public java.time.Duration getMaxIdleTime()
```
    インターフェースからコピーされた説明: WebSession
    lastAccessTime の後、セッションが期限切れになるまでの最大時間を返します。負の時間は、セッションが期限切れにならないことを示します。
    次で指定:
    インターフェース WebSession 内の getMaxIdleTime

クラス MockWebSession

コンストラクター概要

方法の概要

クラス java.lang.Object から継承されたメソッド

インターフェース org.springframework.web.server.WebSession から継承されたメソッド

コンストラクターの詳細

MockWebSession

MockWebSession

メソッドの詳細

getId

getAttributes

start

isStarted

changeSessionId

invalidate

save

isExpired

getCreationTime

getLastAccessTime

setMaxIdleTime

getMaxIdleTime