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

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 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.

Constructor Summary

Constructors

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

Method Summary

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

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 interval, in seconds, between now and the validUntil date

Method Detail

getMaxValidityInterval

public long getMaxValidityInterval()

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

Returns:

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

setMaxValidityInterval

public void setMaxValidityInterval(@Duration
                                   long validity)

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

Parameters:

validity - time in milliseconds between now and the validUntil date

filter

@Nullable
public XMLObject filter(@Nullable
                                  XMLObject metadata)
                           throws FilterException

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

Specified by:

filter in interface MetadataFilter

Parameters:

metadata - the metadata to be filtered.

Returns:

the filtered XMLObject, which may or may not be the same as the XMLObject instance passed in to the method. Maybe be null, for example if the top-level element was removed by the filter.

Throws:

FilterException - thrown if an error occurs during the filtering process

getValidUntil

@Nullable
protected org.joda.time.DateTime 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 an EntitiesDescriptor or EntityDescriptor