com.virtualweaver.xotics.dialect.xape.engine
Interface XapConstants


public interface XapConstants

This interface contains all the constants used by XAPE API.

Version:
2.1

Field Summary
static java.lang.String ACP_AUTO_LAUNCH
          ACP_AUTO_LAUNCH is one of the five parameter names used to configure an application loading.
static java.lang.String ACP_BASE_URL
          ACP_BASE_URL is one of the five parameter names used to configure an application loading.
static java.lang.String ACP_EXEC_MODE
          ACP_EXEC_MODE is one of the five parameter names used to configure an application loading.
static java.lang.String ACP_MULTI_INSTANCES
          ACP_MULTI_INSTANCES is one of the five parameter names used to configure an application loading.
static java.lang.String ACP_START_VARIABLES
          ACP_START_VARIABLES is one of the five parameter names used to configure an application loading.
static java.lang.String BUILD
          The version build number of XAPE API.
static long DEFAUL_IDLE_TIME_BEFORE_END
          Default value for ECP_IDLE_TIME_BEFORE_END
static int DEFAULT_MAX_PROCESSES
          Default value for ECP_MAX_PROCESSES
static int DEFAULT_MIN_PROCESSES
          Default value for ECP_MIN_PROCESSES
static java.lang.String ECP_IDLE_TIME_BEFORE_END
          ECP_IDLE_TIME_BEFORE_END is one of the three existing config parameter names for XAP Engine.
static java.lang.String ECP_MAX_PROCESSES
          ECP_MAX_PROCESSES is one of the three existing config parameter names for XAP Engine.
static java.lang.String ECP_MIN_PROCESSES
          ECP_MIN_PROCESSES is one of the three existing config parameter names for XAP Engine. this is the minimum number of thread to keep in the engine thread pool.
static java.lang.String END_STATE_NAME
          END_STATE_NAME is the ID of the special application ending .
static byte IN_CALLERS_THREAD
          IN_CALLERS_THREAD is one the two possible values for ACP_EXEC_MODE parameter.
static byte IN_DEDICATED_THREAD
          IN_DEDICATED_THREAD is one the two possible values for ACP_EXEC_MODE parameter.
static java.lang.String PRIVATE_CTX_DOC_NAME
          PRIVATE_CTX_DOC_NAME is the required name of the special XML document used as private instance context.
static byte REQ_TYPE_ASYNC
          REQ_TYPE_ASYNC is one of the three possible kinds of request. this one represents an asynchronous request, that is, a request which doesn't wait response.
static byte REQ_TYPE_ONEWAY
          REQ_TYPE_ONEWAY is one of the three possible kinds of request. this one represents a oneway request, that is, a request with no expected response
static byte REQ_TYPE_SYNC
          REQ_TYPE_SYNC is one of the three possible kinds of request. this one represents a synchronous request, that is, a request which waits until response arrives.
static java.lang.String SHUTDOWN_STATE_NAME
          SHUTDOWN_STATE_NAME is the ID of the special application shtudown , called by the system to stop an instance.
static java.lang.String START_STATE_NAME
          START_STATE_NAME is the ID of the special application starting .
static java.lang.String SYSTEM_MESSAGE_JUST_START
          ID of the system message : request instance startup but not execution, stop after executing .
static java.lang.String SYSTEM_MESSAGE_SHUTDOWN
          ID of the system message : request a shutdown, general or for a particular instance.
static java.lang.String VENDOR
          The vendor name of XAPE API.
static java.lang.String VERSION
          The version number of XAPE API.
 

Field Detail

VENDOR

public static final java.lang.String VENDOR
The vendor name of XAPE API.

See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
The version number of XAPE API.

See Also:
Constant Field Values

BUILD

public static final java.lang.String BUILD
The version build number of XAPE API.

See Also:
Constant Field Values

REQ_TYPE_ONEWAY

public static final byte REQ_TYPE_ONEWAY
REQ_TYPE_ONEWAY is one of the three possible kinds of request. this one represents a oneway request, that is, a request with no expected response

See Also:
Constant Field Values

REQ_TYPE_SYNC

public static final byte REQ_TYPE_SYNC
REQ_TYPE_SYNC is one of the three possible kinds of request. this one represents a synchronous request, that is, a request which waits until response arrives.

See Also:
Constant Field Values

REQ_TYPE_ASYNC

public static final byte REQ_TYPE_ASYNC
REQ_TYPE_ASYNC is one of the three possible kinds of request. this one represents an asynchronous request, that is, a request which doesn't wait response. The response is then retrieved from response queue provided in the request object. This kind of request is useful only for target instance running in a IN_DEDICATED_THREAD mode.

See Also:
Constant Field Values

IN_DEDICATED_THREAD

public static final byte IN_DEDICATED_THREAD
IN_DEDICATED_THREAD is one the two possible values for ACP_EXEC_MODE parameter. It makes each instance of an application to be processed in a dedicated thread, rather than the thread having sent the request (every processing is initiated by a XapeEngine.sendRequest() method).

See Also:
Constant Field Values

IN_CALLERS_THREAD

public static final byte IN_CALLERS_THREAD
IN_CALLERS_THREAD is one the two possible values for ACP_EXEC_MODE parameter. It makes each instance of an application to be processed by the thread calling XapeEngine.sendRequest() method.

