MockHttpSession (Spring Framework 5.2.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.mock.web.MockHttpSession

実装されているすべてのインターフェース:
HttpSessionEE
```
public class MockHttpSession
extends ObjectSE
implements HttpSessionEE
```
HttpSessionEE インターフェースのモック実装。
Spring 5.0 以降、このモックのセットは Servlet 4.0 ベースラインに基づいて設計されています。
導入:
1.0.2
作成者:
Juergen Hoeller, Rod Johnson, Mark Fisher, Sam Brannen, Vedran Pavic

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE SESSION_COOKIE_NAME
セッション Cookie 名。

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`SESSION_COOKIE_NAME` セッション Cookie 名。

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MockHttpSession()` デフォルトの `MockServletContext` で新しい MockHttpSession を作成します。
`MockHttpSession(ServletContextEE servletContext)` 新しい MockHttpSession を作成します。
`MockHttpSession(ServletContextEE servletContext, StringSE id)` 新しい MockHttpSession を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`access()`
`StringSE`	`changeSessionId()` Servlet 3.1 以降、セッションの ID を変更できます。
`void`	`clearAttributes()` このセッションのすべての属性をクリアします。
`void`	`deserializeState(SerializableSE state)` `serializeState()` によって作成された状態オブジェクトからこのセッションの属性を逆直列化します。
`ObjectSE`	`getAttribute(StringSE name)` このセッションで指定された名前でバインドされたオブジェクトを返します。名前でオブジェクトがバインドされていない場合は `null` を返します。
`EnumerationSE<StringSE>`	`getAttributeNames()` このセッションにバインドされたすべてのオブジェクトの名前を含む `String` オブジェクトの `Enumeration` を返します。
`long`	`getCreationTime()` 1970 年 1 月 1 日 GMT 午前 0 時からミリ秒単位で測定された、このセッションが作成された時刻を返します。
`StringSE`	`getId()` このセッションに割り当てられた一意の識別子を含む文字列を返します。
`long`	`getLastAccessedTime()` クライアントがこのセッションに関連付けられたリクエストを最後に送信した時刻を、グリニッジ標準時 1970 年 1 月 1 日午前 0 時からのミリ秒数で返し、コンテナーがリクエストを受信した時間でマークします。
`int`	`getMaxInactiveInterval()` サーブレットコンテナーがクライアントアクセス間でこのセッションを開いたままにする最大時間間隔を秒単位で返します。
`ServletContextEE`	`getServletContext()` このセッションが属する ServletContext を返します。
`HttpSessionContextEE`	`getSessionContext()`
`ObjectSE`	`getValue(StringSE name)`
`StringSE[]`	`getValueNames()`
`void`	`invalidate()` このセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。
`boolean`	`isInvalid()`
`boolean`	`isNew()` クライアントがセッションについてまだ知らない場合、またはクライアントがセッションに参加しないことを選択した場合、`true` を返します。
`void`	`putValue(StringSE name, ObjectSE value)`
`void`	`removeAttribute(StringSE name)` 指定された名前でバインドされたオブジェクトをこのセッションから削除します。
`void`	`removeValue(StringSE name)`
`SerializableSE`	`serializeState()` このセッションの属性を、標準の Java 直列化でバイト配列に変換できるオブジェクトに直列化します。
`void`	`setAttribute(StringSE name, ObjectSE value)` 指定した名前を使用して、オブジェクトをこのセッションにバインドします。
`void`	`setMaxInactiveInterval(int interval)` サーブレットコンテナーがこのセッションを無効化するまでのクライアントリクエスト間の時間を秒単位で指定します。
`void`	`setNew(boolean value)`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - SESSION_COOKIE_NAME
```
public static final StringSE SESSION_COOKIE_NAME
```
    セッション Cookie 名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MockHttpSession
```
public MockHttpSession()
```
    デフォルトの MockServletContext で新しい MockHttpSession を作成します。
    関連事項:
    MockServletContext
  - MockHttpSession
```
public MockHttpSession(@Nullable
                       ServletContextEE servletContext)
```
    新しい MockHttpSession を作成します。
    パラメーター:
    servletContext - セッションが実行される ServletContext
  - MockHttpSession
```
public MockHttpSession(@Nullable
                       ServletContextEE servletContext,
                       @Nullable
                       StringSE id)
```
    新しい MockHttpSession を作成します。
    パラメーター:
    servletContext - セッションが実行される ServletContext
    id - このセッションの一意の識別子
- メソッドの詳細
  - getCreationTime
```
public long getCreationTime()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    1970 年 1 月 1 日 GMT 午前 0 時からミリ秒単位で測定された、このセッションが作成された時刻を返します。
    次で指定:
    インターフェース HttpSessionEE の getCreationTimeEE
    戻り値:
    このセッションがいつ作成されたかを指定する long。1/1/1970 GMT 以降のミリ秒で表されます
  - getId
```
public StringSE getId()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    このセッションに割り当てられた一意の識別子を含む文字列を返します。識別子はサーブレットコンテナーによって割り当てられ、実装に依存します。
    次で指定:
    インターフェース HttpSessionEE の getIdEE
    戻り値:
    このセッションに割り当てられた識別子を指定する文字列
  - changeSessionId
```
public StringSE changeSessionId()
```
    Servlet 3.1 以降、セッションの ID を変更できます。
    戻り値:
    新しいセッション ID
    導入:
    4.0.3
  - access
```
public void access()
```
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    クライアントがこのセッションに関連付けられたリクエストを最後に送信した時刻を、グリニッジ標準時 1970 年 1 月 1 日午前 0 時からのミリ秒数で返し、コンテナーがリクエストを受信した時間でマークします。
    セッションに関連付けられた値の取得や設定など、アプリケーションが実行するアクションは、アクセス時間に影響しません。
    次で指定:
    インターフェース HttpSessionEE の getLastAccessedTimeEE
    戻り値:
    クライアントがこのセッションに関連付けられたリクエストを最後に送信した時間を表す long。1/1/1970 GMT からのミリ秒単位で表されます
  - getServletContext
```
public ServletContextEE getServletContext()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    このセッションが属する ServletContext を返します。
    次で指定:
    インターフェース HttpSessionEE の getServletContextEE
    戻り値:
    Web アプリケーションの ServletContext オブジェクト
  - setMaxInactiveInterval
```
public void setMaxInactiveInterval(int interval)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    サーブレットコンテナーがこのセッションを無効化するまでのクライアントリクエスト間の時間を秒単位で指定します。
    ゼロ以下の interval 値は、セッションがタイムアウトしないことを示します。
    次で指定:
    インターフェース HttpSessionEE の setMaxInactiveIntervalEE
    パラメーター:
    interval - 秒数を指定する整数
  - getMaxInactiveInterval
```
public int getMaxInactiveInterval()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    サーブレットコンテナーがクライアントアクセス間でこのセッションを開いたままにする最大時間間隔を秒単位で返します。この間隔の後、サーブレットコンテナーはセッションを無効にします。最大時間間隔は、setMaxInactiveInterval メソッドで設定できます。
    ゼロ以下の戻り値は、セッションがタイムアウトしないことを示します。
    次で指定:
    インターフェース HttpSessionEE の getMaxInactiveIntervalEE
    戻り値:
    このセッションがクライアントリクエスト間で開いている秒数を指定する整数
    関連事項:
    HttpSession.setMaxInactiveInterval(int)EE
  - getSessionContext
```
public HttpSessionContextEE getSessionContext()
```
    次で指定:
    インターフェース HttpSessionEE の getSessionContextEE
    戻り値:
    このセッションの HttpSessionContextEE。
  - getAttribute
```
public ObjectSE getAttribute(StringSE name)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    このセッションで指定された名前でバインドされたオブジェクトを返します。名前でオブジェクトがバインドされていない場合は null を返します。
    次で指定:
    インターフェース HttpSessionEE の getAttributeEE
    パラメーター:
    name - オブジェクトの名前を指定する文字列
    戻り値:
    指定された名前のオブジェクト
  - getValue
```
public ObjectSE getValue(StringSE name)
```
    次で指定:
    インターフェース HttpSessionEE の getValueEE
    パラメーター:
    name - オブジェクトの名前を指定する文字列
    戻り値:
    指定された名前のオブジェクト
  - getAttributeNames
```
public EnumerationSE<StringSE> getAttributeNames()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    このセッションにバインドされたすべてのオブジェクトの名前を含む String オブジェクトの Enumeration を返します。
    次で指定:
    インターフェース HttpSessionEE の getAttributeNamesEE
    戻り値:
    このセッションにバインドされたすべてのオブジェクトの名前を指定する String オブジェクトの Enumeration
  - getValueNames
```
public StringSE[] getValueNames()
```
    次で指定:
    インターフェース HttpSessionEE の getValueNamesEE
    戻り値:
    このセッションにバインドされたすべてのオブジェクトの名前を指定する String オブジェクトの配列
  - setAttribute
```
public void setAttribute(StringSE name,
                         @Nullable
                         ObjectSE value)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    指定した名前を使用して、オブジェクトをこのセッションにバインドします。同じ名前のオブジェクトがすでにセッションにバインドされている場合、オブジェクトは置き換えられます。
    このメソッドの実行後、新しいオブジェクトが HttpSessionBindingListener を実装する場合、コンテナーは HttpSessionBindingListener.valueBound を呼び出します。その後、コンテナーは Web アプリケーションの HttpSessionAttributeListener を通知します。
    HttpSessionBindingListener を実装するこの名前のこのセッションにオブジェクトがすでにバインドされている場合、その HttpSessionBindingListener.valueUnbound メソッドが呼び出されます。
    渡された値が null の場合、これは removeAttribute() を呼び出すのと同じ効果があります。
    次で指定:
    インターフェース HttpSessionEE の setAttributeEE
    パラメーター:
    name - オブジェクトがバインドされている名前。null にすることはできません
    value - バインドされるオブジェクト
  - putValue
```
public void putValue(StringSE name,
                     ObjectSE value)
```
    次で指定:
    インターフェース HttpSessionEE の putValueEE
    パラメーター:
    name - オブジェクトがバインドされている名前。null にすることはできません
    value - バインドされるオブジェクト。null にすることはできません
  - removeAttribute
```
public void removeAttribute(StringSE name)
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    指定された名前でバインドされたオブジェクトをこのセッションから削除します。指定した名前でバインドされたオブジェクトがセッションにない場合、このメソッドは何もしません。
    このメソッドの実行後、オブジェクトが HttpSessionBindingListener を実装している場合、コンテナーは HttpSessionBindingListener.valueUnbound を呼び出します。その後、コンテナーは Web アプリケーションの HttpSessionAttributeListener を通知します。
    次で指定:
    インターフェース HttpSessionEE の removeAttributeEE
    パラメーター:
    name - このセッションから削除するオブジェクトの名前
  - removeValue
```
public void removeValue(StringSE name)
```
    次で指定:
    インターフェース HttpSessionEE の removeValueEE
    パラメーター:
    name - このセッションから削除するオブジェクトの名前
  - clearAttributes
```
public void clearAttributes()
```
    このセッションのすべての属性をクリアします。
  - invalidate
```
public void invalidate()
```
    このセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。
    次で指定:
    インターフェース HttpSessionEE の invalidateEE
    例外:
    IllegalStateExceptionSE - このメソッドがすでに無効化されたセッションで呼び出された場合
  - isInvalid
```
public boolean isInvalid()
```
  - setNew
```
public void setNew(boolean value)
```
  - isNew
```
public boolean isNew()
```
    インターフェースからコピーされた説明: javax.servlet.http.HttpSessionEE
    クライアントがセッションについてまだ知らない場合、またはクライアントがセッションに参加しないことを選択した場合、true を返します。例: サーバーが Cookie ベースのセッションのみを使用し、クライアントが Cookie の使用を無効にした場合、セッションはリクエストごとに新しくなります。
    次で指定:
    インターフェース HttpSessionEE の isNewEE
    戻り値:
    サーバーがセッションを作成したが、クライアントがまだ参加していない場合は、true
  - serializeState
```
public SerializableSE serializeState()
```
    このセッションの属性を、標準の Java 直列化でバイト配列に変換できるオブジェクトに直列化します。
    戻り値:
    このセッションの直列化された状態の表現
  - deserializeState
```
public void deserializeState(SerializableSE state)
```
    serializeState() によって作成された状態オブジェクトからこのセッションの属性を逆直列化します。
    パラメーター:
    state - このセッションの直列化された状態の表現

クラス MockHttpSession

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

フィールドの詳細

SESSION_COOKIE_NAME

コンストラクターの詳細

MockHttpSession

MockHttpSession

MockHttpSession

メソッドの詳細

getCreationTime

getId

changeSessionId

access

getLastAccessedTime

getServletContext

setMaxInactiveInterval

getMaxInactiveInterval

getSessionContext

getAttribute

getValue

getAttributeNames

getValueNames

setAttribute

putValue

removeAttribute

removeValue

clearAttributes

invalidate

isInvalid

setNew

isNew

serializeState

deserializeState