skip to main content
Corticon Server: Integration & Deployment Guide : Invoking Corticon Server : Administrative APIs
 

Try Corticon Now

Administrative APIs

In addition to the execute() method (and its variations), a set of administrative APIs allows client control over most Corticon Server functions. These methods are described in more detail in the JavaDoc, CcServerAdminInterface class, including:
*Adds (deploying) a specific Decision Service onto Corticon Server (addDecisionService) without using a .cdd file. Available in 3, 6, and 9 parameter versions.
*Removes all Decision Services which were loaded (deployed) via the addDecisionService method (clearAllNonCddDecisionServices). Does not affect Decision Services deployed via a .cdd file.
*Queries Corticon Server for admin information such as version number, deployed Decision, and Service settings. (getCcServerInfo).
*Queries Corticon Server for a list of loaded (deployed) Decision Service Names (getDecisionServiceNames)
*Initializes Corticon Server, causing it to start up and restore state from ServerState.xml (initialize)
*Queries Corticon Server to see if a Decision Service Name (or specific version or effective date) is deployed (isDecisionServiceDeployed)
*Instructs Corticon Server to load all Decision Services in a specific .cdd file (loadFromCdd)
*Instructs Corticon Server to load all Decision Services from all .cdd files located in a specific directory (loadFromCddDir)
*Changes the auto-reload setting for a Decision Service (or specific version) (modifyDecisionServiceAutoReload). Does not affect Decision Services deployed via a .cdd file.
*Changes the message structure type setting (FLAT or HIER) for a Decision Service (or specific version) (modifyDecisionServiceMessageStructType). Does not affect Decision Services deployed via a .cdd file.
*Changes the min and/or max pool settings for a Decision Service (or specific version) (modifyDecisionServicePoolSizes). Does not affect Decision Services deployed via a .cdd file.
*Changes the path of a deployed Decision Service (Ruleflow) (modifyDecisionServiceRuleflowPath). Does not affect Decision Services deployed via a .cdd file.
*Instructs Corticon Server to dump and reload (refresh) a specific Decision Service (or version) (reloadDecisionService).
*Removes (undeploying) a Decision Service (or specific version) (removeDecisionService). Does not affect Decision Services deployed via a .cdd file.
*Starts Corticon Server's Dynamic Update monitoring service (startDynamicUpdateMonitoringService). This is the same update service that can be set statically in your brms.properties file.
*Stops Corticon Server's Dynamic Update monitoring service (stopDynamicUpdateMonitoringService). This is the same update service that can be set statically in your brms.properties file.
Important: A Decision Service deployed using a .cdd file may only have its deployment setting changed by modifying the .cdd file. A Decision Service deployed using APIs may only have its deployment settings modified by APIs.
All APIs are available as both Java methods (described fully in the JavaDoc) and as operations in a SOAP request message. Corticon provides a WSDL containing full descriptions of each of these methods so they may be called through a SOAP client.
When deployed as a Servlet, Corticon Server automatically publishes an Administration Console, typically on port 8850 for HTTP, and on port 8851 for HTTPS, which among other things, exposes a set of WSDLs. See Inside Corticon Server for more information.