バージョン: 20 R5 BETA

Session

Session オブジェクトは Session コマンドによって返されます。このオブジェクトは、カレントユーザーセッションを管理するためのインターフェースをデベロッパーに対して提供し、コンテキストデータの保存、プロセス間の情報共有、セッションに関連したプリエンプティブプロセスの開始などのアクションの実行や、アクセス権の管理を可能にします。

セッションの種類

このクラスは 3種類のセッションをサポートしています:

Webユーザーセッション: プロジェクトにおいてスケーラブルセッションが有効化されている場合、Webユーザーセッションが利用可能です。これらは Web および REST 接続に使用され、権限を割り当てることができます。
リモートクライアントユーザーセッション: クライアント/サーバーアプリケーションでは、リモートユーザーは、サーバー上で管理される独自のセッションを持ちます。
ストアドプロシージャーセッション: サーバ上で実行されるすべてのストアドプロシージャーは、同じ仮想ユーザーセッションを共有します。

注

Session オブジェクトにおいて利用可能なプロパティと関数は、セッションの種類に依存します。

概要


.clearPrivileges() : Boolean    対象セッションに紐づいているアクセス権をすべて削除し、実行が成功した場合に true を返します。
.expirationDate : Text    セッションcookie の有効期限
.hasPrivilege( privilege : Text ) : Boolean    対象セッションに privilege のアクセス権が紐づいていれば true、でなければ false を返します
.id : Text    サーバー上のセッションの一意な識別子 (UUID) を格納します
.idleTimeout : Integer    対象セッションが 4D によって終了されるまでの、非アクティブタイムアウト時間 (分単位)
.info : Object    サーバー上のリモートクライアントまたはストアドプロシージャーセッションの情報を格納します
.isGuest() : Boolean    アクセス権のないゲストセッションの場合は true を返します
.setPrivileges( privilege : Text ) : Boolean .setPrivileges( privileges : Collection ) .setPrivileges( settings : Object ) : Boolean    引数として渡したアクセス権やロールをセッションと紐づけ、実行が成功した場合に true を返します
.storage : Object    セッションのすべてのプロセスで利用可能な情報を保存しておける共有オブジェクトを格納します
.userName : Text    セッションと紐づいたユーザー名

Session

履歴

リリース	内容
20 R5	リモートクライアントとストアドプロシージャーセッションをサポート
18 R6	追加

Session : 4D.Session

引数	タイプ		説明
戻り値	4D.Session	<-	Session オブジェクト

説明

Session コマンドは、カレントのユーザーセッションに対応する Session オブジェクトを返します。

コマンドを呼び出したプロセスによって、カレントユーザーセッションは次のいずれかです:

Webセッション (スケーラブルセッションが有効化されている場合)
リモートクライアントセッション
ストアドプロシージャーセッション

詳細については、セッションの種類の段落を参照ください。

サポートされていないコンテキスト (シングルユーザーアプリケーション、スケーラブルセッションが無効...) から呼び出されると、コマンドは Null を返します。

Webセッション

Webセッションの Session オブジェクトは、どの Webプロセスからも利用できます:

On Web Authentication、On Web Connection、および On REST Authentication データベースメソッド
セミダイナミックページにおいて、4Dタグ (4DTEXT, 4DHTML, 4DEVAL, 4DSCRIPT/, 4DCODE) を介して処理されるコード
"公開オプション: 4DタグとURL(4DACTION...)" を有効化されたうえで、4DACTION/ URL から呼び出されたプロジェクトメソッド
モバイルリクエスト用の On Mobile App Authentication と On Mobile App Action データベースメソッド
RESTリクエストで呼び出された ORDA関数。

Webユーザーセッションの詳細については、Webサーバーセッションの章を参照ください。

リモートクライアントセッション

リモートクライアントの Session オブジェクトは、次のいずれかから利用できます:

