com.apama.firewall
Event RiskFirewall


The Risk Firewall is designed to allow applications to define a set of rules that any orders being sent to the Risk Firewall must be validated against.

The Risk Firewall will then forward on all approved orders, or reject any orders that failed to meet the rules that have been added.

The Risk Firewall event object allows applications to control and configure a specific instance of the Risk Firewall.

This object provides the ability to send orders through the Risk Firewall and add callbacks to receive approved order management events. It also provides the ability to register Rule Classes with the Risk Firewall that can be used to evaluate whether order management events are allowed or not based on the specific Rule Class implementation.

This event object should not be created directly, the Risk Firewall Factory object should be used to create an instance of it instead. For example:
        
monitor MyMonitor {
context mainContext := context.current();

action onload() {
// Create an instance of the Risk Firewall
com.apama.firewall.RiskFirewall rfw :=
(new com.apama.firewall.RiskFirewallFactory).create( mainContext, "MyFirewall" );

// Unlock the RiskFirewall
rfw.unlock();
}
}
This event object should not be routed or enqueued.
See Also:
com.apama.firewall.RiskFirewallFactory - The Risk Firewall Factory object that is used to constructed Risk Firewall objects

Member summary
 action<> returns stringgetFirewallName

This action returns the name that the Risk Firewall was created with. This name must be unique within the application.
 action<> returns com.apama.utils.ParamsgetParams

This action returns the set of configuration parameters that have been set by the application for the Risk Firewall.
 action<com.apama.utils.Params>setParams

This action sets any configuration parameters that are required for this instance of the Risk Firewall. This replaces any existing parameters that were defined for the Risk Firewall.
 action<> returns booleanisRemote

This action returns a boolean that indicates whether or not this instance of the Risk Firewall event object was a remote connection to a Risk Firewall, rather than the main instance of the Risk Firewall itself.
 action<> returns com.apama.firewall.OrderSendergetOrderSender

This action returns the OrderSender interface that can be used to send new orders into the Risk Firewall, or send amendments and/or cancellations for existing orders to the Risk Firewall.
 action<> returns com.apama.firewall.OrderReceivergetOrderReceiver

This action returns the OrderReceiver interface that can be used to add action callbacks to receive order management events that have been approved by the Risk Firewall.
 action<action<com.apama.firewall.RiskFirewallcom.apama.utils.Error>> returns integeraddErrorCallback

This action allows applications to override the default error handling action used by the Risk Firewall to report any errors that occur from actions called on the interface.
 action<integer>removeErrorCallback

This action allows the application to remove error callback that was added by the addErrorCallback() action using the reference Id provided.
 action<>clearErrorCallbacks

This action allows the application to remove all error callbacks that were added by the addErrorCallback() action.
 action<com.apama.firewall.RiskFirewallcom.apama.utils.Error>defaultErrorCallback

This is the default action that will be called by this instance of the Risk Firewall when an error is encountered.
 action<>delete

This action destroys the Risk Firewall object, and cleans up any data or listeners that have been created by the Risk Firewall.
 action<com.apama.firewall.RuleClass>registerRuleClass

This action registers a Rule Class implementation with the Risk Firewall.
 action<com.apama.firewall.RuleClass, action<com.apama.firewall.RiskFirewall, string>>registerRuleClassCb

This action registers a Rule Class implementation with the Risk Firewall.
 action<string, integer>setRuleClassPriority

This action sets the evaluation order priority for a Rule Class specific Rule Class implementation.
 action<string, com.apama.utils.Params> returns integeraddRuleInstance

This action adds a new instance of the specified Rule Class to the Risk Firewall. The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved.
 action<string, com.apama.utils.Params, action<com.apama.firewall.RiskFirewall, string, integer>> returns integeraddRuleInstanceCb

This action adds a new instance of the specified Rule Class to the Risk Firewall. The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved.
 action<integer, com.apama.utils.Params>modifyRuleInstance

