Response Generator Properties

Response Generator Configuration Properties describes the properties for configuring the SBA Gateway Response Generator.

Table 1. Response Generator Configuration Properties
Property Description
responseGenerator.handlers.<handler_name>.requestMessageType The message type this handler expects to receive. Because this value is related to the name of the OpenAPI object definition, valid values are ChargingDataRequest or SpendingLimitContext.
responseGenerator.handlers.<handler_name>.responseMessageType Themessage type this handler creates. Because this value is related to the name of the OpenAPI object definition, valid values are ChargingDataResponse or SpendingLimitStatus.
responseGenerator.handlers.<handler_name>.responseMappingFileName The mapping configuration file used to create the response message from the request. A default file is provided for each message type in /opt/mtx/conf/mapping/spec_version: Backstop-ChargingDataResponse-mapping.yaml and Backstop-SpendingLimitResponse-mapping.yaml.
responseGenerator.handlers.<handler_name>.validate (Optional) When set to true (the default), the incoming message is validated.

When using this with a downstream system, sometimes validation is already performed, and validation at this stage can be disabled.
responseGenerator.handlers.<handler_name>.endpoints A list of associated endpoint names related to the handler, similar to the following:
endpoints:
 - chargingDataCreate
 - chargingDataUpdate
 - chargingDataDelete
responseGenerator.handlers.<handler_name>.fields.<field_name>.path The path at which the field value is read, in the format as used by the dynamic message mapper field mappings.
Important: This path must represent a single value in the message. It must not be part of a repeating structure where more than one value might be extracted.
responseGenerator.handlers.<handler_name>.fields.<field_name>.type The data type to map to, such as integer. By default, all values are mapped to strings. Both fully qualified java types and aliases are supported.
responseGenerator.handlers.<handler_name>.fields.<field_name>.mapperName The name of a preconfigured FieldValueMapper.
Note: The mapperName and mapperClass properties are mutually exclusive.
responseGenerator.handlers.<handler_name>.fields.<field_name>.mapperClass The fully qualified class name of a FieldValueMapper.
Note: The mapperName and mapperClass properties are mutually exclusive.
responseGenerator.handlers.<handler_name>.fields.<field_name>.mapperParameters Parameters used when initializing the mapperClass. These typically represent setters on this class of type string. The exception to this is for the map and regex map.
Note: Only specify the mapperParamters property when the mapperClass property is set.
responseGenerator.handlers.<handler_name>.ruleSets[n].pathRegex (Optional) If this property is specified, the path in the message request is checked to see whether it matches the regular expression.
responseGenerator.handlers.<handler_name>.ruleSets[n].headerRegex (Optional) If this property is specified, the header in the message request is checked to see whether it matches the regular expression.
responseGenerator.handlers.<handler_name>.ruleSets[n].rules The rules to be compared with the message request. All specified rules must match for a rule set to be considered a match.
responseGenerator.handlers.<handler_name>.ruleSets[n].pathRegex (Optional) If this property is specified, the path in the message request is checked to see whether it matches the regular expression.
responseGenerator.handlers.<handler_name>.ruleSets[n].headerRegex (Optional) If this property is specified, the header in the message request is checked to see whether it matches the regular expression.
responseGenerator.handlers.<handler_name>.ruleSets[n].rules The rules to be compared with the message request. All specified rules must match for a rule set to be considered a match.
responseGenerator.handlers.<handler_name>.ruleSets[x].rules[y].jsonPath The JSON path to check.
responseGenerator.handlers.<handler_name>.ruleSets[x].rules[y].operation The operation used to compare the field value with the configured value(s).
responseGenerator.handlers.<handler_name>.ruleSets[x].rules[y].value The value to compare the field value to for this rule. This property and the responseGenerator.handlers.handlerName.ruleSets[x].rules[y].values property are mutually exclusive.
responseGenerator.handlers.<handler_name>.ruleSets[x].rules[y].values The values to compare the field value to for this rule. This property and the responseGenerator.handlers.handlerName.ruleSets[x].rules[y].value property are mutually exclusive.
responseGenerator.handlers.<handler_name>.profiles.<profileName>.structures[n].jsonPath A JSON path that describes where to attach the structure.
responseGenerator.handlers.<handler_name>.profiles.<profileName>.structures[n].structureName The name of the structure to apply at the given path. This structure is merged and overwrites any existing fields with the same names.
responseGenerator.structures.<structureName> An object merged into the response object at a defined position.

For more information, see the discussion about Response Generator.