HttpSession (Java Servlet 4.0)

```
public interface HttpSession
```
複数のページリクエストにわたったりウェブサイトを訪れたユーザーを識別する方法や、ユーザーに関する情報を保管する方法を提供します。
サーブレットコンテナはこのインターフェースを使用してHTTPクライアントとHTTPサーバーの間のセッションを作成します。セッションは指定された期間ユーザーからの複数の接続またはページリクエストにわたって永続化されます。 1つのセッションは通常、何回もサイトにアクセスする1人のユーザーに対応しています。サーバーはCookieを使用したりURLを書き換えたりすることでセッションを維持できます。
このインターフェースによりサーブレットは以下のようなことができます。
- セッション識別子、作成時間、最後にアクセスされた時間などのセッションに関する情報の表示と操作
- セッションにオブジェクトを格納することでユーザー情報をユーザーの複数の接続にまたがらせる
アプリケーションがセッションにオブジェクトを格納したり削除したりすると、セッションはそのオブジェクトが HttpSessionBindingListener を実装しているかどうかをチェックします。そうであれば、サーブレットはオブジェクトにセッションに格納されたこと、削除されたことをオブジェクトに通知します。格納、削除のメソッドの完了後に通知が送信されます。セッションが無効または期限切れになった場合はその後に通知が送信されます。
コンテナが分散コンテナ設定のVM間でセッションを移動した場合はHttpSessionActivationListenerインターフェイスを実装するすべてのセッション属性が通知されます。
サーブレットはCookieが意図的にオフになったときなど、クライアントがセッションに参加しないことを選択したケースを処理できる必要があります。クライアントがセッションに参加するまで、 isNewはtrueを返します。クライアントがセッションに参加しないことを選択した場合、 getSessionは各リクエストで異なるセッションを返し、isNewは常にtrueを返します。
セッション情報は現在のWebアプリケーション(ServletContext)のみにスコープが設定されているため、あるコンテキストに格納されている情報は別のコンテキストでは直接参照されません。
作成者:

Various

関連項目:

HttpSessionBindingListener, HttpSessionContext

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`Object`	`getAttribute(String name)` このセッションに指定された名前で設定されたオブジェクトを返します。
`Enumeration<String>`	`getAttributeNames()` セッションに関連付けられたオブジェクトを示すすべての名前を含んだ`String`オブジェクトの`Enumeration`を返します。
`long`	`getCreationTime()` セッションが作られた日時を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。
`String`	`getId()` このセッションに割り当てられた一意の識別子を含む文字列を返します。
`long`	`getLastAccessedTime()` このセッションによって関連付けられたクライアントが最後にリクエストを投げコンテナが受信した日時を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。
`int`	`getMaxInactiveInterval()` サーブレットコンテナがこのセッションをクライアントからのアクセスの間に保持し続ける最大の間隔を秒単位で返します。
`ServletContext`	`getServletContext()` セッションが所属するServletContextを返します。
`HttpSessionContext`	`getSessionContext()` 非推奨です。セキュリティの理由によりJava(tm) Servlet API 2.1以降非推奨です。代替手段はありません。のちのバージョンでこのAPIは削除されます。
`Object`	`getValue(String name)` 非推奨です。 Version 2.2から`getAttribute(java.lang.String)`に置き換えられました
`String[]`	`getValueNames()` 非推奨です。 Version 2.2から`getAttributeNames()`に置き換えられました
`void`	`invalidate()` このセッションを保存されているすべての値を取り除いてから無効化します。
`boolean`	`isNew()` クライアントがセッションについてまだ認識していない場合、またはクライアントがセッションに参加しないことを選択した場合は `true` を返します。
`void`	`putValue(String name, Object value)` 非推奨です。 Version 2.2から`setAttribute(java.lang.String, java.lang.Object)`に置き換えられました
`void`	`removeAttribute(String name)` このセッションから指定された名前で存在するオブジェクトを削除します。
`void`	`removeValue(String name)` 非推奨です。 Version 2.2から`removeAttribute(java.lang.String)`に置き換えられました
`void`	`setAttribute(String name, Object value)` 指定された名前を使用して、このセッションにオブジェクトを追加します。
`void`	`setMaxInactiveInterval(int interval)` サーブレットコンテナがこのセッションを無効にするまでのクライアントからのリクエストの最大の間隔を秒単位で指定します。

- メソッドの詳細
  - getCreationTime
```
long getCreationTime()
```
    セッションが作られた日時を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。
    
    戻り値:
    
    セッションが作られた日時の1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数のlong
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - getId
```
String getId()
```
    このセッションに割り当てられた一意の識別子を含む文字列を返します。識別子はサーブレットコンテナによって割り当てられ、実装に依存します。
    
    戻り値:
    
    このセッションに割り当てられた識別子を指定する文字列
  - getLastAccessedTime
```
long getLastAccessedTime()
```
    このセッションによって関連付けられたクライアントが最後にリクエストを投げコンテナが受信した日時を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。
    アプリケーションが実行したセッションに関連付けられた値の取得や設定などのアクションはアクセス時間に影響しません。
    
    戻り値:
    
    セッションによって関連付けられたクライアントが最後にリクエストを投げた日時の1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数の long
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - getServletContext
```
ServletContext getServletContext()
```
    セッションが所属するServletContextを返します。
    
    戻り値:
    
    ウェブアプリケーションの ServletContext のオブジェクト
    
    導入されたバージョン:
    
    Servlet 2.3
  - setMaxInactiveInterval
