org.opensaml.saml.metadata.resolver

Interface ClearableMetadataResolver

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent, MetadataResolver, net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

All Known Implementing Classes:

ChainingMetadataResolver

public interface ClearableMetadataResolver
extends MetadataResolver

Specialization of MetadataResolver that supports on-demand clearing of the resolver's internal cache of data.

This would typically be implemented by "dynamic" resolvers of metadata such as DynamicMetadataResolver, rather than "batch" resolvers such as BatchMetadataResolver.

Method Summary

Modifier and Type	Method and Description
void	clear() Attempt to clear all data from the internal cache of the resolver.
void	clear(String entityID) Attempt to clear data from the internal cache of the resolver for the specified entityID.

Methods inherited from interface org.opensaml.saml.metadata.resolver.MetadataResolver

getMetadataFilter, isRequireValidMetadata, setMetadataFilter, setRequireValidMetadata

Methods inherited from interface net.shibboleth.utilities.java.support.resolver.Resolver

resolve, resolveSingle

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Method Detail

clear

void clear()
    throws net.shibboleth.utilities.java.support.resolver.ResolverException

Attempt to clear all data from the internal cache of the resolver.

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if the clear operation was unsuccessful

clear

void clear(@Nonnull
           String entityID)
    throws net.shibboleth.utilities.java.support.resolver.ResolverException

Attempt to clear data from the internal cache of the resolver for the specified entityID.

Parameters:

entityID - the target entityID

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if the clear operation was unsuccessful