This action modifies an existing instance of a Rule Class in the Risk Firewall. The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.
 action<integer, com.apama.utils.Params, action<com.apama.firewall.RiskFirewall, string, integer>>modifyRuleInstanceCb

This action modifies an existing instance of a Rule Class in the Risk Firewall. The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.
 action<integer>removeRuleInstance

This action removes an existing instance of a Rule Class from the Risk Firewall.
 action<integer, action<com.apama.firewall.RiskFirewall, string, integer>>removeRuleInstanceCb

This action removes an existing instance of a Rule Class from the Risk Firewall.
 action<action<com.apama.firewall.RiskFirewallcom.apama.firewall.QueryRequestcom.apama.firewall.CombinedQueryResponse>> returns integeraddQueryResponseCallback

This action allows applications to add a callback action that will be called by the Risk Firewall for each order management event passed to it for evaluation.
 action<integer>removeQueryResponseCallback

This action allows applications to remove a query response callback action that was previously added to the Risk Firewall.
 action<>clearQueryResponseCallbacks

This action allows applications to remove all of the query response callback actions that were previously added to the Risk Firewall.
 action<string, action<com.apama.firewall.RiskFirewallcom.apama.firewall.RuleClassInfo>>getRuleClassInfo

This action gets information about a specific RuleClass implementation that was registered with the Risk Firewall.
 action<action<com.apama.firewall.RiskFirewall, dictionary<string, com.apama.firewall.RuleClassInfo>>>getAllRuleClassInfo

This action gets information about all RuleClass implementations that are currently registered with the Risk Firewall.
 action<integer, action<com.apama.firewall.RiskFirewallcom.apama.firewall.RuleInstanceInfo>>getRuleInstanceInfo

This action gets information about a specific RuleClass instance that was previously added to the Risk Firewall.
 action<string, action<com.apama.firewall.RiskFirewallcom.apama.firewall.AllRuleInstanceInfo>>getAllRuleInstanceInfo

This action gets information about all instances of a specific Rule Class that were previously added to the Risk Firewall.
 action<action<com.apama.firewall.RiskFirewallcom.apama.firewall.AllRuleClassInstanceInfo>>getAllRuleClassInstanceInfo

This action gets information about all instances of all Rule Classes that were previously added to the Risk Firewall.
 action<>lock

This action locks the Risk Firewall, which prevents any further order management events from being processed by the Risk Firewall.
 action<>unlock

This action unlocks the Risk Firewall, which will allow any order management events to be processed by the Risk Firewall.
 action<action<com.apama.firewall.RiskFirewall>>unlockCb

This action unlocks the Risk Firewall, which will allow any order management events to be processed by the Risk Firewall.
 action<> returns booleanisLocked

This action returns the state of the lock in the Risk Firewall. If the Risk Firewall is locked, it will prevent any order management events from being processed by the Risk Firewall until it is unlocked.
 action<action<com.apama.firewall.RiskFirewall, boolean>> returns integeraddLockStateChangedCallback

This action allows applications to add a callback action that will be called by the Risk Firewall whenever the state of the lock changes.
 action<integer>removeLockStateChangedCallback

This action allows applications to remove a specific Risk Firewall lock state change callback action that was previously added to the Risk Firewall.
 action<>clearLockStateChangedCallbacks

This action allows applications to remove all of the Risk Firewall lock state change callback actions that were previously added to the Risk Firewall.
 action<string>overrideSoftReject

This action allows a manual intervention when running in Soft-Rejection Mode to force a rejected New/Amend/Cancel Order to bypass the Rules and be submitted to the Order Recievers.
 action<string, integer>clearObjection

This action allows for manual removal of an objection from the Order Operation Cache and Dataview.
 
Member detail

addErrorCallback

            action<action<com.apama.firewall.RiskFirewallcom.apama.utils.Error>> returns integer addErrorCallback
        
This action allows applications to override the default error handling action used by the Risk Firewall to report any errors that occur from actions called on the interface.

