org.opensaml.saml2.metadata.provider

Class RequiredValidUntilFilter

java.lang.Object

org.opensaml.saml2.metadata.provider.RequiredValidUntilFilter

All Implemented Interfaces:

MetadataFilter

public class RequiredValidUntilFilter
extends Object
implements MetadataFilter

A metadata filter that requires the presence of a validUntil attribute on the root element of the metadata document. It can optionally also 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 the no restriction is placed on the metadata's validUntil attribute.

Constructor Summary

Constructors

Constructor and Description
RequiredValidUntilFilter() Constructor.
RequiredValidUntilFilter(long maxValidity) Constructor.

Method Summary

Modifier and Type	Method and Description
void	doFilter(org.opensaml.xml.XMLObject metadata) Filters the given metadata, perhaps to remove elements that are not wanted.
long	getMaxValidityInterval() Gets the maximum internal, in milliseconds, between now and the validUntil date.
protected org.joda.time.DateTime	getValidUntil(org.opensaml.xml.XMLObject metadata) Gets the validUntil time of the metadata, if present.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequiredValidUntilFilter

public RequiredValidUntilFilter()

Constructor.

RequiredValidUntilFilter

public RequiredValidUntilFilter(long maxValidity)

Constructor.

Parameters:

maxValidity - maximum internal, in seconds, between now and the validUntil date

Method Detail

getMaxValidityInterval

public long getMaxValidityInterval()

Gets the maximum internal, in milliseconds, between now and the validUntil date. A value of less than 1 indicates that there is no restriction.

Returns:

maximum internal, in milliseconds, between now and the validUntil date

doFilter

public void doFilter(org.opensaml.xml.XMLObject metadata)
              throws FilterException

Filters the given metadata, perhaps to remove elements that are not wanted.

Specified by:

doFilter in interface MetadataFilter

Parameters:

metadata - the metadata to be filtered.

Throws:

FilterException - thrown if an error occurs during the filtering process

getValidUntil

protected org.joda.time.DateTime getValidUntil(org.opensaml.xml.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 an EntitiesDescriptor or EntityDescriptor