com.infoteria.asteria.flowengine2.execute
Class SystemVariables

java.lang.Object
  |
  +--com.infoteria.asteria.flowengine2.execute.SystemVariables

All Implemented Interfaces:

java.lang.Cloneable, com.infoteria.asteria.value.Mapable, com.infoteria.asteria.value.ValueProvider

public class SystemVariables

extends java.lang.Object

implements com.infoteria.asteria.value.Mapable, java.lang.Cloneable

システム変数。
システム変数ではシステムで定義済みの変数名以外は使用できません。
定義済みの変数名はこのクラスのstaticフィールドに宣言されています。

Field Summary

static java.lang.String	ASTERIA_DIRECTORY サーバーフォルダーの変数名
static java.lang.String	DATA_DIRECTORY データフォルダーの変数名
static java.lang.String	EXCEPTION_COMPONENT Exceptionを発生したコンポーネント名の変数名。
static java.lang.String	EXCEPTION_COMPONENT_TYPE Exceptionを発生したコンポーネント名の種別。
static java.lang.String	EXCEPTION_DETAIL Exception詳細メッセージの変数名。
static java.lang.String	EXCEPTION_ERROR_CODE Exceptionのエラーコードの変数名。
static java.lang.String	EXCEPTION_FUNCTION_NAME Exceptionを発生したマッパー関数名
static java.lang.String	EXCEPTION_MESSAGE Exceptionメッセージの変数名。
static java.lang.String	EXCEPTION_PARAM ExceptionParamの変数名(数値部分を除く)。
static int	EXCEPTION_PARAM_COUNT ExceptionParam、ExceptionParamCountがサポートする個数。
static java.lang.String	EXCEPTION_PARAM_NAME ExceptionParamNameの変数名(数値部分を除く)。
static java.lang.String	EXECUTE_USER 実行ユーザの変数名。
static java.lang.String	FLOW_NAME フロー名の変数名。
static java.lang.String	FULL_REQUEST_URL HTTPで起動された場合のURLの変数名。
static java.lang.String	HTTP_METHOD HTTPで起動された場合のメソッド。
static java.lang.String	HTTP_REMOTE_ADDR HTTPで起動された場合のRemoteAddr。
static java.lang.String	HTTP_REMOTE_HOST HTTPで起動された場合のRemoteHost。
static java.lang.String	HTTP_SERVER_NAME HTTPで起動された場合のServerName。
static java.lang.String	HTTP_SERVER_PORT HTTPで起動された場合のServerPort。
static java.lang.String	INSTALLATION_DIRECTORY インストールフォルダーの変数名
static java.lang.String	OWNER_DIRECTORY プロジェクトオーナーのホームディレクトリの変数名。
static java.lang.String	PARENT_FLOW_NAME サブフロー、Exceptionフローでの親フロー名の変数名。
static java.lang.String	PARENT_PROJECT_NAME サブフロー、Exceptionフローでの親フローのプロジェクト名の変数名。
static java.lang.String	PROJECT_DIRECTORY プロジェクトファイルのディレクトリの変数名
static java.lang.String	PROJECT_FILE_NAME プロジェクトファイル名の変数名。
static java.lang.String	PROJECT_NAME プロジェクト名の変数名。
static java.lang.String	PROJECT_OWNER プロジェクトオーナーの変数名。
static java.lang.String	REQUEST_ID リクエストIDの変数名。
static java.lang.String	REQUEST_URL HTTPで起動された場合のURLの変数名。
static java.lang.String	SCENARIO_ACTIVITY_INSTANCE_ID シナリオアクティビティインスタンスIDの変数名
static java.lang.String	SCENARIO_CONTEXT_ID シナリオコンテキストIDの変数名
static java.lang.String	SCENARIO_ID シナリオIDの変数名
static java.lang.String	SCENARIO_INSTANCE_ID シナリオインスタンスIDの変数名
static java.lang.String	SCENARIO_STAGE_ID シナリオステージIDの変数名
static java.lang.String	SERVER_NAME サーバー名
static java.lang.String	SESSION_ID セッションIDの変数名。
static java.lang.String	SYSTEM_LOG_DIRECTORY システムログフォルダーの変数名
static java.lang.String	USER_DIRECTORY 実行ユーザのホームディレクトリの変数名。
static java.lang.String	WEB_LOGIN_USER WebLoginコンポーネントでログインしたユーザー名。