```
void setMaxInactiveInterval(int interval)
```
    サーブレットコンテナがこのセッションを無効にするまでのクライアントからのリクエストの最大の間隔を秒単位で指定します。
    0以下の interval の値はセッションがタイムアウトしないほうが良いことを示します。
    
    パラメータ:
    
    interval - 秒数を指定する整数
  - getMaxInactiveInterval
```
int getMaxInactiveInterval()
```
    サーブレットコンテナがこのセッションをクライアントからのアクセスの間に保持し続ける最大の間隔を秒単位で返します。この間隔の後にサーブレットコンテナはセッションを無効にします。最大時間間隔はsetMaxInactiveIntervalメソッドで設定できます。
    0以下の戻り値はセッションが決してタイムアウトしないことを示します。
    
    戻り値:
    
    このセッションがクライアントからのリクエストの間に保持し続ける秒数を指定する整数
    
    関連項目:
    
    setMaxInactiveInterval(int)
  - getSessionContext
```
@Deprecated
HttpSessionContext getSessionContext()
```
    非推奨です。セキュリティの理由によりJava(tm) Servlet API 2.1以降非推奨です。代替手段はありません。のちのバージョンでこのAPIは削除されます。
    
    戻り値:
    
    このセッションの HttpSessionContext
  - getAttribute
```
Object getAttribute(String name)
```
    このセッションに指定された名前で設定されたオブジェクトを返します。名前の下にオブジェクトが設定されていない場合はnullを返します。
    
    パラメータ:
    
    name - オブジェクトの名前を示す文字列
    
    戻り値:
    
    名前で特定されたオブジェクト
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - getValue
```
@Deprecated
Object getValue(String name)
```
    非推奨です。 Version 2.2からgetAttribute(java.lang.String)に置き換えられました
    
    パラメータ:
    
    name - オブジェクトの名前を示す文字列
    
    戻り値:
    
    名前で特定されたオブジェクト
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - getAttributeNames
```
Enumeration<String> getAttributeNames()
```
    セッションに関連付けられたオブジェクトを示すすべての名前を含んだStringオブジェクトのEnumerationを返します。
    
    戻り値:
    
    セッションに関連付けられたオブジェクトを示すすべての名前を含んだStringオブジェクトのEnumeration
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - getValueNames
```
@Deprecated
String[] getValueNames()
```
    非推奨です。 Version 2.2からgetAttributeNames()に置き換えられました
    
    戻り値:
    
    セッションに関連付けられたオブジェクトを示すすべての名前を含んだStringオブジェクトの配列
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - setAttribute
```
void setAttribute(String name,
                  Object value)
```
    指定された名前を使用して、このセッションにオブジェクトを追加します。同じ名前のオブジェクトが既にセッションに追加されている場合はオブジェクトが置き換えられます。
    このメソッドの実行後、新しいオブジェクトがHttpSessionBindingListenerを実装する場合、コンテナはHttpSessionBindingListener.valueBoundを呼び出します。次にコンテナはWebアプリケーション内のHttpSessionAttributeListenerに通知します。
    このセッションにすでに存在したオブジェクトがHttpSessionBindingListenerを実装している場合はHttpSessionBindingListener.valueUnboundメソッドが呼び出されます。
    渡された値がnullの場合はremoveAttribute()を呼び出すのと同じ効果があります。
    
    パラメータ:
    
    name - オブジェクトを追加する名前;nullにはできない
    
    value - 追加されるオブジェクト
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - putValue
```
@Deprecated
void putValue(String name,
                          Object value)
```
    非推奨です。 Version 2.2からsetAttribute(java.lang.String, java.lang.Object)に置き換えられました
    
    パラメータ:
    
    name - オブジェクトを追加する名前;nullにはできない
    
    value - 追加されるオブジェクト;nullにはできない
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - removeAttribute
```
void removeAttribute(String name)
```
    このセッションから指定された名前で存在するオブジェクトを削除します。セッションに指定された名前で存在するオブジェクトがない場合はこのメソッドは何も行いません。
    オブジェクトがHttpSessionBindingListenerを実装する場合はこのメソッドの実行後にコンテナはHttpSessionBindingListener.valueUnboundを呼び出します。次にコンテナはWebアプリケーション内のHttpSessionAttributeListenerに通知します。
    
    パラメータ:
    
    name - セッションから取り除くオブジェクトの名前
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - removeValue
```
@Deprecated
void removeValue(String name)
```
    非推奨です。 Version 2.2からremoveAttribute(java.lang.String)に置き換えられました
    
    パラメータ:
    
    name - セッションから取り除くオブジェクトの名前
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合
  - invalidate
```
void invalidate()
```
    このセッションを保存されているすべての値を取り除いてから無効化します。
    
    例外:
    
    IllegalStateException - すでに無効になっているセッションで呼び出された場合
  - isNew
```
boolean isNew()
```
    クライアントがセッションについてまだ認識していない場合、またはクライアントがセッションに参加しないことを選択した場合は true を返します。たとえば、サーバーがCookieベースのセッションのみを使用し、クライアントがCookieの使用を無効にしていた場合、セッションは各リクエストに対して新しく生成されます。
    
    戻り値:
    
    true ならばサーバーがセッションを作成したが、クライアントはセッションに参加していない
    
    例外:
    
    IllegalStateException - もしこのメソッドが無効なセッションで呼び出された場合

Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.

インタフェース HttpSession

メソッドのサマリー

メソッドの詳細

getCreationTime

getId

getLastAccessedTime

getServletContext

setMaxInactiveInterval

getMaxInactiveInterval

getSessionContext

getAttribute

getValue

getAttributeNames

getValueNames

setAttribute

putValue

removeAttribute

removeValue

invalidate

isNew