AR System Java API

com.bmc.arsys.api
Class ServerInfo

java.lang.Object
  extended by com.bmc.arsys.api.ServerInfo
All Implemented Interfaces:
Serializable, Cloneable

public class ServerInfo
extends Object
implements Cloneable, Serializable

The ServerInfo class represents the server information operations and their values returned from a server.

See Also:
Serialized Form

Field Summary
static int ACTLINK_DIR
          Name of a directory where all external processes to be run by active links must reside.
static int ACTLINK_SHELL
          Name of a shell to use when running external processes from an active link.
static int ADMIN_ONLY
          Flag indicating whether the server is in Administrator Only mode (1) or not (0).
static int ADMIN_TCP_PORT
          (Obsolete server option.)
static int ALLOW_GUESTS
          Flag indicating whether the server accepts guest users.
static int AP_DEFN_CHECK
          Length of time in seconds between checks by an application service to verify that definitions it is using from AR System are correct.
static int AP_LOG_FILE
          Name of the file to use if approval tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int AP_RPC_SOCKET
          RPC program number the approval server will use when contacting the AR System.
static int API_LOG_FILE
          Name of the file to use if API tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int APP_SERVICE_PASSWD
          AR System Application Service password.
static int APPL_PENDING
          The name of the form that contains the pending list of application commands to be processed.
static int APPLICATION_AUDIT
          (character string) Application license audit line.
static int ARFORK_LOG_FILE
          Name of fork log file.
static int CACHE_LOG_FILE
          (Obsolete server option.)
static int CACHE_SEG_SIZE
          (Obsolete server option.)
static int CANCEL_QUERY
          Cancels query on Remedy User client.
static int CASE_SENSITIVE
          Value indicating whether the underlying database is case-sensitive.
static int CHECK_NOTIF_USERS
          Checks alert users.
static int CLUSTERED_INDEX
          Value that indicates whether a clustered index is created on the Entry-Id field when a new form is created.
static int DB_NAME
          Name of the underlying SQL database (not applicable for Oracle databases).
static int DB_PASSWORD
          Database password associated with the ARSystem database or tablespace (applicable to Sybase and Oracle databases only).
static int DB_TYPE
          Type of database used by server
static int DB_USER
          User name the Action Request System uses to access the underlying database.
static int DB_VERSION
          Underlying database version (character string).
static int DBCONF
          Complete contents of the db.conf (ardb.cfg) file.
static int DBHOME_DIR
          Home directory for the underlying database (applicable for SQL databases only).
static int DEBUG_GROUPID
          ID of the group whose members are allowed to retrieve server logging information.
static int DEBUG_MODE
          Indicates the server debug modes.
static int DEFAULT_ORDER_BY
          Integer (1 or 0) indicating the default order of requests in a form when issuing ARGetListEntry calls, so that the sorting is done on the database and before the results are returned.
static int DEFAULT_WEB_PATH
          Default path for web access.
static int DELAYED_CACHE
          Flag indicating whether to disable recaching of the shared cache after a time-out.
static int DISABLE_ADMIN_OPERATIONS
          Disables admin operations.
static int DISABLE_ALERTS
          Disables alerts.
static int DISABLE_ESCALATIONS
          Disables escalations.
static int DISABLED_CLIENT
          Disallows certain client types from the server.
static int DS_LOG_FILE
          Name of the file to use if distributed server tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int DS_MAPPING
          Name of the form that contains distributed mapping definitions (applicable for Distributed Server Option only).
static int DS_PENDING
          Name of the form that contains the pending operation list (applicable for Distributed Server Option only).
static int DS_POOL
          Name of form holding distributed pools.
static int DS_RPC_SOCKET
          Specific server socket to use for the distributed server (applicable for Distributed Server Option only).
static int DS_SVR_LICENSE
          Distributed server license type (character string).
static int DSO_DEST_PORT
          TCP port that the distributed server uses to communicate with the AR System server.
static int DSO_MERGE_STYLE
          Indicates merge style to use when distributed server encounters duplicate entry IDs.
static int DSO_PLACEHOLDER_MODE
          Placeholder mode for the distributed server.
static int DSO_POLLING_INTERVAL
          How often to poll the distributed server.
static int DSO_SOURCE_SERVER
          Source AR System server for the distributed server.
static int DSO_TARGET_CONNECTION
          String of AR System target server name, RPC, and port number for use with the distributed server.
static int DSO_TARGET_PASSWD
          Password for the distributed server Target server.
static int DSO_TIMEOUT_NORMAL
          Number of seconds for the timeout that the distributed server uses when making API calls.
static int DSO_USER_PASSWD
          User password for the distributed server.
static int EA_RPC_SOCKET
          RPC socket number on which an external authentication server awaits requests for authentication.
static int EA_RPC_TIMEOUT
          RPC timeout (seconds) used when making calls to the authentication (AREA) server (for example, 30 seconds).
static int EA_SYNC_TIMEOUT
          Internal (seconds) the AR server uses to periodically invoke the external authentication server's AREANeedToSyncCallback() function, which instructs the AR System server to renew its internally stored user information in the event there are changes made to the source used to authenticate users.
static int EMAIL_FROM
          Sender name to use for filter-generated email notifications where no subject is specified.
static int EMAIL_LINE_LEN
          Maximum line length of email messages.
static int EMAIL_SYSTEM
          Character string that indicates the email system on UNIX.
static int EMAIL_TIMEOUT
          Length of time in seconds before the system closes the pipe to sendmail to unblock the AR System server.
static int EMBEDDED_SQL
          (Obsolete server option.) Value indicating whether the underlying SQL database is embedded (bundled with the Action Request System).
static int ENC_DATA_ENCR_ALG
          API data encryption algorithm.
static int ENC_DATA_KEY_EXP
          Time until the encrypted API session key expires.