For example, errors from creating the Risk Firewall, registering Rule Classes, adding Rule Class instances, sending invalid orders, etc.

Parameters:
cbOnError - The application defined error callback action.
Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.ErrorConstants - The set of constants that define the errors generated by the Risk Firewall.
com.apama.firewall.RiskFirewall#removeErrorCallback - This action removes a specific instance of an error callbacks that was registered with the Risk Firewall.
com.apama.firewall.RiskFirewall#clearErrorCallbacks - This action clears all the error callbacks that were registered with the Risk Firewall.

addLockStateChangedCallback

            action<action<com.apama.firewall.RiskFirewall, boolean>> returns integer addLockStateChangedCallback
        
This action allows applications to add a callback action that will be called by the Risk Firewall whenever the state of the lock changes.

This can be used, for example, to notify trading algorithms to stop generating orders.

Parameters:
cbOnLockStateChanged - The application defined callback action that will be called whenever the state of the Risk Firewall lock changes


Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.RiskFirewall#removeLockStateChangedCallback - This action removes a specific lock state change callback that was added to the Risk Firewall.
com.apama.firewall.RiskFirewall#clearLockStateChangedCallbacks - This action clears all the lock state change callbacks that were added to the Risk Firewall.

addQueryResponseCallback

            action<action<com.apama.firewall.RiskFirewallcom.apama.firewall.QueryRequestcom.apama.firewall.CombinedQueryResponse>> returns integer addQueryResponseCallback
        
This action allows applications to add a callback action that will be called by the Risk Firewall for each order management event passed to it for evaluation.

It will provide a report of the results of the query evaluation, as well as the original query request itself.

This can be used, for example, to publish dataviews showing the number of warning or failures that have been issued by the Risk Firewall.

Parameters:
cbOnQueryResponse - The application defined callback action that will be called for each query processed by the Risk Firewall
Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.RiskFirewall#removeQueryResponseCallback - This action removes a specific query response callback that was added to the Risk Firewall.
com.apama.firewall.RiskFirewall#clearQueryResponseCallbacks - This action clears all the query response callbacks that were added to the Risk Firewall.

addRuleInstance

            action<string, com.apama.utils.Params> returns integer addRuleInstance
        
This action adds a new instance of the specified Rule Class to the Risk Firewall. The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved.

The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.

This action is similar to the addRuleInstanceCb action but this action does not require the application defined callback that will be called on successful addition of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
ruleClassName - The name of the RuleClass implementation to add an instance to.
config - The configuration to use for this RuleClass instance.
Returns:
A reference Id that can be used to remove the Rule Class instance at a later date.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#addRuleInstanceCb - This action operates in the same way as this action but with the addition of an application defined callback action that will be called when the instance has been successfully added to the Rule Class.

addRuleInstanceCb

            action<string, com.apama.utils.Params, action<com.apama.firewall.RiskFirewall, string, integer>> returns integer addRuleInstanceCb
        
This action adds a new instance of the specified Rule Class to the Risk Firewall. The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved.

The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.

This action is similar to the addRuleInstance action but this action allows the application to provide a callback that will be called on successful addition of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
ruleClassName - The name of the RuleClass implementation to add an instance to.
config - The configuration to use for this RuleClass instance.
cbCompleted - The application defined callback that will be called when the Rule Class instance has been successfully added.
Returns:
A reference Id that can be used to remove the Rule Class instance at a later date.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#addRuleInstance - This action operates in the same way as this action but without requiring the additional application defined callback action that will be called when the instance has been successfully added to the Rule Class.

clearErrorCallbacks

            action<> clearErrorCallbacks
        
This action allows the application to remove all error callbacks that were added by the addErrorCallback() action.
See Also:
com.apama.firewall.RiskFirewall#addErrorCallback - This action adds an error callback to the set of callbacks that will be called when an error occurs
com.apama.firewall.RiskFirewall#removeErrorCallback - This action removes an existing error callback using the reference identifier provided

