The Shibboleth IdP V4 software will leave support on September 1, 2024.

MetadataProviderDynamicAttributes

The following attributes are common to all dynamic metadata providers (i.e., DynamicHTTPMetadataProvider and LocalDynamicMetadataProvider):

Name

Type

Default

Description

Name

Type

Default

Description

parserPoolRef

Bean ID

shibboleth.ParserPool

Identifies a Spring bean for the XML parser used to parse metadata. Generally should not be changed.

taskTimerRef

Bean ID



Identifies a Spring bean containing a Java TaskTimer used to schedule reloads. When not set, an internal timer is created. Generally should not be changed.

refreshDelayFactor

Real Number (strictly between 0.0 and 1.0)

0.75

A factor applied to the initially determined refresh time in order to determine the next refresh time (typically to ensure refresh takes place prior to the metadata's expiration). Attempts to refresh metadata will generally begin around the product of this number and the maximum refresh delay.

minCacheDuration

Duration

PT10M

The minimum duration for which metadata will be cached before it is refreshed

maxCacheDuration

Duration

PT8H

The maximum duration for which metadata will be cached before it is refreshed

maxIdleEntityData

Duration

PT8H

The maximum duration for which metadata will be allowed to be idle (no requests for it) before it is removed from the cache

removeIdleEntityData

Boolean

true

Flag indicating whether idle metadata should be removed

cleanupTaskInterval

Duration

PT30M

The interval at which the internal cleanup task should run. This task performs background maintenance tasks, such as the removal of expired and idle metadata.

persistentCacheManagerRef

Bean ID



The optional manager for the persistent cache store for resolved metadata. On metadata provider initialization, data present in the persistent cache will be loaded to memory, effectively restoring the state of the provider as closely as possible to that which existed before the previous shutdown. Each individual cache entry will only be loaded if 1) the entry is still valid as determined by the internal provider logic, and 2) the entry passes the (optional) predicate supplied via initializationFromCachePredicateRef.

persistentCacheManagerDirectory

Directory path



The directory used for an internally-constructed filesystem-based persistent cache. This is a convenience parameter to avoid specifying a full bean via persistentCacheManagerRef. This option will be ignored if persistentCacheManagerRef is specified.

NOTE: Do NOT specify a directory containing other metadata or any other content under local control, as the cache manager may alter those files, or fail to process them correctly, or both. Use a dedicated directory for each provider.

persistentCacheKeyGeneratorRef

Bean ID

internal default instance

Identifies a Spring bean for a Function which generates the string key used with the cache manager. The default implementation produces the lower-case hex-encoded SHA-1 digest of the entityID of the EntityDescriptor.

initializeFromPersistentCacheInBackground

Boolean

true

Flag indicating whether should initialize from the persistent cache in the background. Initializing from the cache in the background will improve IdP startup times.

backgroundInitializationFromCacheDelay

Duration

PT2S

The delay after which to schedule the background initialization from the persistent cache when initializeFromPersistentCacheInBackground=true.

initializationFromCachePredicateRef

Bean ID

"always true" predicate

Identifies a Spring bean for an optional Predicate which determines whether a given entity should be loaded from the persistent cache at resolver initialization time.