Method Summary

MapperException	getMapperException(FlowException ex) オリジナル例外をたどっていき、MapperExceptionを返します。
Value	getValue(int idx) idxに対応する変数のValueを返します。 サポートされる変数名のインデックスが何番であるかは不定なので それに依存するコードを書いてはいけません。 通常は変数名を引数とするgetValueメソッドを使用します。
Value	getValue(java.lang.String name) nameに対応する変数のValueを返します。 nameがシステム変数としてサポートされない場合はnullを返します。 サポートされる変数で、その値がnullの場合はnullが設定されたValueを返します。
static boolean	isHttpVar(java.lang.String name) 引数のnameがHTTP関連のシステム変数の場合はtrueを返します。
static boolean	isSupported(java.lang.String name) 引数のnameがシステム変数名としてサポートされている場合はtrueを返します。
java.util.Set	keySet() システム変数名(String)のSetを返します。
int	size() システム変数のサイズを返します。 この値はサポートされる変数の数と同じです。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROJECT_OWNER

public static final java.lang.String PROJECT_OWNER

プロジェクトオーナーの変数名。

PROJECT_NAME

public static final java.lang.String PROJECT_NAME

プロジェクト名の変数名。

PROJECT_FILE_NAME

public static final java.lang.String PROJECT_FILE_NAME

プロジェクトファイル名の変数名。

PROJECT_DIRECTORY

public static final java.lang.String PROJECT_DIRECTORY

プロジェクトファイルのディレクトリの変数名

FLOW_NAME

public static final java.lang.String FLOW_NAME

フロー名の変数名。

OWNER_DIRECTORY

public static final java.lang.String OWNER_DIRECTORY

プロジェクトオーナーのホームディレクトリの変数名。

REQUEST_ID

public static final java.lang.String REQUEST_ID

リクエストIDの変数名。

SESSION_ID

public static final java.lang.String SESSION_ID

セッションIDの変数名。

EXECUTE_USER

public static final java.lang.String EXECUTE_USER

実行ユーザの変数名。

USER_DIRECTORY

public static final java.lang.String USER_DIRECTORY

実行ユーザのホームディレクトリの変数名。

REQUEST_URL

public static final java.lang.String REQUEST_URL

HTTPで起動された場合のURLの変数名。

HTTP_REMOTE_HOST

public static final java.lang.String HTTP_REMOTE_HOST

HTTPで起動された場合のRemoteHost。

HTTP_REMOTE_ADDR

public static final java.lang.String HTTP_REMOTE_ADDR

HTTPで起動された場合のRemoteAddr。

HTTP_SERVER_NAME

public static final java.lang.String HTTP_SERVER_NAME

HTTPで起動された場合のServerName。

HTTP_SERVER_PORT

public static final java.lang.String HTTP_SERVER_PORT

HTTPで起動された場合のServerPort。

FULL_REQUEST_URL

public static final java.lang.String FULL_REQUEST_URL

HTTPで起動された場合のURLの変数名。

HTTP_METHOD

public static final java.lang.String HTTP_METHOD

HTTPで起動された場合のメソッド。

WEB_LOGIN_USER

public static final java.lang.String WEB_LOGIN_USER

WebLoginコンポーネントでログインしたユーザー名。

PARENT_PROJECT_NAME

public static final java.lang.String PARENT_PROJECT_NAME

サブフロー、Exceptionフローでの親フローのプロジェクト名の変数名。

PARENT_FLOW_NAME

public static final java.lang.String PARENT_FLOW_NAME

サブフロー、Exceptionフローでの親フロー名の変数名。

EXCEPTION_COMPONENT