clearLockStateChangedCallbacks

            action<> clearLockStateChangedCallbacks
        
This action allows applications to remove all of the Risk Firewall lock state change callback actions that were previously added to the Risk Firewall.
See Also:
com.apama.firewall.RiskFirewall#addLockStateChangedCallback - This action adds an application defined callback action that will be called whenever the state of the Risk Firewall lock changes.
com.apama.firewall.RiskFirewall#removeLockStateChangedCallback - This action removes a specific lock state change callback that was added to the Risk Firewall.

clearObjection

            action<string, integer> clearObjection
        
This action allows for manual removal of an objection from the Order Operation Cache and Dataview.

It can be used to remove the objection due to a User action, or to implement your own clearing policy for the Order Operation Cache if the Auto Purging is disabled.

clearQueryResponseCallbacks

            action<> clearQueryResponseCallbacks
        
This action allows applications to remove all of the query response callback actions that were previously added to the Risk Firewall.
See Also:
com.apama.firewall.RiskFirewall#addQueryResponseCallback - This action adds an application defined callback action that will be called for each query that was processed by the Risk Firewall.
com.apama.firewall.RiskFirewall#removeQueryResponseCallback - This action removes a specific query response callback that was added to the Risk Firewall.

defaultErrorCallback

            action<com.apama.firewall.RiskFirewallcom.apama.utils.ErrordefaultErrorCallback
        
This is the default action that will be called by this instance of the Risk Firewall when an error is encountered.

Parameters:
iface - The RiskFirewall.
error - An error event.
See Also:
com.apama.firewall.ErrorConstants - The set of constants that define the errors generated by the Risk Firewall.

delete

            action<> delete
        
This action destroys the Risk Firewall object, and cleans up any data or listeners that have been created by the Risk Firewall.

After calling this action the Risk Firewall object cannot be re-used, a new instance must be created using the Risk Firewall Factory object instead.

getAllRuleClassInfo

            action<action<com.apama.firewall.RiskFirewall, dictionary<string, com.apama.firewall.RuleClassInfo>>> getAllRuleClassInfo
        
This action gets information about all RuleClass implementations that are currently registered with the Risk Firewall.

This information includes the name of the Rule Class, its current evaluation priority, the configuration schema it provides, and any current state information that has.

As this operation may be asynchronous, a callback must be provided which will be called when the operation has been successfully completed.

The contents of the schema and state information that each Rule Class provides are dependent on the Rule Class implementation itself.

Parameters:
cbCompleted - The application defined callback that will be called when all the registered Rule Class information has been successfully gathered.
See Also:
com.apama.firewall.RiskFirewall#getRuleClassInfo - This action gets information about a specific registered Rule Class implementation.
com.apama.firewall.RuleClassInfo - This event object defines the information about a Rule Class implementation.

getAllRuleClassInstanceInfo

            action<action<com.apama.firewall.RiskFirewallcom.apama.firewall.AllRuleClassInstanceInfo>> getAllRuleClassInstanceInfo
        
This action gets information about all instances of all Rule Classes that were previously added to the Risk Firewall.

This information includes the instance identifier, the name of the Rule Class it is associated with, its current configuration, and any current state information that has.

As this operation may be asynchronous, a callback must be provided which will be called when the operation has been successfully completed.

The configuration and state information that each Rule Class provides are dependent on the Rule Class implementation itself.

Parameters:
cbCompleted - The application defined callback that will be called when all Rule Class instance information has been successfully gathered.
See Also:
com.apama.firewall.RiskFirewall#getAllRuleInstanceInfo - This action gets information about all of the Rule Class instances that have been added.
com.apama.firewall.AllRuleClassInstanceInfo - This event object defines the information about all Rule Class instances.

getAllRuleInstanceInfo

            action<string, action<com.apama.firewall.RiskFirewallcom.apama.firewall.AllRuleInstanceInfo>> getAllRuleInstanceInfo
        
This action gets information about all instances of a specific Rule Class that were previously added to the Risk Firewall.

