By default, when you create the API instance, the API loads the rsa_api.properties file, which contains the default advanced configuration settings. You also have the option of using a custom properties file, or the system properties of your application.
Note: If you choose to use a custom properties
file, the path to the file must be passed as an argument to the factory
getInstance method in the AuthSessionFactory class.
If the default properties file and a custom properties file are both present, the API loads the properties in the following order—default, custom, and system properties. If the API finds duplicate keys in more than one set of properties, it uses the value defined in the last loaded properties.
For example, if the different sets of properties have the following key-value settings:
- Default properties file: KEY1=VALUE-1A, KEY2=VALUE-2A, KEY3=VALUE-3A
- Custom properties file: KEY2=VALUE-2B, KEY3=VALUE-3B
- System properties: KEY3=VALUE-3C
If the API loads all three sets of properties, the API uses the following key values:
- KEY1=VALUE-1A
- KEY2=VALUE-2B
- KEY3=VALUE-3C
If the custom file is missing, the API uses the following key values:
- KEY1=VALUE-1A
- KEY2=VALUE-2A
- KEY3=VALUE-3C
You can configure advanced settings to do the following:
- Set up event logging for the APIs.
- Set the minimum logging level.
- Set the location for storing the logs (console or log file).
- Set the type of log tracing required (function entries, function exits, or regular statements).
To configure advanced settings:
- Using a text editor, open rsa_api.properties and modify the appropriate
values.
Note: The API accepts only pre-defined keys and ignores any unknown keys. Modify only the values.
- Save rsa_api.properties in the current application directory.
- Run the program.
TopThe following table describes the key-value settings in the properties file.
| IP Override | ||
| Key | Description | Acceptable Values |
RSA_AGENT_HOST |
Indicates the IP address of the agent host in the Authentication Manager database. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
Any valid IP address. Note: Specify a local IP address if the agent host has multiple IP addresses. |
| Refresh Interval | ||
| Key | Description | Acceptable Values |
RSA_CONFIG_READ_INTERVAL |
Indicates the interval of time in seconds that separates each reloading of the configuration file. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
0-86400 (24 hours) The default value is 600 seconds. |
| Server Configuration | ||
| Key | Description | Acceptable Values |
SDCONF_TYPE |
Indicates the data type of the Authentication Manager configuration file, or the sdconf.rec file. Changes made to this file take effect only on initialization/restart. |
The data type is always FILE. |
SDCONF_LOC |
Indicates the path to the Authentication Manager configuration file, or the sdconf.rec file. Changes made to this file take effect only on initialization/restart. |
The applicable path. For example: /var/ace/api/sdconf.rec or C:\\WINDOWS\\system32\\sdconf.rec |
| Server Status | ||
| Key | Description | Acceptable Values |
SDSTATUS_TYPE |
Indicates the data type of the Authentication Manager server status file. Changes made to this file take effect only on initialization/restart. |
The data type is always FILE. |
SDSTATUS_LOC |
Indicates the path to the Authentication Manager server status file. Changes made to this file take effect only on initialization/restart. |
The applicable path. For example: /var/ace/api/JAStatus.1 or C:\\WINDOWS\\system32\\JAStatus.1 |
| Optional Configuration | ||
| Key | Description | Acceptable Values |
SDOPTS_TYPE |
Indicates the data type of the Authentication Manager optional configuration file. Changes made to this file take effect only on initialization/restart. |
The data type is always FILE. |
SDOPTS_LOC |
Indicates the path to the Authentication Manager optional configuration file. Changes made to this file take effect only on initialization/restart.
|
The applicable path. For example: /usr/ace/api/sdopts.rec or C:\\WINDOWS\\system32\\sdopts.rec |
RSA_SERVER_EXCHANGE_INITIAL_TIMEOUT (initial_timeout) |
Enables you to set the initial_ timeout coefficient, which is used to calculate socket time out for ACE time request.
|
The default value is 1000 millliseconds When the number of consecutive requests is zero, the socket timeout(in milliseconds) is calculated as, timeout=initial_timeout |
RSA_SERVER_EXCHANGE_TIMEOUT_OFFSET (offset) |
Enables you to set the offset timeout coefficient, which is used to calculate socket time out for ACE time request.
|
The default value is 200 milliseconds When the number of consecutive requests is greater than zero, the socket timeout(in milliseconds) is caluclated as: timeout= offset+ increment*number_of_consecutive_requests |
RSA_SERVER_EXCHANGE_TIMEOUT_INCREMENT (increment) |
Enables you to set the increment coefficient, which is used to calculate socket time out for ACE time request.
|
The default value is 100 milliseconds When the number of consecutive requests is greater than zero, the socket timeout(in milliseconds) is caluclated as: timeout= offset+ increment*number_of_consecutive_requests |
| Node Secret | ||
| Key | Description | Acceptable Values |
SDNDSCRT_TYPE |
Indicates the data type of the Authentication Manager node secret file. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
The data type is always FILE. |
SDNDSCRT_LOC |
Indicates the path to the Authentication Manager node secret file. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
The applicable path. For example: /var/adm/ace/api/securid or C:\\WINDOWS\\system32\\securid |
| Event Log | ||
| Key | Description | Acceptable Values |
RSA_LOG_TO_CONSOLE |
If set to NO, event logs are not sent. Valid only if RSA_LOG_LEVEL is not set to OFF. Changes made to this parameter take effect based on intervals set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_LOG_TO_FILE |
If set to YES, event logs are sent to the log file specified by RSA_LOG_FILE. If set to No, event logs are not sent. Valid only if RSA_LOG_LEVEL is not set to OFF. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is YES. |
RSA_LOG_FILE |
Indicates the path to the log file. Valid only if RSA_LOG_TO_FILE is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
The applicable path. For example: /var/ace/api/my_api_events.log or C:\\WINDOWS\\system32\\my_api_events.log |
RSA_LOG_LEVEL |
Indicates the minimum log level. Events below this level are not logged. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
OFF, DEBUG, INFO, WARN, ERROR, or FATAL The default value is INFO. |
| Debug Trace | ||
| Key | Description | Acceptable Values |
RSA_ENABLE_DEBUG |
If set to YES, debug tracing is enabled. If set to NO, debug tracing is disabled. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_TO_CONSOLE |
If set to YES, debug traces are sent to the console. If set to NO, debug traces are not sent. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_TO_FILE |
If set to YES, debug traces are sent to the file specified by RSA_DEBUG_FILE. If set to NO, debug traces are not sent. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is YES. |
RSA_ DEBUG_FILE |
Indicates the path to the debug trace file. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
The applicable path. For example: /usr/ace/api/my_api_debug.log or C:\\WINDOWS\\system32\\my_api_debug.log |
RSA_DEBUG_ENTRY |
If set to YES, function entries are traced. If set to NO, function entries are not traced. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_EXIT |
If set to YES, function exits are traced. If set to NO, function exits are not traced. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_FLOW |
If set to YES, flow statements are traced. If set to NO, flow statements are not traced. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_NORMAL |
If set to YES, regular statements are traced. If set to NO, regular statements are not traced. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |
RSA_DEBUG_LOCATION |
If set to YES, class name and line number are displayed in the trace. If set to NO, class name and line number are not displayed in the trace. Valid only if RSA_ENABLE_DEBUG is set to YES. Changes made to this parameter take effect based on the interval set in RSA_CONFIG_READ_INTERVAL |
YES or NO The default value is NO. |