Clientオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.9 |
since | 2.0 |
セッション情報を取得するオブジェクト。
注意事項
Client.getメソッドにより返却される値は、Client.setにより設定された値とは別のインスタンスが返却されます。
従って以下のコードは値'foo'をコンソール上に表示します。
このAPIの挙動はintra-martのバージョンにより異なります。
注意事項
Client.getメソッドにより返却される値は、Client.setにより設定された値とは別のインスタンスが返却されます。
従って以下のコードは値'foo'をコンソール上に表示します。
var object = {value = 'foo'};
Client.set('key', object);
object.value = 'bar';
var object2 = Client.get('key');
Debug.console(object2.value); // 'foo'
このAPIの挙動はintra-martのバージョンにより異なります。
- ver3.2以前では、'foo'が表示されます。
- ver4.0以降では、'foo'または、'bar'が表示される可能性があります。
これは、APサーバのHttpSession実装に依存します。
例えば、セッションフェールオーバーを利用している場合等は、Client.setが呼び出された時点でセットした内容が永続化されます。
その後、Client.getにより値を取り出した際には、永続化された値の復元が行われ、Client.set時に格納した値とは別のインスタンスが返却されます。
逆に、APサーバがスタンドアロン環境、かつセッションフェールオーバー等を利用していない場合は、Client.set時に格納したインスタンスと同一のインスタンスが返却される可能性があります。
従って、このAPIを利用してセッション情報を格納、取得する場合、セッション情報を格納後、格納したセッション情報の変更は行わないようご注意下さい。 - ver8.0 (Accel Platform)以降では'foo'が表示されます。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
Object | get (String key ) staticクライアント固有保存情報を取得します。 |
String | identifier () static セッションIDを取得します。 |
Array | keys () static 保存キー一覧を取得します。 |
Number | life () static セッションタイムアウトの時間設定を取得する。 |
void | remove (String key ) staticクライアント固有情報を削除します。 |
void | set (String key , Object value ) staticクライアント固有情報を保存します。 |
void | sleep (Number millis ) static非推奨実行処理を中断します。
このメソッドは推奨されません。代替えメソッドも存在しません。
|
メソッドの詳細
Object get (String key )
static
クライアント固有保存情報を取得します。
パラメータ
返却値
|
String identifier ()
static
セッションIDを取得します。
返却値
|
Array keys ()
static
保存キー一覧を取得します。
返却値
|
Number life ()
static
セッションタイムアウトの時間設定を取得する。
返却値
|
void remove (String key )
static
クライアント固有情報を削除します。
パラメータ
返却値
|
void set (String key , Object value )
static
クライアント固有情報を保存します。
セッションにクライアント固有情報を保存します。 保存可能なデータは、プログラム中で自作したオブジェクト(Object,String,Arrayなどのインスタンス)です。 なお、Requestオブジェクト や Module.XXXXオブジェクト 等の、 intra-mart標準の組み込みオブジェクトは保存できません。
パラメータ
返却値
|
void sleep (Number millis )
static
非推奨
このメソッドは推奨されません。代替えメソッドも存在しません。
実行処理を中断します。
指定時間だけ、プログラムの実行を中断します。 時間指定の単位はミリ秒 引数には自然数を指定します。 仕様外の引数指定時の動作は保証外です。
パラメータ
返却値
|