Namespace: urn:mace:shibboleth:2.0:metadata
Schema: http://shibboleth.net/schema/idp/shibboleth-metadata.xsd
...
The FileBackedHTTPMetadataProvider spools the metadata contents to a local backing file, which is used at startup. Note that the backing file is only used at startup. A refresh operation never consults the backing file since the latter can't possibly represent newer metadata than what is already cached in memory.
Reference
| Localtabgroup |
|---|
| Localtab |
|---|
active | true| Expand |
|---|
|
| Name | Type | Req? | Default | Description |
|---|
metadataURL
| URL | Y |
| The URL that the metadata is served from | backingFile | File pathname | Y |
| Specifies where the backing file is located. If the remote server is unavailable at startup, the backing file is loaded instead. | initializeFromBackupFile | Boolean |
| true | Flag indicating whether initialization should first attempt to load metadata from the backup file. If true, foreground initialization will be performed by loading the backing file, and then a refresh from the remote HTTP server will be scheduled to execute in a background thread, after a configured delay. This can improve IdP startup times when the remote HTTP file is large in size. | backupFileInitNextRefreshDelay | Delay (ISO8601 format) |
| PT5S | Delay |
|
| Expand |
|---|
|
| Name | Cardinality | Description |
|---|
<TLSTrustEngine> | 0 or 1 | A custom TrustEngine used to evaluate TLS server certificates. It contains a single <security:TrustEngine> element. |
| Localtab |
|---|
| id | CommonAttributes
|---|
| Expand |
|---|
| title | Common XML Attributes |
|---|
|
| Include Page |
|---|
| MetadataProviderCommonAttributes |
|---|
| MetadataProviderCommonAttributes |
|---|
|
| Localtab |
|---|
| id | ReloadingAttributes
|---|
| Expand |
|---|
| title | Reloading XML Attributes |
|---|
|
| Include Page |
|---|
| MetadataProviderReloadingAttributes |
|---|
| MetadataProviderReloadingAttributes |
|---|
|
| Localtab |
|---|
| id | HTTPAttributes
|---|
| Expand |
|---|
|
| Include Page |
|---|
| MetadataProviderHTTPAttributes |
|---|
| MetadataProviderHTTPAttributes |
|---|
|
For a FileBackedHTTPMetadataProvider, the the HTTP Connection Attributes each have a 60 second timeout default. Since the batch metadata refresh process runs in a background thread, a browser user will not notice such a delay .localtab |
| Expand |
|---|
|
| Include Page |
|---|
| MetadataProviderChildElements |
|---|
| MetadataProviderChildElements |
|---|
|
|
Examples
A typical use of FileBackedHTTPMetadataProvider is to load (and periodically reload) a metadata aggregate from a remote source via HTTP:
...
See also Troubleshooting.
A FileBackedHTTPMetadataProvider loads (and reloads) metadata in the background, independent of normal IdP operation. The frequency of metadata refresh is influenced by the Reloading Attributes. In particular, the minRefreshDelay and maxRefreshDelay attributes strongly influence the frequency of metadata refresh. Any cacheDuration and validUntil attributes in the metadata itself also influence the process.
...
A conforming server will respond to an HTTP conditional GET request (RFC 7232) with a 304 (Not Modified) status code if the target resource has not changed since the last time it was requested. Note that a 304 response does not include a response body, which is more efficient than the corresponding 200 response (especially for large metadata files). More importantly, due to the manner in which the FileBackedHTTPMetadataProvider is implemented, the IdP can safely ignore a 304 response, which precludes the need to redundantly process the metadata. For large signed metadata files, the savings can be quite significant.
...