static int ENC_PUB_KEY
          Server public key.
static int ENC_PUB_KEY_EXP
          Time (seconds) until the server's public/private keys expire.
static int ENC_SEC_POLICY
          Security policy.
static int ENC_SESS_H_ENTRIES
          Number of API session hash entries.
static int ENCRYPT_AL_SQL
          (Obsolete server option.)
static int ESCALATION_LOG_FILE
          Name of the file to use if escalation tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int ESCL_DAEMON
          (Obsolete server option.)
static int ESCL_TCP_PORT
          (Obsolete server option.)
static int EXPORT_VERSION
          Integer indicating the server's export version number.
static int FAST_TCP_PORT
          (Obsolete server option.)
static int FILT_MAX_STACK
          Maximum number of levels of recursion allowed for a given operation.
static int FILT_MAX_TOTAL
          Maximum number of filters that the server will execute for a given operation.
static int FILTER_API_RPC_TIMEOUT
          Timeout associated with calls to the filter API.
static int FILTER_LOG_FILE
          Name of the file to use if filter tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int FIXED_LICENSE
          Number of fixed user licenses.
static int FLASH_DAEMON
          (Obsolete server option.)
static int FLASH_TCP_PORT
          (Obsolete server option.)
static int FLOAT_LICENSE
          Number of floating write licenses defined.
static int FLOAT_TIMEOUT
          Number of hours the server waits before disconnecting inactive users.
static int FTEXT_FIXED
          Number of fixed Full Text Search (FTS) licenses defined.
static int FTEXT_FLOAT
          Number of floating Full Text Search (FTS) licenses defined.
static int FTEXT_TIMEOUT
          Number of hours the server waits before disconnecting inactive users with Full Text Search (FTS) licenses.
static int FULL_HOSTNAME
          Full DNS host name of the server ("long" machine name).
static int G_CACHE_CHANGE
          Time of the last change to the group cache.
static int HARDWARE
          Server hardware type (character string).
static int HOMEPAGE_FORM
          Homepage form.
static int HOSTNAME
          Host name of the server ("short" machine name).
static int INFORMIX_DBN
          Informix database server name.
static int INFORMIX_RELAY_MOD
          Character string that indicates the Informix relay module.
static int INFORMIX_TBC
          Informix configuration file.
static int INGRES_VNODE
          (Obsolete server option.)
static int INIT_FORM
          An "Initial Form" to be loaded on Login that establishes an initial state.
static int LIST_TCP_PORT
          (Obsolete server option.)
static int LOCALIZED_SERVER
          Localized server for localized error messages.
static int LOGFILE_APPEND
          Integer (0/1) value that indicates whether to create a separate *.bak file or to append to the existing log file.
static int MAX_AUDIT_LOG_FILE_SIZE
          Maximum size of audit log file.
static int MAX_ENTRIES
          Maximum number of entries returned by a single query.
static int MAX_F_DAEMONS
          (Obsolete server option.)
static int MAX_L_DAEMONS
          (Obsolete server option.)
static int MAX_LOG_FILE_SIZE
          Maximum size for system log files.
static int MAX_SCHEMAS
          Maximum number of forms allowed.
static int MESSAGE_CAT_SCHEMA
          Name of message catalog form for localized error messages.
static int MID_TIER_PASSWD
          Mid tier password.
static int MINIMUM_API_VER
          Value indicating the minimum API version that the server supports.
static int MULT_ASSIGN_GROUPS
          Multiple assign groups for Field 112 (row level access).
static int MULTI_SERVER
          Integer (0/1) value indicating the use of the multi-server option.
static int NFY_TCP_PORT
          (Obsolete server option.) TCP port that the Notifier server will use.
static int NOTIF_OUTBOUND_PORT
          Alert outbound port.
static int NOTIF_SCHEMA
          Name of form holding alert events.
static int NOTIF_SEND_TIMEOUT
          Number of seconds to wait before sending timeout.
static int NOTIF_SOURCE_AR
          AR System source tag.
static int NOTIF_SOURCE_FB
          Flashboards source tag.
static int NOTIFICATION_LOG_FILE
          File used for notification (alerts) log.
static int ORACLE_QUERY_ON_CLOB
          Support search on Oracle CLOB field.
static int ORACLE_SID
          System ID of the Oracle database you are accessing.
static int ORACLE_TWO_T
          The two-task environment setting for remote access to an Oracle database.
static int OS
          Character string that indicates the server operating system, which includes the version number.
static int PLUGIN_ALIAS
          List of plug-in aliases.
static int PLUGIN_LOG_FILE
          Log file name for arplugin.
static int PLUGIN_PASSWD
          Plug-in server's password.
static int PLUGIN_TARGET_PASSWD
          Password used by plug-in server clients.
static int PREFERENCE_PRIORITY
          Priority number for preference server.
static int PS_RPC_SOCKET
          RPC program number and port pairs the Private Servers will use.
static int REGISTER_PORTMAPPER
          Flag indicating whether to register with the portmapper (1) or not (0).
static int REM_SERV_ID
          AR System server ID associated with the license (character string).
static int RESERV1_A
          (integer) Number of fixed reserve licenses.
static int RESERV1_B
          (integer) Number of floating reserve licenses.
static int RESERV1_C
          (integer) Number of admin reserve licenses.
static int SAVE_LOGIN
          Value indicating administrator override for saving login information on the client: 0 means the user decides whether to save (default setting).
static int SCC_COMMENT_CHECKIN
          Integer (0 or 1) value indicating whether or not a source code control integration requires you to entire a comment at checkin time.
static int SCC_COMMENT_CHECKOUT
          Integer (0 or 1) value indicating whether or not a source code control integration requires you to enter a comment at checkout time.
