com.JRcServer
インタフェース JRcSession

public interface JRcSession

JRcServerセッションインターフェイス.

導入されたバージョン:

JRcServerAPI 1.00

バージョン:

2006/09/06

作成者:

masahito suzuki

フィールドの概要

static long	DEF_SESSION_TIMEOUT デフォルトタイムアウト値.
static long	MAX_SESSION_TIMEOUT セッションタイムアウト : 最大値.
static long	MIN_SESSION_TIMEOUT セッションタイムアウト : 最小値.

メソッドの概要

java.lang.String	getApplicationName() アプリケーション名を取得.
long	getCreateTime() セッション生成時間を取得.
long	getId() セッションIDを取得.
long	getLastAccessTime() ラストアクセス時間を取得.
java.lang.String[]	getNames() 登録されている要素名群を取得.
long	getSessionTimeout() セッションタイムアウトを取得.
long	getTimeoutRemainder() 最後にリクエストされた時間からセッションタイムアウトする までの時間を取得.
java.lang.Object	getValue(java.lang.String name) 要素を取得.
boolean	isSession() セッション情報が有効であるかチェック.
void	putValue(java.lang.String name, java.lang.Object value) 要素を追加.
void	removeValue(java.lang.String name) 要素情報を削除.
int	size() 登録されている要素数を取得.

フィールドの詳細

DEF_SESSION_TIMEOUT

static final long DEF_SESSION_TIMEOUT

デフォルトタイムアウト値.

関連項目:

定数フィールド値

MIN_SESSION_TIMEOUT

static final long MIN_SESSION_TIMEOUT

セッションタイムアウト : 最小値.

関連項目:

定数フィールド値

MAX_SESSION_TIMEOUT

static final long MAX_SESSION_TIMEOUT

セッションタイムアウト : 最大値.

関連項目:

定数フィールド値

メソッドの詳細

putValue

void putValue(java.lang.String name,
              java.lang.Object value)
              throws InputException

要素を追加.

要素を追加します.

パラメータ:

name - 追加対象の要素名を設定します.

value - 要素情報を設定します.

例外:

InputException - 引数が不正な場合.

removeValue

void removeValue(java.lang.String name)
                 throws InputException

要素情報を削除.

要素を削除します.

パラメータ:

name - 削除対象の要素名を設定します.

例外:

InputException - 引数が不正な場合.

getValue

java.lang.Object getValue(java.lang.String name)

要素を取得.

要素を取得します.

パラメータ:

name - 取得対象の要素名を設定します.

戻り値:

Object 要素情報が返されます.

getNames

java.lang.String[] getNames()

登録されている要素名群を取得.

登録されている要素名群を取得します.

戻り値:

String[] 登録されている要素名群が返されます.

size

int size()

登録されている要素数を取得.

登録されている要素数を取得します.

戻り値:

int 登録されている要素数が返されます.

getApplicationName

java.lang.String getApplicationName()

アプリケーション名を取得.

アプリケーション名を取得します.

戻り値:

String アプリケーション名が返されます.

getId

long getId()

セッションIDを取得.

セッションIDを取得します.

戻り値:

long セッションIDが返されます.

getCreateTime

long getCreateTime()

セッション生成時間を取得.

セッション生成の時間を取得します.

戻り値:

long セッションが生成された時間が返されます.

getLastAccessTime

long getLastAccessTime()

ラストアクセス時間を取得.

ラストアクセス時間を取得します.

戻り値:

long ラストアクセス時間が返されます.

getSessionTimeout

long getSessionTimeout()

セッションタイムアウトを取得.

セッションタイムアウトを取得します.

戻り値:

long セッションのタイムアウト時間が返されます.

getTimeoutRemainder

long getTimeoutRemainder()

最後にリクエストされた時間からセッションタイムアウトする までの時間を取得.

最後にリクエストされた時間からセッションタイムアウトする までの時間を取得します.

戻り値:

long 最後にリクエストされた時間からの セッションタイムアウト値が返されます.

isSession

boolean isSession()

セッション情報が有効であるかチェック.

このセッション情報が有効であるかチェックします.

戻り値:

boolean チェック結果が返されます.
[true]が返された場合、セッションは有効です.
[false]が返された場合、セッションは無効です.