サーバー上で実行属性を持つプロジェクトメソッド (クライアントプロセスの "双子" プロセスで実行されます)
トリガー
On Server Open Connection および On Server Shutdown Connection データベースメソッド

リモートユーザーセッションの詳細については、リモートクライアントユーザーセッション の段落を参照ください。

ストアドプロシージャーセッション

すべてのストアドプロシージャープロセスは、同じ仮想ユーザーセッションを共有します。ストアドプロシージャーの Session オブジェクトは、次のいずれかから利用できます:

Execute on server コマンドで呼び出されるメソッド
On Server Startup、On Server Shutdown、On Backup Startup、On Backup Shutdown、および On System event データベースメソッド

ストアドプロシージャーの仮想ユーザーセッションに関する情報については、4D Serverと4Dランゲージのページを参照ください。

例題

"公開オプション: 4DタグとURL(4DACTION...)" を有効にした action_Session メソッドを定義しました。ブラウザーに次の URL を入力してメソッドを呼び出します:

IP:port/4DACTION/action_Session

  //action_Session メソッド
 Case of
    :(Session#Null)
       If(Session.hasPrivilege("WebAdmin")) // hasPrivilege 関数を呼び出します
          WEB SEND TEXT("4DACTION --> セッションは WebAdmin です")
       Else
          WEB SEND TEXT("4DACTION --> セッションは WebAdmin ではありません")
       End if
    Else
       WEB SEND TEXT("4DACTION --> セッションは null です")
 End case

.clearPrivileges()

履歴

リリース	内容
18 R6	追加

.clearPrivileges() : Boolean

引数	タイプ		説明
戻り値	Boolean	<-	実行が正常に終わった場合には true

説明

注

権限は Webユーザーセッションでのみサポートされるため、他のセッションタイプではこの関数は何もせず、常に false を返します。

.clearPrivileges() 関数は、対象セッションに紐づいているアクセス権をすべて削除し、実行が成功した場合に true を返します。。結果的に、当該セッションは自動的にゲストセッションになります。

例題

// セッションを無効にします
var $isGuest : Boolean
var $isOK : Boolean

$isOK:=Session.clearPrivileges()
$isGuest:=Session.isGuest() // $isGuest は true

.expirationDate

履歴

リリース	内容
18 R6	追加

.expirationDate : Text

説明

注

このプロパティは、Webユーザーセッションの場合にのみ使用できます。

.expirationDate プロパティは、セッションcookie の有効期限を返します。値は ISO 8601標準に従って文字列で表現されます: YYYY-MM-DDTHH:MM:SS.mmmZ。

このプロパティは 読み取り専用 です。 .idleTimeout プロパティ値が変更された場合、有効期限は自動的に再計算されます。

例題

var $expiration : Text
$expiration:=Session.expirationDate // 例: "2021-11-05T17:10:42Z"

.hasPrivilege()

履歴

リリース	内容
18 R6	追加

.hasPrivilege( privilege : Text ) : Boolean

引数	タイプ		説明
privilege	Text	<-	確認するアクセス権の名称
戻り値	Boolean	<-	セッションが privilege のアクセス権を持っていれば true、それ以外は false

説明

注

権限は Webユーザーセッションでのみサポートされるため、他のセッションタイプではこの関数は何もせず、常に false を返します。

.hasPrivilege() 関数は、対象セッションに privilege のアクセス権が紐づいていれば true、でなければ false を返します。

例題

"WebAdmin" アクセス権がセッションに紐づいているかを確認します:

If (Session.hasPrivilege("WebAdmin"))
 // アクセス権が付与されているので、何もしません
Else
 // 認証ページを表示します
End if

.id

履歴

リリース	内容
20 R5	追加

.id : Text

説明

.id プロパティは、サーバー上のセッションの一意な識別子 (UUID) を格納します。この一意の文字列は、サーバーによって各セッションに対して自動的に割り当てられ、そのプロセスを識別することを可能にします。

.idleTimeout

履歴

リリース	内容
18 R6	追加

.idleTimeout : Integer

説明

注

このプロパティは、Webユーザーセッションの場合にのみ使用できます。

.idleTimeout プロパティは、対象セッションが 4D によって終了されるまでの、非アクティブタイムアウト時間 (分単位)を格納します。

プロパティ未設定時のデフォルト値は 60 (1時間) です。

このプロパティが設定されると、それに応じて .expirationDate プロパティも更新されます。

60 (分) 未満の値を指定することはできません (60 未満の値を設定した場合、タイムアウトは 60 (分) に設定されます)。

このプロパティは 読み書き可能 です。

例題

If (Session.isGuest())
 // ゲストセッションは、60分の非アクティブ時間経過後に終了します
 Session.idleTimeout:=60
Else
 // その他のセッションは、120分の非アクティブ時間経過後に終了します
 Session.idleTimeout:=120
End if

.info

履歴

リリース	内容
20 R5	追加

.info : Object

説明

注

このプロパティは、リモートクライアントおよびストアドプロシージャーセッションの場合にのみ使用できます。

.info プロパティは、サーバー上のリモートクライアントまたはストアドプロシージャーセッションの情報を格納します。

.info オブジェクトは、リモートクライアントおよびストアドプロシージャーセッションに対して Get process activity コマンドによって返されるオブジェクトと同じです。

.info オブジェクトには、次のプロパティが格納されています:

プロパティ	タイプ	説明
type	Text	セッションタイプ: "remote" または "storedProcedure"
userName	Text	4Dユーザー名 (`.userName` と同じ値)
machineName	Text	リモートセッション: リモートマシンの名前。ストアドプロシージャーセッション: サーバーマシンの名前
systemUserName	Text	リモートセッション: リモートマシン上で開かれたシステムセッションの名前。
IPAddress	Text	リモートマシンの IPアドレス。
hostType	Text	ホストタイプ: "windows" または "mac"
creationDateTime	日付 (ISO 8601)	セッション作成の日時
state	Text	セッションの状態: "active", "postponed", "sleeping"
ID	Text	セッションUUID (`.id` と同じ値))
persistentID	Text	セッションの永続的な ID