static int SCC_ENABLED
          Value indicating whether a source code control system is being used with AR System.
static int SCC_INTEGRATION_MODE
          Integer (0 or 1) value indicating the level of source code control integration.
static int SCC_PROVIDER_NAME
          Character string for the source code control system provider name.
static int SCC_TARGET_DIR
          Character string for the source code control system target directory.
static int SERVER_DIR
          Data directory for AR System.
static int SERVER_IDENT
          Unique identifier for the server (character string).
static int SERVER_LANG
          Local language setting of the server.
static int SERVER_LICENSE
          Type of server license
static int SERVER_NAME
          Alias server name that is always interpreted as the current server.
static int SERVER_TIME
          AR System server time.
static int SET_PROC_TIME
          Number of seconds the server waits before ending a set fields process that has not completed.
static int SG_EMAIL_STATE
          State of server group email process 0 = no server group 1 = suspended 2 = resumed
static int SG_FLASHBOARDS_STATE
          State of server group flashboards process 0 = no server group 1 = suspended 2 = resumed
static int SHARED_CACHE
          (Obsolete server option.)
static int SHARED_MEM
          (UNIX only) A flag indicating whether the shared memory is disabled or enabled.
static int SQL_LOG_FILE
          Name of the file to use if SQL tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int STRUCT_CHANGE
          Last structure change (for this run of the server).
static int SUBMITTER_MODE
          Submitter mode for the AR System.
static int SUPPRESS_WARN
          Series of zero or more message numbers (separated by spaces) that identify the informational or warning messages that the system suppresses.
static int SVR_EVENT_LIST
          List of server events of track.
static int SVR_SEC_CACHE
          (integer) Ties security cache to specific server name (0/1).
static int SVR_STATS_REC_INTERVAL
          Recording interval (seconds) of server event statistics .
static int SVR_STATS_REC_MODE
          Recording mode for server events statistics.
static int SYBASE_CHARSET
          Character set being used to access a Sybase database.
static int SYBASE_SERV
          Sybase logical server name.
static int TCD_TCP_PORT
          TCP port for arservtcd thread.
static int THREAD_LOG_FILE
          Name of the file to use if thread tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).
static int U_CACHE_CHANGE
          Time of the last change to the user cache.
static int UNQUAL_QUERIES
          Indicates whether the server allows unqualified queries.
static int USE_ETC_PASSWD
          Indicates whether the /etc/passwd file is used to validate users not registered with the AR System (UNIX only).
static int USER_CACHE_UTILS
          Flag indicating whether the ARCACHE and ARRELOAD utilities are enabled.
static int USER_INFO_LISTS
          (integer) Number of User/NotifyUser hash lists
static int USER_INST_TIMEOUT
          (integer) Timeout interval to flush user instances in User Cache hash lists.
static int USER_LOG_FILE
          Name of the file to use if user tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
static int VERSION
          AR System server version (character string).
static int XREF_PASSWORDS
          Indicates whether the /etc/passwd file is cross-referenced if an AR System user has no password (UNIX only).
 
Constructor Summary
ServerInfo(int operation, Value value)
           
 
Method Summary
 Object clone()
          Clone implementation that returns an Object with data cloned from self.
 boolean equals(Object obj)
           
 int getOperation()
          Returns the server operation.
 Value getValue()
          Returns the value of server operation.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DB_TYPE

public static final int DB_TYPE
Type of database used by server

See Also:
Constant Field Values

SERVER_LICENSE

public static final int SERVER_LICENSE
Type of server license

See Also:
Constant Field Values

FIXED_LICENSE

public static final int FIXED_LICENSE
Number of fixed user licenses.

See Also:
Constant Field Values

VERSION

public static final int VERSION
AR System server version (character string).

See Also:
Constant Field Values

ALLOW_GUESTS

public static final int ALLOW_GUESTS
Flag indicating whether the server accepts guest users. Guest users are users not registered with the AR System. If allowed,guest users have no permissions but are allowed to perform some basic operations. Guest users can submit entries to forms for which permission has been given to the Public group and enter data in fields that have been defined as allowing any user to submit. If not allowed, unregistered users have no access to the system. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow guest users).

See Also:
Constant Field Values

USE_ETC_PASSWD

public static final int USE_ETC_PASSWD
Indicates whether the /etc/passwd file is used to validate users not registered with the AR System (UNIX only). If so, users in /etc/passwd are considered valid users of AR System and are assigned to a group identified by the UNIX group ID. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (use password file).

See Also:
Constant Field Values

XREF_PASSWORDS

public static final int XREF_PASSWORDS
Indicates whether the /etc/passwd file is cross-referenced if an AR System user has no password (UNIX only). This option enables you to manage group membership and other support information by using the AR System but still manage passwords using the /etc/passwd file. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0 (blank passwords are not cross referenced).

See Also:
Constant Field Values

DEBUG_MODE

public static final int DEBUG_MODE
Indicates the server debug modes. Possible constant values include:

See Also:
Constant Field Values

DB_NAME

public static final int DB_NAME
Name of the underlying SQL database (not applicable for Oracle databases). The default value is ARSystem.

See Also:
Constant Field Values

DB_PASSWORD

public static final int DB_PASSWORD
Database password associated with the ARSystem database or tablespace (applicable to Sybase and Oracle databases only). The password is stored in encrypted form.

See Also:
Constant Field Values

HARDWARE

public static final int HARDWARE
Server hardware type (character string).

See Also:
Constant Field Values

OS

public static final int OS
Character string that indicates the server operating system, which includes the version number.

See Also:
Constant Field Values

SERVER_DIR

public static final int SERVER_DIR
Data directory for AR System. This directory contains support files for the underlying SQL database (but no actual database files).

See Also:
Constant Field Values

DBHOME_DIR