This information includes the instance identifier, the name of the Rule Class it is associated with, its current configuration, and any current state information that has.

As this operation may be asynchronous, a callback must be provided which will be called when the operation has been successfully completed.

The configuration and state information that each Rule Class provides are dependent on the Rule Class implementation itself.

Parameters:
ruleClassName - The name of the RuleClass implementation to get instance information from.
cbCompleted - The application defined callback that will be called when the Rule Class instance information has been successfully gathered.
See Also:
com.apama.firewall.RiskFirewall#getRuleInstanceInfo - This action gets information about a specific Rule Class instances that has been added.
com.apama.firewall.AllRuleInstanceInfo - This event object defines the information about a specific set of Rule Class instances.

getFirewallName

            action<> returns string getFirewallName
        
This action returns the name that the Risk Firewall was created with. This name must be unique within the application.

Returns:
The name of this Risk Firewall which is unique within the application.

getOrderReceiver

            action<> returns com.apama.firewall.OrderReceiver getOrderReceiver
        
This action returns the OrderReceiver interface that can be used to add action callbacks to receive order management events that have been approved by the Risk Firewall.

Returns:
An instance of the OrderReceiver interface object that can be used to add callbacks to receive order management events that have been approved by the Risk Firewall.
See Also:
com.apama.firewall.OrderSender - This event object is used to send order management events into the Risk Firewall for evaluation.
com.apama.firewall.OrderReceiver - This event object is used to receive approved order management events from the Risk Firewall.

getOrderSender

            action<> returns com.apama.firewall.OrderSender getOrderSender
        
This action returns the OrderSender interface that can be used to send new orders into the Risk Firewall, or send amendments and/or cancellations for existing orders to the Risk Firewall.

Returns:
An instance of the OrderSender interface object that can be used to send order management events into the Risk Firewall for evaluation.
See Also:
com.apama.firewall.OrderSender - This event object is used to send order management events into the Risk Firewall for evaluation.
com.apama.firewall.OrderReceiver - This event object is used to receive approved order management events from the Risk Firewall.

getParams

            action<> returns com.apama.utils.Params getParams
        
This action returns the set of configuration parameters that have been set by the application for the Risk Firewall.

The com.apama.firewall.Consts event object defines a set of constants for the various configuration parameters, that the Risk Firewall supports, and their default values.

Returns:
The set of configuration parameters that have been set by the application for the Risk Firewall.
See Also:
com.apama.firewall.Consts - This event object contains a set of constants that define the various configuration parameters that the Risk Firewall supports.
com.apama.firewall.RiskFirewall#setParams - This action is used to set any configuration parameters that are required by the Risk Firewall.

getRuleClassInfo

            action<string, action<com.apama.firewall.RiskFirewallcom.apama.firewall.RuleClassInfo>> getRuleClassInfo
        
This action gets information about a specific RuleClass implementation that was registered with the Risk Firewall.

This information includes the name of the Rule Class, its current evaluation priority, the configuration schema it provides, and any current state information that has.

As this operation may be asynchronous, a callback must be provided which will be called when the operation has been successfully completed.

The contents of the schema and state information that each Rule Class provides are dependent on the Rule Class implementation itself.

Parameters:
ruleClassName - The name of the RuleClass implementation to get information from.
cbCompleted - The application defined callback that will be called when the Rule Class information has been successfully gathered.
See Also:
com.apama.firewall.RiskFirewall#getAllRuleClassInfo - This action gets information about all of the registered Rule Class implementations.
com.apama.firewall.RuleClassInfo - This event object defines the information about a Rule Class implementation.

getRuleInstanceInfo

            action<integer, action<com.apama.firewall.RiskFirewallcom.apama.firewall.RuleInstanceInfo>> getRuleInstanceInfo
        
This action gets information about a specific RuleClass instance that was previously added to the Risk Firewall.

This information includes the instance identifier, the name of the Rule Class it is associated with, its current configuration, and any current state information that has.

