Package org.opensaml.saml.metadata.resolver.filter.impl

Class RequiredValidUntilFilter

java.lang.Object

org.opensaml.saml.metadata.resolver.filter.impl.RequiredValidUntilFilter

All Implemented Interfaces:

org.opensaml.saml.metadata.resolver.filter.MetadataFilter

public class RequiredValidUntilFilter
extends Object
implements org.opensaml.saml.metadata.resolver.filter.MetadataFilter

A metadata filter that requires the presence of a validUntil attribute on the root element of the metadata document. It can optionally enforce that the validity period (now minus validUntil 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's validUntil attribute.

Field Summary

Fields

Modifier and Type	Field	Description
private Logger	log	Class logger.
private Duration	maxValidityInterval	The maximum interval between now and the validUntil date.

Constructor Summary

Constructors

Constructor	Description
RequiredValidUntilFilter()	Constructor.

Method Summary

Modifier and Type	Method	Description
org.opensaml.core.xml.XMLObject	filter(org.opensaml.core.xml.XMLObject metadata, org.opensaml.saml.metadata.resolver.filter.MetadataFilterContext context)
Duration	getMaxValidityInterval()	Get the maximum interval between now and the validUntil date.
protected Instant	getValidUntil(org.opensaml.core.xml.XMLObject metadata)	Gets the validUntil time of the metadata, if present.
void	setMaxValidityInterval(Duration validity)	Set the maximum interval between now and the validUntil date.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

@Nonnull
private final Logger log

Class logger.

maxValidityInterval

@Nullable
private Duration maxValidityInterval

The maximum interval between now and the validUntil date. Defaults to 14 days.

Constructor Detail

RequiredValidUntilFilter

public RequiredValidUntilFilter()

Constructor.

Method Detail

getMaxValidityInterval

@Nullable
public Duration getMaxValidityInterval()

Get the maximum interval between now and the validUntil 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 the validUntil date. A value <=0 indicates that there is no restriction.

Parameters:

validity - time between now and the validUntil date

filter

@Nullable
public org.opensaml.core.xml.XMLObject filter(@Nullable
                                              org.opensaml.core.xml.XMLObject metadata,
                                              @Nonnull
                                              org.opensaml.saml.metadata.resolver.filter.MetadataFilterContext context)
                                       throws org.opensaml.saml.metadata.resolver.filter.FilterException

Specified by:

filter in interface org.opensaml.saml.metadata.resolver.filter.MetadataFilter

Throws:

org.opensaml.saml.metadata.resolver.filter.FilterException

getValidUntil

@Nullable
protected Instant getValidUntil(@Nonnull
                                org.opensaml.core.xml.XMLObject metadata)
                         throws org.opensaml.saml.metadata.resolver.filter.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:

org.opensaml.saml.metadata.resolver.filter.FilterException - thrown if the given XML object is not an EntitiesDescriptor or EntityDescriptor