public static final int DBHOME_DIR
Home directory for the underlying database (applicable for SQL databases only).

See Also:
Constant Field Values

SET_PROC_TIME

public static final int SET_PROC_TIME
Number of seconds the server waits before ending a set fields process that has not completed. Valid values for this option are 1 through 20. The default value is five seconds.

See Also:
Constant Field Values

EMAIL_FROM

public static final int EMAIL_FROM
Sender name to use for filter-generated email notifications where no subject is specified. Only "trusted" email users can use this name (see the Remedy Email Engine Guide for more information about trusted email users).

See Also:
Constant Field Values

SQL_LOG_FILE

public static final int SQL_LOG_FILE
Name of the file to use if SQL tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

FLOAT_LICENSE

public static final int FLOAT_LICENSE
Number of floating write licenses defined.

See Also:
Constant Field Values

FLOAT_TIMEOUT

public static final int FLOAT_TIMEOUT
Number of hours the server waits before disconnecting inactive users. If a user is holding a floating write license token, the system also frees the token at this time. The default is 2 hours.

See Also:
Constant Field Values

UNQUAL_QUERIES

public static final int UNQUAL_QUERIES
Indicates whether the server allows unqualified queries. Unqualified queries are calls in which the qualifier parameter is either NULL or has an operation value of 0 (AR_COND_OP_NONE). These queries can cause performance problems, especially for large forms, because they return all entries for a given form. If not allowed, you can return all form entries by specifying a "dummy" qualification such as 1 = 1. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow unqualified queries).

See Also:
Constant Field Values

FILTER_LOG_FILE

public static final int FILTER_LOG_FILE
Name of the file to use if filter tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

USER_LOG_FILE

public static final int USER_LOG_FILE
Name of the file to use if user tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

REM_SERV_ID

public static final int REM_SERV_ID
AR System server ID associated with the license (character string).

See Also:
Constant Field Values

MULTI_SERVER

public static final int MULTI_SERVER
Integer (0/1) value indicating the use of the multi-server option. A 0 value indicates a single server; a 1 value indicates the use of the multi-server option.

See Also:
Constant Field Values

EMBEDDED_SQL

public static final int EMBEDDED_SQL
(Obsolete server option.) Value indicating whether the underlying SQL database is embedded (bundled with the Action Request System). Valid values for this option are 0 (not embedded) and 1 (embedded).

See Also:
Constant Field Values

MAX_SCHEMAS

public static final int MAX_SCHEMAS
Maximum number of forms allowed. The default value is 0 (no limit).

See Also:
Constant Field Values

DB_VERSION

public static final int DB_VERSION
Underlying database version (character string).

See Also:
Constant Field Values

MAX_ENTRIES

public static final int MAX_ENTRIES
Maximum number of entries returned by a single query. Because users can also specify the maximum number of entries returned (in query preferences), the actual maximum is the lower of these two values. The default value is no (server-defined) maximum.

See Also:
Constant Field Values

MAX_F_DAEMONS

public static final int MAX_F_DAEMONS
(Obsolete server option.)

See Also:
Constant Field Values

MAX_L_DAEMONS

public static final int MAX_L_DAEMONS
(Obsolete server option.)

See Also:
Constant Field Values

ESCALATION_LOG_FILE

public static final int ESCALATION_LOG_FILE
Name of the file to use if escalation tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

ESCL_DAEMON

public static final int ESCL_DAEMON
(Obsolete server option.)

See Also:
Constant Field Values

SUBMITTER_MODE

public static final int SUBMITTER_MODE
Submitter mode for the AR System. Submitter of an entry must have a license to modify it. In locked mode, the Submitter field cannot be changed after submit, and the submitter can modify the entry with or without a write license (if the Submitter group has Change permission). In changeable mode, the Submitter field can be changed after submit, but the submitter must have a write license to modify the entry (if the Submitter group has Change permission). Valid values for this option are 1 (submitter locked at create) and 2 (submitter changeable after create). The default value is 2 (changeable).

See Also:
Constant Field Values

API_LOG_FILE

public static final int API_LOG_FILE
Name of the file to use if API tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

FTEXT_FIXED

public static final int FTEXT_FIXED
Number of fixed Full Text Search (FTS) licenses defined.

See Also:
Constant Field Values

FTEXT_FLOAT

public static final int FTEXT_FLOAT
Number of floating Full Text Search (FTS) licenses defined.

See Also:
Constant Field Values

FTEXT_TIMEOUT

public static final int FTEXT_TIMEOUT
Number of hours the server waits before disconnecting inactive users with Full Text Search (FTS) licenses. If a user is holding a floating FTS license token, the system also frees the token at this time.

See Also:
Constant Field Values

RESERV1_A

public static final int RESERV1_A
(integer) Number of fixed reserve licenses.

See Also:
Constant Field Values

RESERV1_B

public static final int RESERV1_B
(integer) Number of floating reserve licenses.

See Also:
Constant Field Values

RESERV1_C

public static final int RESERV1_C
(integer) Number of admin reserve licenses.

See Also:
Constant Field Values

SERVER_IDENT

public static final int SERVER_IDENT
Unique identifier for the server (character string).

See Also:
Constant Field Values

DS_SVR_LICENSE

public static final int DS_SVR_LICENSE
Distributed server license type (character string). Applicable for Distributed Server Option (DSO) only.

See Also:
Constant Field Values

DS_MAPPING

public static final int DS_MAPPING
Name of the form that contains distributed mapping definitions (applicable for Distributed Server Option only).

See Also:
Constant Field Values

DS_PENDING

public static final int DS_PENDING
Name of the form that contains the pending operation list (applicable for Distributed Server Option only).

See Also:
Constant Field Values

DS_RPC_SOCKET

