FolderMetadataProvider

FolderMetadataProvider

Overview

Identified by type="Folder", this MetadataProvider automatically wraps all of the files in a local directory with individual instances of an XML MetatataProvider  instance, after which the files may be individually monitored.

Use the LocalDynamic MetadataProvider

Deployers will find the LocalDynamicMetadataProvider much better suited to loading metadata from a folder, though at a slight cost in cognitive load from needing to rename the files. That plugin consumes far fewer system resources and allows metadata to be dynamically added, not just altered.

Reference

The type="Folder" attribute must be present.

The following attributes are supported for all MetadataProvider types:

Name

Type

Req?

Default

Description

Name

Type

Req?

Default

Description

type

string

Y

 

Specifies the exact type of metadata plugin to use

id

string

 

 

A label for the metadata source, used in logging and status reporting

validate

boolean



false

Whether the XML should be schema validated before it is parsed. Note that some sources of metadata (e.g., ADFS) may contain a large number of extensions. The SP now includes a number of additional schemas to make validation of such extensions possible, but there are always exceptions.

The following attributes are also supported (and the path attribute is required):

Name

Type

Req?

Default

Description

Name

Type

Req?

Default

Description

path

local pathname

Y

 

Directory from which to load metadata

discoveryFeed

boolean



true

When true, a JSON feed of IdP information will be produced and cached in memory for use by the DiscoveryFeed handler. Can be disabled to save processing and memory.

dropDOM

boolean



true

When true, the underlying XML DOM structure is dropped after processing a new metadata instance. Set to false to maintain the DOM in memory if there are supplemental options being used that operate more efficiently with the DOM maintained.

reloadChanges

boolean



true

Whether the individual files are to be reloadable. Note that the directory is NOT rescanned, so files that are added to the folder after startup will not be processed.

The following child elements are supported across all MetadataProvider types:

Name

Cardinality

Description

Name

Cardinality

Description

<MetadataFilter>

any

Metadata filter plugins to run

<KeyInfoResolver>

0 or 1

Not generally used, it provides an extension point to override the low-level handling of <ds:KeyInfo> elements and would be necessary to add support for some kind of custom XML key representation