注

.info は計算プロパティなため、そのプロパティに対して何らかの処理をおこないたい場合は、呼び出し後にローカル変数に保存することが推奨されます。

.isGuest()

履歴

リリース	内容
18 R6	追加

.isGuest() : Boolean

引数	タイプ		説明
戻り値	Boolean	<-	ゲストセッションの場合は true、それ以外は false

説明

注

この関数は、リモートクライアントとストアドプロシージャーのセッションでは常に true を返します。

.isGuest() 関数は、アクセス権のないゲストセッションの場合は true を返します。

例題

On Web Connection データベースメソッドにて:

If (Session.isGuest())
 // ゲストユーザー用の処理
End if

.setPrivileges()

履歴

リリース	内容
19 R8	roles プロパティをサポート
18 R6	追加

.setPrivileges( privilege : Text ) : Boolean
.setPrivileges( privileges : Collection )
.setPrivileges( settings : Object ) : Boolean

引数	タイプ		説明
privilege	Text	->	アクセス権の名称
privileges	Collection	->	アクセス権の名称のコレクション
settings	Object	->	"privileges" プロパティ (文字列またはコレクション) を持つオブジェクト
戻り値	Boolean	<-	実行が正常に終わった場合には true

説明

注

権限は Webユーザーセッションでのみサポートされるため、他のセッションタイプではこの関数は何もせず、常に false を返します。

.setPrivileges() 関数は、引数として渡したアクセス権やロールをセッションと紐づけ、実行が成功した場合に true を返します。

privilege には、アクセス権の名称を文字列として渡します (複数の場合はカンマ区切り)。
privileges には、アクセス権の名称を文字列のコレクションとして渡します。
settings には、以下のプロパティを持つオブジェクトを渡します:

プロパティ	タイプ	説明
privileges	Text または Collection	アクセス権名の文字列アクセス権名のコレクション
roles	Text または Collection	ロールの文字列ロールの文字列のコレクション
userName	Text	(任意) セッションと紐づけるユーザー名

注

権限とロールは、プロジェクトの roles.json ファイルで定義されます。詳細については、権限を参照してください。

privileges または roles プロパティに、roles.json ファイルで宣言されていない名前が含まれている場合、その名前は無視されます。

セッションにアクセス権またはロールが紐づいていない場合、そのセッションはデフォルトでゲストセッションです。

userName プロパティは Session オブジェクトレベルで利用可能です (読み取り専用)。

例題

カスタムな認証メソッドにおいて、ユーザーに "WebAdmin" アクセス権を付与します:

var $userOK : Boolean

... // ユーザー認証

If ($userOK) // ユーザー認証に成功した場合
  var $info : Object
  $info:=New object()
  $info.privileges:=New collection("WebAdmin")
  Session.setPrivileges($info)
End if

.storage

履歴

リリース	内容
20 R5	リモートクライアントとストアドプロシージャーセッションをサポート
18 R6	追加

.storage : Object

説明

.storage プロパティは、セッションのすべてのプロセスで利用可能な情報を保存しておける共有オブジェクトを格納します。

Session オブジェクトの作成時には、.storage プロパティは空です。共有オブジェクトのため、このプロパティはサーバー上の Storage オブジェクトにおいて利用可能です。

サーバーの Storage オブジェクトと同様に、.storage プロパティは常に "single" で存在します。共有オブジェクトや共有コレクションを .storage に追加しても、共有グループは作成されません。

このプロパティは 読み取り専用 ですが、戻り値のオブジェクトは読み書き可能です。

Web session example
Remote session example

クライアントの IP を .storage プロパティに保存します。 On Web Authentication データベースメソッドに以下のように書けます:

If (Session.storage.clientIP=Null) // 最初のアクセス
    Use (Session.storage)
        Session.storage.clientIP:=New shared object("value"; $clientIP)
    End use 
End if

同じセッションのプロセス間でデータを共有したい場合:

Use (Session.storage)
 Session.storage.settings:=New shared object("property"; $value; "property2"; $value2)
End use

.userName

履歴

リリース	内容
20 R5	リモートクライアントとストアドプロシージャーセッションをサポート
18 R6	追加

.userName : Text

説明

.userName プロパティは、セッションと紐づいたユーザー名を格納します。このプロパティは、コード内でユーザーを確認するのに使用できます。

Webセッションでは、このプロパティはデフォルトで空の文字列です。これは、setPrivileges() 関数の privileges プロパティを使って設定することができます。
リモートおよびストアドプロシージャーセッションでは、このプロパティは Current user コマンドと同じユーザー名を返します。

このプロパティは 読み取り専用 です。

セッションの種類​

概要​

Session​

説明​

Webセッション​

リモートクライアントセッション​

ストアドプロシージャーセッション​

例題​

.clearPrivileges()​

説明​

例題​

.expirationDate​

説明​

例題​

.hasPrivilege()​

説明​

例題​

.id​

説明​

.idleTimeout​

説明​

例題​

.info​

説明​

.isGuest()​

説明​

例題​

.setPrivileges()​

説明​

例題​

.storage​

説明​

.userName​

説明​

セッションの種類

概要

Session

説明

Webセッション

リモートクライアントセッション

ストアドプロシージャーセッション

例題

.clearPrivileges()

説明

例題

.expirationDate

説明

例題

.hasPrivilege()

説明

例題

.id

説明

.idleTimeout

説明

例題

.info

説明

.isGuest()

説明

例題

.setPrivileges()

説明

例題

.storage

説明

.userName

説明