As this operation may be asynchronous, a callback must be provided which will be called when the operation has been successfully completed.

The configuration and state information that each Rule Class provides are dependent on the Rule Class implementation itself.

Parameters:
instanceId - The unique identifier of the RuleClass instance to get information for.
cbCompleted - The application defined callback that will be called when the Rule Class instance information has been successfully gathered.
See Also:
com.apama.firewall.RiskFirewall#getAllRuleInstanceInfo - This action gets information about all of the Rule Class instances that have been added.
com.apama.firewall.RuleInstanceInfo - This event object defines the information about a specific Rule Class instance.

isLocked

            action<> returns boolean isLocked
        
This action returns the state of the lock in the Risk Firewall. If the Risk Firewall is locked, it will prevent any order management events from being processed by the Risk Firewall until it is unlocked.
See Also:
com.apama.firewall.RiskFirewall#lock - This action locks the Risk Firewall and prevents any orders from being approved.
com.apama.firewall.RiskFirewall#unlock - This action unlocks a Risk Firewall that was previously locked.
com.apama.firewall.RiskFirewall#isLocked - This action returns the current state of the Risk Firewall lock.

isRemote

            action<> returns boolean isRemote
        
This action returns a boolean that indicates whether or not this instance of the Risk Firewall event object was a remote connection to a Risk Firewall, rather than the main instance of the Risk Firewall itself.

Returns:
True if this instance of the Risk Firewall was a remotely connected interface, False if it was the main Risk Firewall instance.
See Also:
com.apama.firewall.RiskFirewallFactory#connect() - This action is used to remotely connect to and existing Risk Firewall from another EPL monitor, context or scope.

lock

            action<> lock
        
This action locks the Risk Firewall, which prevents any further order management events from being processed by the Risk Firewall.

Any requests that are made while the Risk Firewall is locked, will be immediately rejected. Order management events will not be pended until the Risk Firewall is unlocked.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.
See Also:
com.apama.firewall.RiskFirewall#unlock - This action unlocks a Risk Firewall that was previously locked.
com.apama.firewall.RiskFirewall#isLocked - This action returns the current state of the Risk Firewall lock.

modifyRuleInstance

            action<integer, com.apama.utils.ParamsmodifyRuleInstance
        
This action modifies an existing instance of a Rule Class in the Risk Firewall. The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.

This action is similar to the modifyRuleInstanceCb action but this action does not require the application defined callback that will be called on successful modification of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
instanceId - The identifier of the RuleClass instance to be modified.
config - The configuration to modify the RuleClass instance to use.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#modifyRuleInstanceCb - This action operates in the same way as this action but with the addition of an application defined callback action that will be called when the Rule Class has been has successfully modified the Rule Class instance.

modifyRuleInstanceCb

            action<integer, com.apama.utils.Params, action<com.apama.firewall.RiskFirewall, string, integer>> modifyRuleInstanceCb
        
This action modifies an existing instance of a Rule Class in the Risk Firewall. The configuration parameters allowed in this action are dependent on the Rule Class implementation itself.

This action is similar to the modifyRuleInstance action but this action allows the application to provide a callback that will be called on successful modification of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
instanceId - The identifier of the RuleClass instance to be modified.
config - The configuration to modify the RuleClass instance to use.
cbCompleted - The application defined callback that will be called when the Rule Class instance has been successfully modified.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#modifyRuleInstance - This action operates in the same way as this action but without requiring the additional application defined callback action that will be called when the Rule Class has successfully modified the Rule Class instance.

overrideSoftReject

            action<string> overrideSoftReject
        
This action allows a manual intervention when running in Soft-Rejection Mode to force a rejected New/Amend/Cancel Order to bypass the Rules and be submitted to the Order Recievers.

