| Note |
|---|
This feature will be available with V3.4 of the software. |
...
Two options for request creation exist, one for simple GET requests and one for more complex POST requests with a body. Both rely on a <URLTemplate> element to produce the URL, which can be populated with dependency data much like an LDAP search filter or database query. The POST option also supports a <BodyTemplate> element that can similarly generate a request body based on dependency data, typically JSON or XML. With POST, you also can control caching of results (if a results cache is used) by generating a cache entry key using a <CacheKeyTemplate> element.
The only supplied implementation for response processing is script-based, using the <ResponseMapping> element to supply a script to produce attribute data from the response body. For efficiency, the implementation assumes that the response processing script can consume the results in real time, and leaves any buffering of the data to the script, should that be necessary. Support is built-in for limiting the size of the data, allowed content types, and HTTP status codes accepted, to address the most common sanity checks.
...
| Name | Type | Default | Description |
|---|---|---|---|
httpClientRef | Bean ID | Bean ID of the HttpClient instance to use | |
httpClientSecurityParametersRef | Bean ID | Bean ID of the HttpClientSecurityParameters instance to use, ignored if one of the security shortcut settings are used | |
serverCertificate | Resource path | Path of resource containing a server certificate whose public key must match the server's. If set, httpClientSecurityParametersRef is ignored. | |
certificateAuthority | Resource path | Path of resource containing a certificate authority used to validate the server's certificate. If set, httpClientSecurityParametersRef is ignored. | |
clientPrivateKey | Resource path | Path of resource containing a private key used to authenticate the client to the server via TLS. If set, httpClientSecurityParametersRef is ignored. | |
clientCertificate | Resource path | Path of resource containing a certificate used to authenticate the client to the server via TLS. If set, httpClientSecurityParametersRef is ignored. | |
maxLength | Long | 0 | Limits size of response body to accept, or 0 for no limit. When used, only non-chunked responses that include a content length will be accepted. |
acceptStatuses | Collection<Integer> | 200 | Acceptable HTTP status codes |
acceptTypes | Collection<String> | Acceptable MIME content types | |
headerMapRef | Map<String,String> | Bean ID of a map of custom header names and values to set in the HTTP request | |
| Bean ID | Bean ID of a HTTPResponseMappingStrategy to process the result set in a pluggable way | |
validatorRef | Bean ID | Bean ID of a Validator to control what constitutes an initialization failure (the default does no validation) | |
executableSearchBuilderRef | Bean ID | Bean ID of an ExecutableSearchBuilder<HTTPSearch> to produce the request to execute | |
| Bean ID | Bean ID of a org.apache.velocity.app.VelocityEngine to use for processing the URL template, generally unnecessary |
...
| Name | Cardinality | Description |
|---|---|---|
| 0 or 1 | Template of a URL to execute via HTTP GET or POST | |
<BodyTemplate> | 0 or 1 | Template for a request body to submit via HTTP POST, requires use of <URLTemplate> |
<CacheKeyTemplate> | 0 or 1 | Template to produce a cache key to associate with the result of an HTTP POST, requires use of <BodyTemplate> |
<ResponseMapping> | 0 or 1 | Inline or external script to execute to process the response body |
0 or 1 | Defines how results should be cached. | |
| Bean ID (in the element content) defining how results should be cached as an externally defined com.google.common.cache.Cache<String,Map<String,IdPAttribute>> |
Externally (Spring) Defined Content
...
In practice, the HTTP Data Connector may be supplied with beans of the following types:
- ExecutableSearchBuilder<HTTPSearch>
- com.google.common.cache.Cache<String,Map<String,IdPAttribute>>
- Validator
- HTTPResponseMappingStrategy
In addition native bean IDs can be injected as follows:
- The HttpClient instance and its security settings are injected via the
httpClientRefandhttpClientSecurityParametersRefattributes. - The builder for the request can be specified as an externally defined bean via the
executableSearchBuilderRefattribute (as a replacement for the<URLTemplate>element and related elements). This allows for complete generality of the request-building process. - The processing of the response can be specified with an externally defined bean via the
mappingStrategyRefattribute (as a replacement for the<ResponseMapping>element). - The caching of results can be specified as an externally defined bean via the
<ResultCacheBean>element (as a replacement for the<ResultCache>element). - Rarely, a non-default Velocity engine can be injected via the
templateEngineattribute.