Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
activetrue
Expand
titleXML Attributes


NameTypeReq?DefaultDescription
metadataURL                       
URLY
The URL that the metadata is served from
backingFileFile pathnameY
Specifies where the backing file is located. If the remote server is unavailable at startup, the backing file is loaded instead.
initializeFromBackupFileBoolean
trueFlag 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.
backupFileInitNextRefreshDelayDelay (ISO8601 format)
PT5S

Delay

duration after which to schedule next HTTP refresh when initialized from the backing filelocaltab

du



CommonAttributes


Expand
titleXML Elements


NameCardinalityDescription
<TLSTrustEngine>0 or 1A custom TrustEngine used to evaluate TLS server certificates. It contains a single <security:TrustEngine> element.
Localtab
id


ReloadingAttributes
Expand
titleCommon XML Attributes

Include Page
MetadataProviderCommonAttributes
MetadataProviderCommonAttributes

Localtab
id


HTTPAttributes
Expand
titleReloading XML Attributes

Include Page
MetadataProviderReloadingAttributes
MetadataProviderReloadingAttributes

Localtab
id


Expand
titleHTTP XML Attributes

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
titleCommon XML Elements

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:

...

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.

...