public static final int DS_RPC_SOCKET
Specific server socket to use for the distributed server (applicable for Distributed Server Option only). Valid values for this option are 390600, 390621-390634, 390636-390669, and 390680 through 390694. Any other value causes the distributed server to use the default server.

See Also:
Constant Field Values

DS_LOG_FILE

public static final int DS_LOG_FILE
Name of the file to use if distributed server tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE). Applicable for Distributed Server Option only.

See Also:
Constant Field Values

SUPPRESS_WARN

public static final int SUPPRESS_WARN
Series of zero or more message numbers (separated by spaces) that identify the informational or warning messages that the system suppresses.

See Also:
Constant Field Values

HOSTNAME

public static final int HOSTNAME
Host name of the server ("short" machine name).

See Also:
Constant Field Values

FULL_HOSTNAME

public static final int FULL_HOSTNAME
Full DNS host name of the server ("long" machine name).

See Also:
Constant Field Values

SAVE_LOGIN

public static final int SAVE_LOGIN
Value indicating administrator override for saving login information on the client:

See Also:
Constant Field Values

U_CACHE_CHANGE

public static final int U_CACHE_CHANGE
Time of the last change to the user cache.

See Also:
Constant Field Values

G_CACHE_CHANGE

public static final int G_CACHE_CHANGE
Time of the last change to the group cache.

See Also:
Constant Field Values

STRUCT_CHANGE

public static final int STRUCT_CHANGE
Last structure change (for this run of the server).

See Also:
Constant Field Values

CASE_SENSITIVE

public static final int CASE_SENSITIVE
Value indicating whether the underlying database is case-sensitive. Valid values for this option are 0 (case-sensitive) and 1 (case-insensitive). The default value is 1 (case-insensitive).

See Also:
Constant Field Values

SERVER_LANG

public static final int SERVER_LANG
Local language setting of the server.

See Also:
Constant Field Values

ADMIN_ONLY

public static final int ADMIN_ONLY
Flag indicating whether the server is in Administrator Only mode (1) or not (0). When not in Administrator Only mode, subadministrators can also perform administrator duties. The default value is 0 (Not in Administrator Only mode).

See Also:
Constant Field Values

CACHE_LOG_FILE

public static final int CACHE_LOG_FILE
(Obsolete server option.)

See Also:
Constant Field Values

FLASH_DAEMON

public static final int FLASH_DAEMON
(Obsolete server option.)

See Also:
Constant Field Values

THREAD_LOG_FILE

public static final int THREAD_LOG_FILE
Name of the file to use if thread tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).

See Also:
Constant Field Values

ADMIN_TCP_PORT

public static final int ADMIN_TCP_PORT
(Obsolete server option.)

See Also:
Constant Field Values

ESCL_TCP_PORT

public static final int ESCL_TCP_PORT
(Obsolete server option.)

See Also:
Constant Field Values

FAST_TCP_PORT

public static final int FAST_TCP_PORT
(Obsolete server option.)

See Also:
Constant Field Values

LIST_TCP_PORT

public static final int LIST_TCP_PORT
(Obsolete server option.)

See Also:
Constant Field Values

FLASH_TCP_PORT

public static final int FLASH_TCP_PORT
(Obsolete server option.)

See Also:
Constant Field Values

TCD_TCP_PORT

public static final int TCD_TCP_PORT
TCP port for arservtcd thread.

See Also:
Constant Field Values

DSO_DEST_PORT

public static final int DSO_DEST_PORT
TCP port that the distributed server uses to communicate with the AR System server.

See Also:
Constant Field Values

INFORMIX_DBN

public static final int INFORMIX_DBN
Informix database server name. This option has a value only if you are using an Informix database.

See Also:
Constant Field Values

INFORMIX_TBC

public static final int INFORMIX_TBC
Informix configuration file. This option has a value only if you are using an Informix database. The default value is onconfig.

See Also:
Constant Field Values

INGRES_VNODE

public static final int INGRES_VNODE
(Obsolete server option.)

See Also:
Constant Field Values

ORACLE_SID

public static final int ORACLE_SID
System ID of the Oracle database you are accessing. This option has a value only if you are using an Oracle database.

See Also:
Constant Field Values

ORACLE_TWO_T

public static final int ORACLE_TWO_T
The two-task environment setting for remote access to an Oracle database. This option has a value only if you are using an Oracle database.

See Also:
Constant Field Values

SYBASE_CHARSET

public static final int SYBASE_CHARSET
Character set being used to access a Sybase database. This option has a value only if you are using a Sybase database.

See Also:
Constant Field Values

SYBASE_SERV

public static final int SYBASE_SERV
Sybase logical server name. This option has a value only if you are using a Sybase database. The default value is SYBASE.

See Also:
Constant Field Values

SHARED_MEM

public static final int SHARED_MEM
(UNIX only) A flag indicating whether the shared memory is disabled or enabled. Valid values for this option are 1 (shared memory enabled) and 0 (shared memory disabled).

See Also:
Constant Field Values

SHARED_CACHE

public static final int SHARED_CACHE
(Obsolete server option.)

See Also:
Constant Field Values

CACHE_SEG_SIZE

public static final int CACHE_SEG_SIZE
(Obsolete server option.)

See Also:
Constant Field Values

DB_USER

public static final int DB_USER
User name the Action Request System uses to access the underlying database.

See Also:
Constant Field Values

NFY_TCP_PORT

public static final int NFY_TCP_PORT
(Obsolete server option.) TCP port that the Notifier server will use.

See Also:
Constant Field Values

FILT_MAX_TOTAL

public static final int FILT_MAX_TOTAL
Maximum number of filters that the server will execute for a given operation. The default value is 10000.

See Also:
Constant Field Values

FILT_MAX_STACK

