Class RequiredValidUntilFilter
- java.lang.Object
-
- org.opensaml.saml.metadata.resolver.filter.impl.RequiredValidUntilFilter
-
- All Implemented Interfaces:
MetadataFilter
public class RequiredValidUntilFilter extends Object implements MetadataFilter
A metadata filter that requires the presence of avalidUntil
attribute on the root element of the metadata document. It can optionally enforce that the validity period (now minusvalidUntil
date) is not longer than a specified amount. A maximum validity interval of less than 1 means that no restriction is placed on the metadata'svalidUntil
attribute.
-
-
Field Summary
Fields Modifier and Type Field Description private org.slf4j.Logger
log
Class logger.private Duration
maxValidityInterval
The maximum interval between now and thevalidUntil
date.
-
Constructor Summary
Constructors Constructor Description RequiredValidUntilFilter()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XMLObject
filter(XMLObject metadata, MetadataFilterContext context)
Duration
getMaxValidityInterval()
Get the maximum interval between now and thevalidUntil
date.protected Instant
getValidUntil(XMLObject metadata)
Gets the validUntil time of the metadata, if present.void
setMaxValidityInterval(Duration validity)
Set the maximum interval between now and thevalidUntil
date.
-
-
-
Field Detail
-
log
@Nonnull private final org.slf4j.Logger log
Class logger.
-
maxValidityInterval
@Nullable private Duration maxValidityInterval
The maximum interval between now and thevalidUntil
date. Defaults to 14 days.
-
-
Method Detail
-
getMaxValidityInterval
@Nullable public Duration getMaxValidityInterval()
Get the maximum interval between now and thevalidUntil
date. A value <=0 indicates that there is no restriction.- Returns:
- maximum interval between now and the
validUntil
date
-
setMaxValidityInterval
public void setMaxValidityInterval(@Nullable Duration validity)
Set the maximum interval between now and thevalidUntil
date. A value <=0 indicates that there is no restriction.- Parameters:
validity
- time between now and thevalidUntil
date
-
filter
@Nullable public XMLObject filter(@Nullable XMLObject metadata, @Nonnull MetadataFilterContext context) throws FilterException
- Specified by:
filter
in interfaceMetadataFilter
- Throws:
FilterException
-
getValidUntil
@Nullable protected Instant getValidUntil(@Nonnull XMLObject metadata) throws FilterException
Gets the validUntil time of the metadata, if present.- Parameters:
metadata
- metadata from which to get the validUntil instant- Returns:
- the valid until instant or null if it is not present
- Throws:
FilterException
- thrown if the given XML object is not anEntitiesDescriptor
orEntityDescriptor
-
-