org.opensaml.saml2.metadata.provider
Class BaseMetadataProvider

java.lang.Object
  org.opensaml.saml2.metadata.provider.BaseMetadataProvider

All Implemented Interfaces:

MetadataProvider

Direct Known Subclasses:

AbstractMetadataProvider, ChainingMetadataProvider

public abstract class BaseMetadataProvider
extends Object
implements MetadataProvider

Base class for metadata providers.

Field Summary

private MetadataFilter	mdFilter Filter applied to all metadata.
private boolean	requireValidMetadata Whether metadata is required to be valid.
protected UnmarshallerFactory	unmarshallerFactory Unmarshaller factory used to get an unmarshaller for the metadata DOM.

Constructor Summary

BaseMetadataProvider()
Constructor.

Method Summary

void	destroy() Destroys the metadata provider and frees any resources current held by it.
MetadataFilter	getMetadataFilter() Gets the metadata filter applied to the metadata.
boolean	requireValidMetadata() Gets whether the metadata returned by queries must be valid.
void	setMetadataFilter(MetadataFilter newFilter) Sets the metadata filter applied to the metadata.
void	setRequireValidMetadata(boolean require) Sets whether the metadata returned by queries must be valid.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.saml2.metadata.provider.MetadataProvider

getEntitiesDescriptor, getEntityDescriptor, getMetadata, getRole, getRole

Field Detail

unmarshallerFactory

protected UnmarshallerFactory unmarshallerFactory

Unmarshaller factory used to get an unmarshaller for the metadata DOM.

requireValidMetadata

private boolean requireValidMetadata

Whether metadata is required to be valid.

mdFilter

private MetadataFilter mdFilter

Filter applied to all metadata.

Constructor Detail

BaseMetadataProvider

public BaseMetadataProvider()

Constructor.

Method Detail

requireValidMetadata

public boolean requireValidMetadata()

Gets whether the metadata returned by queries must be valid. At a minimum, metadata is valid only if the date expressed in the element, and all its ancestral element's, validUntil attribute has not passed. Specific implementations may add additional constraints.

Specified by:

requireValidMetadata in interface MetadataProvider

Returns:

whether the metadata returned by queries must be valid

setRequireValidMetadata

public void setRequireValidMetadata(boolean require)

Sets whether the metadata returned by queries must be valid.

Specified by:

setRequireValidMetadata in interface MetadataProvider

Parameters:

require - whether the metadata returned by queries must be valid

getMetadataFilter

public MetadataFilter getMetadataFilter()

Gets the metadata filter applied to the metadata.

Specified by:

getMetadataFilter in interface MetadataProvider

Returns:

the metadata filter applied to the metadata

setMetadataFilter

public void setMetadataFilter(MetadataFilter newFilter)
                       throws MetadataProviderException

Sets the metadata filter applied to the metadata.

Specified by:

setMetadataFilter in interface MetadataProvider

Parameters:

newFilter - the metadata filter applied to the metadata

Throws:

MetadataProviderException - thrown if the provider can not apply the filter to the metadata

destroy

public void destroy()

Destroys the metadata provider and frees any resources current held by it. Default method is a no-op.