ResourceBackedMetadataProvider

The Shibboleth IdP V3 software has reached its End of Life and is no longer supported. This documentation is available for historical purposes only. See the IDP4 wiki space for current documentation on the supported version.

ResourceBackedMetadataProvider

The ResourceBackedMetadataProvider loads metadata from a resource - a complex source that cannot be located from a file or an HTTP URL. The provider can be configured to periodically check and reload the metadata if needed.

The only supported use of this provider is with spring define bean which is a Spring Resource (or more rarely a Shibboleth Resource) via the resourceRef attribute.

Contents

Schema Names and location

The <MetadataProvider> element and the type ResourceBackedMetadataProvider are defined by the urn:mace:shibboleth:2.0:metadata schema, which can be located at http://shibboleth.net/schema/idp/shibboleth-metadata.xsd.  

Attributes

Any of the Common Attributes or the Reloading Attributes may be configured. 

In addition the resourceRef property is used to specify the source of the data.

Common Attributes

Reloading Attributes

Child Elements

Any of the following child elements may be specified (in order).

Name

Cardinality

Description

Name

Cardinality

Description

<MetadataFilter>

0 or more

A metadata filter applied to candidate metadata as it flows through the metadata pipeline

<MetadataResource>

0 or 1

Deprecated If present, it specifies the metadata resource type

The <MetadataFilter> child element is common to all metadata providers. The <MetadataResource> child element is exclusive to the ResourceBackedMetadataProvider type.

Examples

The following example loads metadata from the supplied bean

Load Metadata from the classpath
<MetadataProvider id="ClasspathResourceMetadata" xsi:type="ResourceBackedMetadataProvider" resourceRef="SpringResource"/>