public static final java.lang.String EXCEPTION_COMPONENT

Exceptionを発生したコンポーネント名の変数名。

EXCEPTION_MESSAGE

public static final java.lang.String EXCEPTION_MESSAGE

Exceptionメッセージの変数名。

EXCEPTION_DETAIL

public static final java.lang.String EXCEPTION_DETAIL

Exception詳細メッセージの変数名。

EXCEPTION_ERROR_CODE

public static final java.lang.String EXCEPTION_ERROR_CODE

Exceptionのエラーコードの変数名。

EXCEPTION_COMPONENT_TYPE

public static final java.lang.String EXCEPTION_COMPONENT_TYPE

Exceptionを発生したコンポーネント名の種別。

EXCEPTION_FUNCTION_NAME

public static final java.lang.String EXCEPTION_FUNCTION_NAME

Exceptionを発生したマッパー関数名

EXCEPTION_PARAM

public static final java.lang.String EXCEPTION_PARAM

ExceptionParamの変数名(数値部分を除く)。

EXCEPTION_PARAM_NAME

public static final java.lang.String EXCEPTION_PARAM_NAME

ExceptionParamNameの変数名(数値部分を除く)。

EXCEPTION_PARAM_COUNT

public static final int EXCEPTION_PARAM_COUNT

ExceptionParam、ExceptionParamCountがサポートする個数。

SCENARIO_ID

public static final java.lang.String SCENARIO_ID

シナリオIDの変数名

SCENARIO_INSTANCE_ID

public static final java.lang.String SCENARIO_INSTANCE_ID

シナリオインスタンスIDの変数名

SCENARIO_CONTEXT_ID

public static final java.lang.String SCENARIO_CONTEXT_ID

シナリオコンテキストIDの変数名

SCENARIO_STAGE_ID

public static final java.lang.String SCENARIO_STAGE_ID

シナリオステージIDの変数名

SCENARIO_ACTIVITY_INSTANCE_ID

public static final java.lang.String SCENARIO_ACTIVITY_INSTANCE_ID

シナリオアクティビティインスタンスIDの変数名

INSTALLATION_DIRECTORY

public static final java.lang.String INSTALLATION_DIRECTORY

インストールフォルダーの変数名

ASTERIA_DIRECTORY

public static final java.lang.String ASTERIA_DIRECTORY

サーバーフォルダーの変数名

DATA_DIRECTORY

public static final java.lang.String DATA_DIRECTORY

データフォルダーの変数名

SYSTEM_LOG_DIRECTORY

public static final java.lang.String SYSTEM_LOG_DIRECTORY

システムログフォルダーの変数名

SERVER_NAME

public static final java.lang.String SERVER_NAME

サーバー名

Method Detail

isSupported

public static boolean isSupported(java.lang.String name)

引数のnameがシステム変数名としてサポートされている場合はtrueを返します。

isHttpVar

public static boolean isHttpVar(java.lang.String name)

引数のnameがHTTP関連のシステム変数の場合はtrueを返します。

getValue

public Value getValue(java.lang.String name)

nameに対応する変数のValueを返します。
nameがシステム変数としてサポートされない場合はnullを返します。
サポートされる変数で、その値がnullの場合はnullが設定されたValueを返します。

Specified by:

getValue in interface com.infoteria.asteria.value.ValueProvider

getMapperException

public MapperException getMapperException(FlowException ex)

オリジナル例外をたどっていき、MapperExceptionを返します。

getValue

public Value getValue(int idx)

idxに対応する変数のValueを返します。
サポートされる変数名のインデックスが何番であるかは不定なので それに依存するコードを書いてはいけません。
通常は変数名を引数とするgetValueメソッドを使用します。

size

public int size()

システム変数のサイズを返します。
この値はサポートされる変数の数と同じです。

Specified by:

size in interface com.infoteria.asteria.value.Mapable

keySet

public java.util.Set keySet()

システム変数名(String)のSetを返します。

Specified by:

keySet in interface com.infoteria.asteria.value.Mapable