public static final int FILT_MAX_STACK
Maximum number of levels of recursion allowed for a given operation. The data modification performed by an AR_FILTER_ACTION_FIELDP filter action could trigger a second set, or level, of filters, one of which could trigger filters a third level down and so on. This option limits the number of times such recursion can happen, preventing the server crash that would occur if the recursion continued indefinitely. The default value is 25.

See Also:
Constant Field Values

DEFAULT_ORDER_BY

public static final int DEFAULT_ORDER_BY
Integer (1 or 0) indicating the default order of requests in a form when issuing ARGetListEntry calls, so that the sorting is done on the database and before the results are returned. Valid values for this option are 0 (no sort order) or 1 (use EntryId order). The default value is 1.

See Also:
Constant Field Values

DELAYED_CACHE

public static final int DELAYED_CACHE
Flag indicating whether to disable recaching of the shared cache after a time-out. Possible values are: The default value is 0 (no delay in recache).

See Also:
Constant Field Values

DSO_MERGE_STYLE

public static final int DSO_MERGE_STYLE
Indicates merge style to use when distributed server encounters duplicate entry IDs. Possible values are: The default is 0.

See Also:
Constant Field Values

EMAIL_LINE_LEN

public static final int EMAIL_LINE_LEN
Maximum line length of email messages.

See Also:
Constant Field Values

EMAIL_SYSTEM

public static final int EMAIL_SYSTEM
Character string that indicates the email system on UNIX.

See Also:
Constant Field Values

INFORMIX_RELAY_MOD

public static final int INFORMIX_RELAY_MOD
Character string that indicates the Informix relay module.

See Also:
Constant Field Values

PS_RPC_SOCKET

public static final int PS_RPC_SOCKET
RPC program number and port pairs the Private Servers will use. A value of 0 for the port means no port was specified.

See Also:
Constant Field Values

REGISTER_PORTMAPPER

public static final int REGISTER_PORTMAPPER
Flag indicating whether to register with the portmapper (1) or not (0). The default value is 1.

See Also:
Constant Field Values

SERVER_NAME

public static final int SERVER_NAME
Alias server name that is always interpreted as the current server. The name is not fully qualified. For example, the server alpha.bmc.com would have the value alpha. See also "Server-Name" in ar.conf.

See Also:
Constant Field Values

DBCONF

public static final int DBCONF
Complete contents of the db.conf (ardb.cfg) file.

See Also:
Constant Field Values

APPL_PENDING

public static final int APPL_PENDING
The name of the form that contains the pending list of application commands to be processed. This form is specific to the use of Application-Commands.

See Also:
Constant Field Values

AP_RPC_SOCKET

public static final int AP_RPC_SOCKET
RPC program number the approval server will use when contacting the AR System. This allows you to define a specific AR System server for private use by the approval server. Valid values are 390600, 390621-390634, 390636-390699, and 390680-390694.

See Also:
Constant Field Values

AP_LOG_FILE

public static final int AP_LOG_FILE
Name of the file to use if approval tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

See Also:
Constant Field Values

AP_DEFN_CHECK

public static final int AP_DEFN_CHECK
Length of time in seconds between checks by an application service to verify that definitions it is using from AR System are correct. The value can be from 0 to 3600 seconds (1 hour). A value of 0 means to check definitions with each command. A larger value means a slight delay in recognizing changes to some definition, while a smaller value means the significant overhead of checking the definitions often. The default value is 300 seconds (5 minutes).

See Also:
Constant Field Values

MAX_LOG_FILE_SIZE

public static final int MAX_LOG_FILE_SIZE
Maximum size for system log files. The default value is 0 (no limit).

See Also:
Constant Field Values

CLUSTERED_INDEX

public static final int CLUSTERED_INDEX
Value that indicates whether a clustered index is created on the Entry-Id field when a new form is created. Valid values for this option are 1 (create a clustered index) and 0 (create a unique index). The default value is 1 (clustered), but you can override this in the AR System configuration file.

See Also:
Constant Field Values

ACTLINK_DIR

public static final int ACTLINK_DIR
Name of a directory where all external processes to be run by active links must reside. If the value is NULL active links can run processes located anywhere.

See Also:
Constant Field Values

ACTLINK_SHELL

public static final int ACTLINK_SHELL
Name of a shell to use when running external processes from an active link. If the value is NULL processes are run from /bin/sh (UNIX)or without a shell (Windows).

See Also:
Constant Field Values

USER_CACHE_UTILS

public static final int USER_CACHE_UTILS
Flag indicating whether the ARCACHE and ARRELOAD utilities are enabled. Valid values for this option are 0 (disabled) and 1 (enabled).

See Also:
Constant Field Values

EMAIL_TIMEOUT

public static final int EMAIL_TIMEOUT
Length of time in seconds before the system closes the pipe to sendmail to unblock the AR System server. Valid values for this option are from 1 to 300. The default value is 10.

See Also:
Constant Field Values

EXPORT_VERSION

public static final int EXPORT_VERSION
Integer indicating the server's export version number. This setting allows you to set the export version for object definitions of the server to ensure compatibility with older clients.

See Also:
Constant Field Values

ENCRYPT_AL_SQL

public static final int ENCRYPT_AL_SQL
(Obsolete server option.)

See Also:
Constant Field Values

SCC_ENABLED

public static final int SCC_ENABLED
Value indicating whether a source code control system is being used with AR System. A 0 value (default) means a source code control system is not present.

See Also:
Constant Field Values

SCC_PROVIDER_NAME

public static final int SCC_PROVIDER_NAME
Character string for the source code control system provider name. If none is present, this value is NULL. This string is limited to 255 characters.

See Also:
Constant Field Values

SCC_TARGET_DIR

public static final int SCC_TARGET_DIR
Character string for the source code control system target directory. If none is present, this value is NULL. This string is limited to 255 characters.

