CA API Gateway 9.1

9.4 9.1

SOAP Faults

The gateway provides two different ways to handle SOAP faults: general SOAP fault response and customized SOAP fault response.
gateway83
The
CA API Gateway
 provides two different ways to handle SOAP faults:
general SOAP fault response
 and
customized SOAP fault response
.
General SOAP Fault Response
The default behavior for the Gateway is to return a standard unsigned SOAP fault when an exception occurs in a policy. You can configure the default behavior using the "Fault Level" cluster properties. This default behavior is used unless the SOAP fault response has been customized for a particular policy.
Customized SOAP Fault Response
If you need to override the default SOAP fault behavior in a particular policy, use the Customize SOAP Fault Response assertion. This assertion allows you to customize the following for that policy:
  • The level of detail to include in the response (overrides the
    soapfault.level
     cluster property)
  • Whether SOAP faults should be digitally signed (overrides the
    soapfault.sign
     cluster property)
  • If the faults are to be signed, the signing key is determined in the following order of preference (overrides the
    soapfault.privateKeyAlias
     cluster property):
    1. Custom Private key:
       If a custom private key has been selected for the assertion, then that is used. For more information, see Selecting a Custom Private Key.
    2. Session key:
       If a custom private key has not been selected or if the [
      Use default private key
      ] option was selected on the Private Key Alias dialog, then the Gateway will attempt to use the session key.
    3. Default key:
       If no session key exists and no custom private key was selected, then the default SSL key is used. To learn more about the default SSL key, see Private Key Properties.

Content feedback and comments