org.opensaml.saml.metadata.resolver

Interface RefreshableMetadataResolver

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:

AbstractReloadingMetadataResolver, ChainingMetadataResolver, CompositeMetadataResolver, FileBackedHTTPMetadataResolver, FilesystemMetadataResolver, HTTPMetadataResolver, ResourceBackedMetadataResolver

public interface RefreshableMetadataResolver
extends MetadataResolver

Specialization of MetadataResolver that supports on-demand refresh.

Method Summary

Modifier and Type	Method and Description
org.joda.time.DateTime	getLastRefresh() Gets the time the last refresh cycle occurred.
org.joda.time.DateTime	getLastUpdate() Get the time that the currently available metadata was last updated.
void	refresh() Refresh the data exposed by the resolver.

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

refresh

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

Refresh the data exposed by the resolver.

An implementation of this method should typically be either synchronized or make use other locking mechanisms to protect against concurrent access.

Throws:

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

getLastRefresh

@Nullable
org.joda.time.DateTime getLastRefresh()

Gets the time the last refresh cycle occurred.

Returns:

time the last refresh cycle occurred

getLastUpdate

@Nullable
org.joda.time.DateTime getLastUpdate()

Get the time that the currently available metadata was last updated. Note, this may be different than the time retrieved by getLastRefresh() is the metadata was known not to have changed during the last refresh cycle.

Returns:

time when the currently metadata was last updated, null if metadata has never successfully been read in