See Also:
Constant Field Values

ECP_IDLE_TIME_BEFORE_END

public static final java.lang.String ECP_IDLE_TIME_BEFORE_END
ECP_IDLE_TIME_BEFORE_END is one of the three existing config parameter names for XAP Engine. This is the time (in millis) to wait before killing an inactive thread of the internal thread pool of the engine. Valid value is a Number representing a long value.

See Also:
Constant Field Values

ECP_MIN_PROCESSES

public static final java.lang.String ECP_MIN_PROCESSES
ECP_MIN_PROCESSES is one of the three existing config parameter names for XAP Engine. this is the minimum number of thread to keep in the engine thread pool. Valid value is a Number representing an int value.

See Also:
Constant Field Values

ECP_MAX_PROCESSES

public static final java.lang.String ECP_MAX_PROCESSES
ECP_MAX_PROCESSES is one of the three existing config parameter names for XAP Engine. The number of thread of the engine thread pool can not exceed this value. Valid value is a Number representing an int value.

See Also:
Constant Field Values

DEFAUL_IDLE_TIME_BEFORE_END

public static final long DEFAUL_IDLE_TIME_BEFORE_END
Default value for ECP_IDLE_TIME_BEFORE_END

See Also:
Constant Field Values

DEFAULT_MIN_PROCESSES

public static final int DEFAULT_MIN_PROCESSES
Default value for ECP_MIN_PROCESSES

See Also:
Constant Field Values

DEFAULT_MAX_PROCESSES

public static final int DEFAULT_MAX_PROCESSES
Default value for ECP_MAX_PROCESSES

See Also:
Constant Field Values

SYSTEM_MESSAGE_SHUTDOWN

public static final java.lang.String SYSTEM_MESSAGE_SHUTDOWN
ID of the system message : request a shutdown, general or for a particular instance. This value must be consider as a special request handler

See Also:
Constant Field Values

SYSTEM_MESSAGE_JUST_START

public static final java.lang.String SYSTEM_MESSAGE_JUST_START
ID of the system message : request instance startup but not execution, stop after executing . This request is relevant only for instances executed in mode IN_CALLERS_THREAD This value must be consider as a special request handler

See Also:
Constant Field Values

ACP_MULTI_INSTANCES

public static final java.lang.String ACP_MULTI_INSTANCES
ACP_MULTI_INSTANCES is one of the five parameter names used to configure an application loading. This one tells whether an application can have multiple instances, or can be instanciated once. Valid value for this paramter is a Boolean object. If true, loaded application can be instanciated as needed. If false, this application has only one instance and each request is sent to it.

See Also:
Constant Field Values

ACP_AUTO_LAUNCH

public static final java.lang.String ACP_AUTO_LAUNCH
ACP_AUTO_LAUNCH is one of the five parameter names used to configure an application loading. This one orders to start application automatically after loading. It's value is a string for the name of the instance started, in cas of multi-instances application. If application is mono instance, only the occurrence of this paramter is taken in consideration, so any string value can be provided.

See Also:
Constant Field Values

ACP_BASE_URL

public static final java.lang.String ACP_BASE_URL
ACP_BASE_URL is one of the five parameter names used to configure an application loading. This one gives a base URL for any relative URL specified in the application code. Valid value is an URL.

See Also:
Constant Field Values

ACP_START_VARIABLES

public static final java.lang.String ACP_START_VARIABLES
ACP_START_VARIABLES is one of the five parameter names used to configure an application loading. This one gives a map containing application variables. The map keys are variable names. Each name is a string, each value is also a string representing an XPath expression. Just before starting instance processing, these variables are interpreted and loaded into the variable set of the instance environment.

See Also:
Constant Field Values

ACP_EXEC_MODE

public static final java.lang.String ACP_EXEC_MODE
ACP_EXEC_MODE is one of the five parameter names used to configure an application loading. It specifies how to launch each aplication instance, in a dedicated thread (IN_DEDICATED_THREAD value) or in the thread calling XapeEngine.sendRequest() method (IN_CALLERS_THREAD value). Valid values are Byte objects having either IN_DEDICATED_THREAD or IN_CALLERS_THREAD constant value.

See Also:
Constant Field Values

START_STATE_NAME

public static final java.lang.String START_STATE_NAME
START_STATE_NAME is the ID of the special application starting . As an ID, it is unique. It is required to identify the state to start the application.

See Also:
Constant Field Values

END_STATE_NAME

public static final java.lang.String END_STATE_NAME
END_STATE_NAME is the ID of the special application ending . As an ID, it is unique. It is required to identify the state to end the application.

See Also:
Constant Field Values

SHUTDOWN_STATE_NAME

public static final java.lang.String SHUTDOWN_STATE_NAME
SHUTDOWN_STATE_NAME is the ID of the special application shtudown , called by the system to stop an instance. As an ID, it is unique. It is required to identify the state to end the application.

See Also:
Constant Field Values

PRIVATE_CTX_DOC_NAME

public static final java.lang.String PRIVATE_CTX_DOC_NAME
PRIVATE_CTX_DOC_NAME is the required name of the special XML document used as private instance context.

See Also:
Constant Field Values