See Also:
Constant Field Values

SCC_COMMENT_CHECKIN

public static final int SCC_COMMENT_CHECKIN
Integer (0 or 1) value indicating whether or not a source code control integration requires you to entire a comment at checkin time. A 0 value means no comment is required.

See Also:
Constant Field Values

SCC_COMMENT_CHECKOUT

public static final int SCC_COMMENT_CHECKOUT
Integer (0 or 1) value indicating whether or not a source code control integration requires you to enter a comment at checkout time. A 0 value means no comment is required.

See Also:
Constant Field Values

SCC_INTEGRATION_MODE

public static final int SCC_INTEGRATION_MODE
Integer (0 or 1) value indicating the level of source code control integration. A 0 (the default) value indicates an advisory level of integration, which means you can modify and save an object without having it checked out from the source code control application. A 1 value means enforced integration, which has strict rules for controlling source files (for example, enforced integration means that other administrators will not be able to modify and save changes on an object that you have checked out).

See Also:
Constant Field Values

EA_RPC_SOCKET

public static final int EA_RPC_SOCKET
RPC socket number on which an external authentication server awaits requests for authentication. A 0 value means external authentication will not be used. This attribute persists in the ar.cfg/ar.conf file. The default value is 0.

See Also:
Constant Field Values

EA_RPC_TIMEOUT

public static final int EA_RPC_TIMEOUT
RPC timeout (seconds) used when making calls to the authentication (AREA) server (for example, 30 seconds). This attribute persists in the ar.cfg/ ar.conf file. The default value is 30 seconds.

See Also:
Constant Field Values

USER_INFO_LISTS

public static final int USER_INFO_LISTS
(integer) Number of User/NotifyUser hash lists

See Also:
Constant Field Values

USER_INST_TIMEOUT

public static final int USER_INST_TIMEOUT
(integer) Timeout interval to flush user instances in User Cache hash lists.

See Also:
Constant Field Values

DEBUG_GROUPID

public static final int DEBUG_GROUPID
ID of the group whose members are allowed to retrieve server logging information.

See Also:
Constant Field Values

APPLICATION_AUDIT

public static final int APPLICATION_AUDIT
(character string) Application license audit line.

See Also:
Constant Field Values

EA_SYNC_TIMEOUT

public static final int EA_SYNC_TIMEOUT
Internal (seconds) the AR server uses to periodically invoke the external authentication server's AREANeedToSyncCallback() function, which instructs the AR System server to renew its internally stored user information in the event there are changes made to the source used to authenticate users. A 0 value means that the AR System server will not invoke the call to the external authentication (AREA) server. This attribute persists in the ar.cfg/ ar.conf file. The default value is 300 seconds.

See Also:
Constant Field Values

SERVER_TIME

public static final int SERVER_TIME
AR System server time.

See Also:
Constant Field Values

SVR_SEC_CACHE

public static final int SVR_SEC_CACHE
(integer) Ties security cache to specific server name (0/1).

See Also:
Constant Field Values

LOGFILE_APPEND

public static final int LOGFILE_APPEND
Integer (0/1) value that indicates whether to create a separate *.bak file or to append to the existing log file. A 0 value creates a *.bak file; 1 indicates that new log information be appended to the existing file.

See Also:
Constant Field Values

MINIMUM_API_VER

public static final int MINIMUM_API_VER
Value indicating the minimum API version that the server supports. The API versions are:

See Also:
Constant Field Values

MAX_AUDIT_LOG_FILE_SIZE

public static final int MAX_AUDIT_LOG_FILE_SIZE
Maximum size of audit log file. 0 = no limit. AR_SERVER_MIN_AUDIT_LOG_FILE_SIZE sets the minimum size (100 KB).

See Also:
Constant Field Values

CANCEL_QUERY

public static final int CANCEL_QUERY
Cancels query on Remedy User client. 0 = inactive, 1 = active.

See Also:
Constant Field Values

MULT_ASSIGN_GROUPS

public static final int MULT_ASSIGN_GROUPS
Multiple assign groups for Field 112 (row level access). 0 = not allowed.

See Also:
Constant Field Values

ARFORK_LOG_FILE

public static final int ARFORK_LOG_FILE
Name of fork log file.

See Also:
Constant Field Values

DSO_PLACEHOLDER_MODE

public static final int DSO_PLACEHOLDER_MODE
Placeholder mode for the distributed server. 0 = default normal status, 1 = DSO on hold status.

See Also:
Constant Field Values

DSO_POLLING_INTERVAL

public static final int DSO_POLLING_INTERVAL
How often to poll the distributed server. Set 15-3600 seconds.

See Also:
Constant Field Values

DSO_SOURCE_SERVER

public static final int DSO_SOURCE_SERVER
Source AR System server for the distributed server.

See Also:
Constant Field Values

DS_POOL

public static final int DS_POOL
Name of form holding distributed pools.

See Also:
Constant Field Values

DSO_TIMEOUT_NORMAL

public static final int DSO_TIMEOUT_NORMAL
Number of seconds for the timeout that the distributed server uses when making API calls. The value range is 60-21600 seconds.

See Also:
Constant Field Values

ENC_PUB_KEY

public static final int ENC_PUB_KEY
Server public key.

See Also:
Constant Field Values

ENC_PUB_KEY_EXP

public static final int ENC_PUB_KEY_EXP
Time (seconds) until the server's public/private keys expire.

See Also:
Constant Field Values

ENC_DATA_KEY_EXP

public static final int ENC_DATA_KEY_EXP
Time until the encrypted API session key expires.

See Also:
Constant Field Values

ENC_DATA_ENCR_ALG

public static final int ENC_DATA_ENCR_ALG
API data encryption algorithm.

See Also:
Constant Field Values

ENC_SEC_POLICY