Soft-Rejected orders will only be pended for the period of time specified by the CONFIG_SOFT_REJECT_DURATION config (default 60 seconds). An error will be reported if there is no current pending order matching the provided order Id.
See Also:
com.apama.firewall.Consts#CONFIG_REJECTION_MODE - This constant value is used to define what Rejection Mode the Risk Firewall will run in.
com.apama.firewall.Consts#CONFIG_REJECTION_MODE_SOFT - This constant value is used to configure the Risk Firewall to run in Soft-Rejection Mode.
com.apama.firewall.Consts#CONFIG_SOFT_REJECT_DURATION - This constant value is used to define the duration rejected orders will be pended for.

registerRuleClass

            action<com.apama.firewall.RuleClassregisterRuleClass
        
This action registers a Rule Class implementation with the Risk Firewall.

The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved. This action is similar to the registerRuleClassCb action but this action does not require the application defined callback that will be called on successful registration of the Rule Class.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
ruleClass - The RuleClass implementation to register
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#registerRuleClassCb - This action operates in the same way as this action but with the addition of an application defined callback action that will be called when the Rule Class has been successfully registered with the Risk Firewall.

registerRuleClassCb

            action<com.apama.firewall.RuleClass, action<com.apama.firewall.RiskFirewall, string>> registerRuleClassCb
        
This action registers a Rule Class implementation with the Risk Firewall.

The Rule Class implementation can then be used to evaluate orders placed against the Risk Firewall to check whether or not they should be approved. This action is similar to the registerRuleClass action but also allows an application defined callback that will be called on successful registration of the Rule Class.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
ruleClass - The RuleClass implementation to register
cbCompleted - The application defined callback that will be called when the Rule Class has been successfully registered.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#registerRuleClass - This action operates in the same way as this action but without the addition of an application defined callback action that will be called when the Rule Class has been successfully registered with the Risk Firewall.

removeErrorCallback

            action<integer> removeErrorCallback
        
This action allows the application to remove error callback that was added by the addErrorCallback() action using the reference Id provided.

Parameters:
refId - The reference ID as returned from the call to the addErrorCallback() action.
See Also:
com.apama.firewall.RiskFirewall#addErrorCallback - This action adds an error callback to the set of callbacks that will be called when an error occurs
com.apama.firewall.RiskFirewall#clearErrorCallbacks - This action clears all the error callbacks that were registered with the Risk Firewall

removeLockStateChangedCallback

            action<integer> removeLockStateChangedCallback
        
This action allows applications to remove a specific Risk Firewall lock state change callback action that was previously added to the Risk Firewall.

Parameters:
refId - The identifier of the lock state change callback that should be removed.
See Also:
com.apama.firewall.RiskFirewall#addLockStateChangedCallback - This action adds an application defined callback action that will be called whenever the state of the Risk Firewall lock changes.
com.apama.firewall.RiskFirewall#clearLockStateChangedCallbacks - This action clears all the lock state change callbacks that were added to the Risk Firewall.

removeQueryResponseCallback

            action<integer> removeQueryResponseCallback
        
This action allows applications to remove a query response callback action that was previously added to the Risk Firewall.

Parameters:
refId - The identifier of the query response callback that should be removed.
See Also:
com.apama.firewall.RiskFirewall#addQueryResponseCallback - This action adds an application defined callback action that will be called for each query that was processed by the Risk Firewall.
com.apama.firewall.RiskFirewall#clearQueryResponseCallbacks - This action clears all the query response callbacks that were added to the Risk Firewall.

removeRuleInstance

            action<integer> removeRuleInstance
        
This action removes an existing instance of a Rule Class from the Risk Firewall.

This action is similar to the removeRuleInstanceCb action but this action does not require the application defined callback that will be called on successful removal of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
instanceId - The identifier of the RuleClass instance to be modified.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#removeRuleInstanceCb - This action operates in the same way as this action but with the addition of an application defined callback action that will be called when the Rule Class has successfully removed the Rule Class instance.

removeRuleInstanceCb

            action<integer, action<com.apama.firewall.RiskFirewall, string, integer>> removeRuleInstanceCb
        
This action removes an existing instance of a Rule Class from the Risk Firewall.

