Fetching the Default Values for Retry Mechanism
Pre-requisites:
To fetch the default values for retry configuration through the CentraSite Command Line Interface, you must have the CentraSite Administrator role.
CentraSite uses the default values set for the global properties numberOfRetries and retryIntervals for the guaranteed delivery of messages from CentraSite to API Portal. By default, numberOfRetries = 5 and retryIntervals = 10,300,900,1800,3600 seconds. In case of a transient failure, CentraSite tries to resend the undelivered access tokens 5 times at time intervals of 10,300,900,1800 and 3600 seconds respectively.
These default values for resending the undelivered access tokens are stored in the CentraSite's internal database. You can view the default values for retry configuration when required.
CentraSite provides a command tool named get ApiPortalConfig for this purpose. The tool displays the default values set for numberOfRetries and retryIntervals in the console and immediately writes these default values for retry configuration in the XML file identified by the -file parameter.
To fetch the default values for retry configuration
Run the command get ApiPortalConfig. The syntax is of the format: C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd get ApiPortalConfig [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -file <CONFIG-FILE>
The input parameters are:
Parameter | Description |
CENTRASITE-URL | (Optional). The URL of the CentraSite registry. For example, http://localhost:53307/CentraSite/CentraSite. |
USER-ID | The user ID of a registered CentraSite user who has the CentraSite Administrator role. For example, Administrator. |
PASSWORD | The password for the registered CentraSite user identified by the parameter USER-ID. |
CONFIG-FILE | Name of the XML file where you want to write the default values of numberOfRetries and retryIntervals. Note: | If the file is in a different location other than <CentraSiteInstall_Directory>/utilities, provide the absolute file path. |
|
Example (all in one line):
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd get ApiPortalConfig -url http://localhost:53307/CentraSite/CentraSite -user Administrator -password manage -file C:\CentraSite\configuration\test.xml
The response to this command could be:
Executing the command : get ApiPortalConfig
API Portal configuration was successfully written to C:\config.xml file.
API Portal CONFIGURATIONS
-------------------------
com.centrasite.apiportal.config.retry.RetryIntervals : 10,300,900,1800,3600
com.centrasite.apiportal.config.retry.NumberOfRetries : 5
Successfully executed the command : get ApiPortalConfig