public static final int ENC_SEC_POLICY
Security policy.

See Also:
Constant Field Values

ENC_SESS_H_ENTRIES

public static final int ENC_SESS_H_ENTRIES
Number of API session hash entries.

See Also:
Constant Field Values

DSO_TARGET_CONNECTION

public static final int DSO_TARGET_CONNECTION
String of AR System target server name, RPC, and port number for use with the distributed server.

See Also:
Constant Field Values

PREFERENCE_PRIORITY

public static final int PREFERENCE_PRIORITY
Priority number for preference server.

See Also:
Constant Field Values

ORACLE_QUERY_ON_CLOB

public static final int ORACLE_QUERY_ON_CLOB
Support search on Oracle CLOB field.

See Also:
Constant Field Values

MESSAGE_CAT_SCHEMA

public static final int MESSAGE_CAT_SCHEMA
Name of message catalog form for localized error messages.

See Also:
Constant Field Values

NOTIF_SCHEMA

public static final int NOTIF_SCHEMA
Name of form holding alert events.

See Also:
Constant Field Values

LOCALIZED_SERVER

public static final int LOCALIZED_SERVER
Localized server for localized error messages. 0 = not localized, 1 = localized.

See Also:
Constant Field Values

SVR_EVENT_LIST

public static final int SVR_EVENT_LIST
List of server events of track.

See Also:
Constant Field Values

DISABLE_ADMIN_OPERATIONS

public static final int DISABLE_ADMIN_OPERATIONS
Disables admin operations. 0 = not enabled, 1 = enabled.

See Also:
Constant Field Values

DISABLE_ESCALATIONS

public static final int DISABLE_ESCALATIONS
Disables escalations. 0 = not enabled, 1 = enabled.

See Also:
Constant Field Values

NOTIFICATION_LOG_FILE

public static final int NOTIFICATION_LOG_FILE
File used for notification (alerts) log.

See Also:
Constant Field Values

DISABLE_ALERTS

public static final int DISABLE_ALERTS
Disables alerts. 0 = not enabled, 1 = enabled.

See Also:
Constant Field Values

CHECK_NOTIF_USERS

public static final int CHECK_NOTIF_USERS
Checks alert users. 0 = not enabled, 1 = enabled.

See Also:
Constant Field Values

NOTIF_SEND_TIMEOUT

public static final int NOTIF_SEND_TIMEOUT
Number of seconds to wait before sending timeout.

See Also:
Constant Field Values

NOTIF_OUTBOUND_PORT

public static final int NOTIF_OUTBOUND_PORT
Alert outbound port.

See Also:
Constant Field Values

NOTIF_SOURCE_AR

public static final int NOTIF_SOURCE_AR
AR System source tag.

See Also:
Constant Field Values

NOTIF_SOURCE_FB

public static final int NOTIF_SOURCE_FB
Flashboards source tag.

See Also:
Constant Field Values

DSO_USER_PASSWD

public static final int DSO_USER_PASSWD
User password for the distributed server.

See Also:
Constant Field Values

DSO_TARGET_PASSWD

public static final int DSO_TARGET_PASSWD
Password for the distributed server Target server.

See Also:
Constant Field Values

APP_SERVICE_PASSWD

public static final int APP_SERVICE_PASSWD
AR System Application Service password.

See Also:
Constant Field Values

MID_TIER_PASSWD

public static final int MID_TIER_PASSWD
Mid tier password.

See Also:
Constant Field Values

PLUGIN_LOG_FILE

public static final int PLUGIN_LOG_FILE
Log file name for arplugin.

See Also:
Constant Field Values

SVR_STATS_REC_MODE

public static final int SVR_STATS_REC_MODE
Recording mode for server events statistics. The default is 60 seconds.

See Also:
Constant Field Values

SVR_STATS_REC_INTERVAL

public static final int SVR_STATS_REC_INTERVAL
Recording interval (seconds) of server event statistics .

See Also:
Constant Field Values

DEFAULT_WEB_PATH

public static final int DEFAULT_WEB_PATH
Default path for web access.

See Also:
Constant Field Values

FILTER_API_RPC_TIMEOUT

public static final int FILTER_API_RPC_TIMEOUT
Timeout associated with calls to the filter API. The default is 40 seconds.

See Also:
Constant Field Values

DISABLED_CLIENT

public static final int DISABLED_CLIENT
Disallows certain client types from the server.

See Also:
Constant Field Values

PLUGIN_PASSWD

public static final int PLUGIN_PASSWD
Plug-in server's password.

See Also:
Constant Field Values

PLUGIN_ALIAS

public static final int PLUGIN_ALIAS
List of plug-in aliases.

See Also:
Constant Field Values

PLUGIN_TARGET_PASSWD

public static final int PLUGIN_TARGET_PASSWD
Password used by plug-in server clients.

See Also:
Constant Field Values

INIT_FORM

public static final int INIT_FORM
An "Initial Form" to be loaded on Login that establishes an initial state.

See Also:
Constant Field Values

HOMEPAGE_FORM

public static final int HOMEPAGE_FORM
Homepage form.

See Also:
Constant Field Values

SG_EMAIL_STATE

public static final int SG_EMAIL_STATE
State of server group email process 0 = no server group 1 = suspended 2 = resumed

See Also:
Constant Field Values

SG_FLASHBOARDS_STATE

public static final int SG_FLASHBOARDS_STATE
State of server group flashboards process 0 = no server group 1 = suspended 2 = resumed

See Also:
Constant Field Values
Constructor Detail

ServerInfo

public ServerInfo(int operation,
                  Value value)
Method Detail

getOperation

public int getOperation()
Returns the server operation. Any server operation that is defined as a field summary in this class you can retrieve.


getValue

public Value getValue()
Returns the value of server operation.


clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.