se.litsec.opensaml.saml2.metadata.provider

Interface MetadataProvider

All Superinterfaces:

Component, DestructableComponent, InitializableComponent

All Known Implementing Classes:

AbstractMetadataProvider, CompositeMetadataProvider, FilesystemMetadataProvider, HTTPMetadataProvider, ProxyMetadataProvider, SpringResourceMetadataProvider, StaticMetadataProvider

public interface MetadataProvider
extends InitializableComponent, DestructableComponent

An interface that offers methods that operate on one or several metadata sources.

A MetadataProvider instance encapsulates OpenSAML:s MetadataResolver and adds easy to use methods and configuration.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Method Summary

Modifier and Type	Method and Description
Optional<EntityDescriptor>	getEntityDescriptor(String entityID) Returns the entity descriptor identified by the given entityID.
String	getID() Returns the identifier for the provider.
List<EntityDescriptor>	getIdentityProviders() Utility method that returns a list of entity descriptors for Identity Providers found in the metadata.
Optional<IDPSSODescriptor>	getIDPSSODescriptor(String entityID) A utility method that extracts the IdP SSO descriptor from the Entity Descriptor identified by the supplied entityID.
Optional<org.joda.time.DateTime>	getLastUpdate() Returns the time the currently available metadata was last updated.
Optional<XMLObject>	getMetadata() Returns the XML element making up the metadata for the federation.
Optional<Element>	getMetadataDOM() Returns the DOM element making up the metadata for the federation.
MetadataResolver	getMetadataResolver() Returns the underlying OpenSAML metadata resolver.
List<EntityDescriptor>	getServiceProviders() Utility method that returns a list of entity descriptors for Service Providers found in the metadata.
Optional<SPSSODescriptor>	getSPSSODescriptor(String entityID) A utility method that extracts the SP SSO descriptor from the Entity Descriptor identified by the supplied entityID.
Iterable<EntityDescriptor>	iterator() Returns an iterator for all entity descriptors held by the provider.
Iterable<EntityDescriptor>	iterator(QName role) Returns an iterator for all entity descriptors having the given role.
void	refresh() Refresh the metadata handled by the provider.

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

initialize, isInitialized

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

destroy, isDestroyed

Method Detail

getID

String getID()

Returns the identifier for the provider.

Returns:

the identifier

getMetadata

Optional<XMLObject> getMetadata()
                         throws ResolverException

Returns the XML element making up the metadata for the federation. This element is either an EntityDescriptor or an EntitiesDescriptor.

Returns:

an XML element

Throws:

ResolverException - for metadata resolving errors

getMetadataDOM

Optional<Element> getMetadataDOM()
                          throws MarshallingException

Returns the DOM element making up the metadata for the federation.

Returns:

a DOM element

Throws:

MarshallingException - for XML marshalling errors

getLastUpdate

Optional<org.joda.time.DateTime> getLastUpdate()

Returns the time the currently available metadata was last updated.

Returns:

time when the currently metadata was last updated, or an empty optional if no metadata has been successfully loaded

refresh

void refresh()
      throws ResolverException

Refresh the metadata handled by the provider.

An implementation that does not support refresh should implement this operation as a no-op. Implementations that do support refresh of metadata should typically be either synchronized or make use other locking mechanisms to protect against concurrent access.

Throws:

ResolverException - if the refresh operation was unsuccessful

iterator

Iterable<EntityDescriptor> iterator()

Returns an iterator for all entity descriptors held by the provider.

Returns:

an iterator for all entity descriptors

iterator

Iterable<EntityDescriptor> iterator(QName role)

Returns an iterator for all entity descriptors having the given role.

To list all IdP:s and SP:s do:

 
 idps = provider.iterator(IDPSSODescriptor.DEFAULT_ELEMENT_NAME);
 sps = provider.iterator(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
 

Parameters:

role - role descriptor

Returns:

an iterator for all matching entity descriptors

See Also:

getIdentityProviders(), getServiceProviders()

getEntityDescriptor

Optional<EntityDescriptor> getEntityDescriptor(String entityID)
                                        throws ResolverException

Returns the entity descriptor identified by the given entityID.

Parameters:

entityID - the unique entityID for the entry

Returns:

an entity descriptor

Throws:

ResolverException - for underlying metadata errors

getIDPSSODescriptor

Optional<IDPSSODescriptor> getIDPSSODescriptor(String entityID)
                                        throws ResolverException

A utility method that extracts the IdP SSO descriptor from the Entity Descriptor identified by the supplied entityID.

Parameters:

entityID - the entityID for the IdP

Returns:

the SSO descriptor for the IdP

Throws:

ResolverException - for underlying metadata errors

See Also:

getEntityDescriptor(String)

getSPSSODescriptor

Optional<SPSSODescriptor> getSPSSODescriptor(String entityID)
                                      throws ResolverException

A utility method that extracts the SP SSO descriptor from the Entity Descriptor identified by the supplied entityID.

Parameters:

entityID - the entityID for the Service Provider

Returns:

the SSO descriptor for the SP

Throws:

ResolverException - for underlying metadata errors

See Also:

getEntityDescriptor(String)

getIdentityProviders

List<EntityDescriptor> getIdentityProviders()
                                     throws ResolverException

Utility method that returns a list of entity descriptors for Identity Providers found in the metadata.

Returns:

a list of entity descriptors

Throws:

ResolverException - for metadata errors

getServiceProviders

List<EntityDescriptor> getServiceProviders()
                                    throws ResolverException

Utility method that returns a list of entity descriptors for Service Providers found in the metadata.

Returns:

a list of entity descriptors

Throws:

ResolverException - for metadata errors

getMetadataResolver

MetadataResolver getMetadataResolver()

Returns the underlying OpenSAML metadata resolver.

Returns:

OpenSAML metadata resolver