The Open Banking HTTP Servlet Extension provides the endpoints required for an Account Servicing Payment Service Provider (ASPSP) to implement the Open Banking Read/Write APIs as defined by www.openbanking.org.uk.
↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage
The Open Banking HTTP Servlet Extension component inherits from the HTTP Servlet Extension
The following components have a direct aggregation relation from Open Banking HTTP Servlet Extensions:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ consent-definition-id |
| ↓ cross-origin-policy | |
| ↓ response-header | |
| ↓ correlation-id-response-header | |
| ↓ fapi-financial-id | |
| ↓ access-token-validator | |
| ↓ path-prefix | |
| ↓ consent-server |
| Description | A description for this HTTP Servlet Extension |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The cross-origin request policy to use for the HTTP Servlet Extension. A cross-origin policy is a group of attributes defining the level of cross-origin request supported by the HTTP Servlet Extension. |
| Default Value | No cross-origin policy is defined and no CORS headers are recognized or returned. |
| Allowed Values | The DN of any HTTP Servlet Cross Origin Policy. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies HTTP header fields and values added to response headers for all requests. Values specified here must specify both the header field name and the value in conformance with RFC 2616. Fields may only be specified once; multiple values for the same header should be comma-separated. See RFC 7231 for a standard set of field names. Any response headers configured for this HTTP Servlet Extension will be combined with response headers configured on the corresponding Connection Handler. In the case of duplicates, the headers configured on this HTTP Servlet Extension will be used instead of the headers configured on the Connection Handler. |
| Default Value | None |
| Allowed Values | Colon-separated header field name and value |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | HTTP Connection Handlers hosting this HTTP Servlet Extension must be disabled and then re-enabled, or the server restarted, in order for this change to take effect. |
correlation-id-response-header
| Description | Specifies the name of the HTTP header that will contain a correlation ID value. This header will be used both in downstream requests to the Consent API and in responses to the Open Banking client. The value "x-fapi-interaction-id" is recommended. This property can be used to specify a custom response header name for correlation IDs. The value specified here will override the correlation-id-response-header property of the HTTP Connection Handler hosting this Open Banking HTTP Servlet Extension. If the use-correlation-id-header property of the HTTP Connection Handler hosting this Open Banking HTTP Servlet Extension is not enabled, then this property will be ignored. |
| Default Value | The correlation-id-response-header property of the HTTP Connection Handler hosting this Open Banking HTTP Servlet Extension will be used. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The unique financial id of the ASPSP associated with this Open Banking service. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | If specified, the Access Token Validator(s) that may be used to validate access tokens for requests submitted to this Open Banking HTTP Servlet Extension. |
| Default Value | If no validators are specified, then any of the Access Token Validators configured for this server may be used to validate an access token. |
| Allowed Values | The DN of any Access Token Validator. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | An optional ASPSP-specific path prefix to include in the base URI path. If specified with the value "myPrefix", for example, the base path will be /myPrefix/open-banking/v1.1/. |
| Default Value | If no prefix is specified, then the base resource path will start with /open-banking/v1.1. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Open Banking HTTP Servlet Extension must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | Specifies the PingDirectory instance that is hosting the Consent API for storage and retrieval of Account Requests. |
| Default Value | None |
| Allowed Values | The DN of any Consent Service External Server. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
consent-definition-id (Advanced Property)
| Description | The name/id of the consent definition, as defined in the consent-server, that is used for storing Account Requests. |
| Default Value | open-banking-account-request |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Open Banking HTTP Servlet Extension must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
To list the configured HTTP Servlet Extensions:
dsconfig list-http-servlet-extensions
[--property {propertyName}] ...
To view the configuration for an existing HTTP Servlet Extension:
dsconfig get-http-servlet-extension-prop
--extension-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing HTTP Servlet Extension:
dsconfig set-http-servlet-extension-prop
--extension-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...