This action is similar to the removeRuleInstance action but this action allows the application to provide a callback that will be called on successful removal of the Rule Class instance.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
instanceId - The identifier of the RuleClass instance to be modified.
cbCompleted - The application defined callback that will be called when the Rule Class instance has been successfully removed.
See Also:
com.apama.firewall.RuleClass - This event object defines the interface used by the Risk Firewall to communicate with the RuleClass implementation.
com.apama.firewall.RiskFirewall#removeRuleInstance - This action operates in the same way as this action but without requiring the additional application defined callback action that will be called when the Rule Class has successfully removed the Rule Class instance.

setParams

            action<com.apama.utils.ParamssetParams
        
This action sets any configuration parameters that are required for this instance of the Risk Firewall. This replaces any existing parameters that were defined for the Risk Firewall.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.

Parameters:
config - The configuration parameters object to use for the Risk Firewall.
See Also:
com.apama.firewall.RiskFirewall#getParams - This action is used to get any configuration parameters that were set on the Risk Firewall.

setRuleClassPriority

            action<string, integer> setRuleClassPriority
        
This action sets the evaluation order priority for a Rule Class specific Rule Class implementation.

This allows applications to define the order in which Rule Classes are used by the Risk Firewall to evaluate orders. For example, this can be useful if you want to perform a basic set of sanity checks on an order before trying to evaluate a much more computationally expensive operation, such as breaching a specific currency limit.

A set of constants are defined in the com.apama.firewall.Consts event object to provide a basic set of values for high/medium/low. However, the actual value specified can be an arbitrary integer value, 0 being the highest priority, MAX_INT being the lowest. Any integer values inbetween can be used.

The Rule Class must have been registered prior to calling this action, otherwise an error will occur.

Parameters:
ruleClassName - The name of the RuleClass implementation whose priority is being modified.
priority - The evaluation priority level to use for this Rule Class.
See Also:
com.apama.firewall.Consts#RULE_CLASS_PRIORITY_HIGH - This constant value is used to define that the Rule Class should be a high priority.
com.apama.firewall.Consts#RULE_CLASS_PRIORITY_MEDIUM - This constant value is used to define that the Rule Class should be a medium priority.
com.apama.firewall.Consts#RULE_CLASS_PRIORITY_LOW - This constant value is used to define that the Rule Class should be a low priority.

unlock

            action<> unlock
        
This action unlocks the Risk Firewall, which will allow any order management events to be processed by the Risk Firewall.

Unlike the lock() action, any outstanding requests to register Rule Classes, or add Rule Class instances will be processed before the Risk Firewall is unlocked.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.
See Also:
com.apama.firewall.RiskFirewall#lock - This action locks the Risk Firewall and prevents any orders from being approved.
com.apama.firewall.RiskFirewall#unlockCb - This action unlocks a Risk Firewall that was previously locked, and calls an application defined callback when it has been successfully unlocked.
com.apama.firewall.RiskFirewall#isLocked - This action returns the current state of the Risk Firewall lock.

unlockCb

            action<action<com.apama.firewall.RiskFirewall>> unlockCb
        
This action unlocks the Risk Firewall, which will allow any order management events to be processed by the Risk Firewall.

Unlike the lock() action, any outstanding requests to register Rule Classes, or add Rule Class instances will be processed before the Risk Firewall is unlocked.

This action is similar to the unlock() action but with the addition of an application defined callback action that will be called when the Risk Firewall has been successfully unlocked.

This action cannot be called from a remotely connected Risk Firewall interface, otherwise an error will be generated.
See Also:
com.apama.firewall.RiskFirewall#lock - This action locks the Risk Firewall and prevents any orders from being approved.
com.apama.firewall.RiskFirewall#unlock - This action unlocks a Risk Firewall that was previously locked, without requiring the application to define a callback action to be called when the Risk Firewall was successfully unlocked.
com.apama.firewall.RiskFirewall#isLocked - This action returns the current state of the Risk Firewall lock.