net.shibboleth.idp.saml.metadata

Class RelyingPartyMetadataProvider

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.service.AbstractServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>

net.shibboleth.idp.saml.metadata.RelyingPartyMetadataProvider

All Implemented Interfaces:

Comparable<RelyingPartyMetadataProvider>, Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resolver<org.opensaml.saml.saml2.metadata.EntityDescriptor,CriteriaSet>, ServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>, org.opensaml.saml.metadata.resolver.MetadataResolver, org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class RelyingPartyMetadataProvider
extends AbstractServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>
implements org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver, Comparable<RelyingPartyMetadataProvider>

This class exists primarily to allow the parsing of relying-party.xml to create a serviceable implementation of MetadataResolver.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private org.opensaml.saml.metadata.resolver.MetadataResolver	resolver The embedded resolver.
private Integer	sortKey The key by which we sort the provider.
private static int	sortKeyValue If we autogenerate a sort key it comes from this count.

Constructor Summary

Constructors

Constructor and Description
RelyingPartyMetadataProvider() Constructor.
RelyingPartyMetadataProvider(org.opensaml.saml.metadata.resolver.MetadataResolver child) Deprecated. use properties and RelyingPartyMetadataProvider().

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(RelyingPartyMetadataProvider other)
protected void	doInitialize()
boolean	equals(Object other) .
org.opensaml.saml.metadata.resolver.MetadataResolver	getComponent()
org.opensaml.saml.metadata.resolver.MetadataResolver	getEmbeddedResolver() Return what we are build around.
DateTime	getLastRefresh()
DateTime	getLastUpdate()
org.opensaml.saml.metadata.resolver.filter.MetadataFilter	getMetadataFilter()
int	hashCode()
boolean	isRequireValidMetadata()
void	refresh()
Iterable<org.opensaml.saml.saml2.metadata.EntityDescriptor>	resolve(CriteriaSet criteria)
org.opensaml.saml.saml2.metadata.EntityDescriptor	resolveSingle(CriteriaSet criteria)
void	setEmbeddedResolver(org.opensaml.saml.metadata.resolver.MetadataResolver theResolver) Set the MetadataResolver to embed.
void	setMetadataFilter(org.opensaml.saml.metadata.resolver.filter.MetadataFilter newFilter)
void	setRequireValidMetadata(boolean requireValidMetadata)
void	setSortKey(int key) Set the sort key.

Methods inherited from class net.shibboleth.ext.spring.service.AbstractServiceableComponent

doDestroy, getApplicationContext, pinComponent, setApplicationContext, unloadComponent, unpinComponent

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId, setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

getId

Field Detail

sortKeyValue

private static int sortKeyValue

If we autogenerate a sort key it comes from this count.

log

private final org.slf4j.Logger log

Class logger.

resolver

@NonnullAfterInit
private org.opensaml.saml.metadata.resolver.MetadataResolver resolver

The embedded resolver.

sortKey

@NonnullAfterInit
private Integer sortKey

The key by which we sort the provider.

Constructor Detail

RelyingPartyMetadataProvider

@Deprecated
public RelyingPartyMetadataProvider(@Nonnull@ParameterName(name="child")
                                       org.opensaml.saml.metadata.resolver.MetadataResolver child)

Deprecated. use properties and RelyingPartyMetadataProvider().

Constructor.

Parameters:

child - The MetadataResolver to embed.

RelyingPartyMetadataProvider

public RelyingPartyMetadataProvider()

Constructor.

Method Detail

setSortKey

public void setSortKey(int key)

Set the sort key.

Parameters:

key - what to set

setEmbeddedResolver

@Nonnull
public void setEmbeddedResolver(@Nonnull
                               org.opensaml.saml.metadata.resolver.MetadataResolver theResolver)

Set the MetadataResolver to embed.

Parameters:

theResolver - The MetadataResolver to embed.

getEmbeddedResolver

@Nonnull
public org.opensaml.saml.metadata.resolver.MetadataResolver getEmbeddedResolver()

Return what we are build around. Used for testing.

Returns:

the parameter we got as a constructor

resolve

@Nonnull
public Iterable<org.opensaml.saml.saml2.metadata.EntityDescriptor> resolve(@Nullable
                                                                          CriteriaSet criteria)
                                                                    throws ResolverException

Specified by:

resolve in interface Resolver<org.opensaml.saml.saml2.metadata.EntityDescriptor,CriteriaSet>

Throws:

ResolverException

resolveSingle

@Nullable
public org.opensaml.saml.saml2.metadata.EntityDescriptor resolveSingle(@Nullable
                                                                       CriteriaSet criteria)
                                                                throws ResolverException

Specified by:

resolveSingle in interface Resolver<org.opensaml.saml.saml2.metadata.EntityDescriptor,CriteriaSet>

Throws:

ResolverException

isRequireValidMetadata

public boolean isRequireValidMetadata()

Specified by:

isRequireValidMetadata in interface org.opensaml.saml.metadata.resolver.MetadataResolver

setRequireValidMetadata

public void setRequireValidMetadata(boolean requireValidMetadata)

Specified by:

setRequireValidMetadata in interface org.opensaml.saml.metadata.resolver.MetadataResolver

getMetadataFilter

@Nullable
public org.opensaml.saml.metadata.resolver.filter.MetadataFilter getMetadataFilter()

Specified by:

getMetadataFilter in interface org.opensaml.saml.metadata.resolver.MetadataResolver

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>

Throws:

ComponentInitializationException

setMetadataFilter

public void setMetadataFilter(@Nullable
                     org.opensaml.saml.metadata.resolver.filter.MetadataFilter newFilter)

Specified by:

setMetadataFilter in interface org.opensaml.saml.metadata.resolver.MetadataResolver

getComponent

@Nonnull
public org.opensaml.saml.metadata.resolver.MetadataResolver getComponent()

Specified by:

getComponent in interface ServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>

Specified by:

getComponent in class AbstractServiceableComponent<org.opensaml.saml.metadata.resolver.MetadataResolver>

refresh

public void refresh()
             throws ResolverException

Specified by:

refresh in interface org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver

Throws:

ResolverException

getLastRefresh

public DateTime getLastRefresh()

Specified by:

getLastRefresh in interface org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver

getLastUpdate

public DateTime getLastUpdate()

Specified by:

getLastUpdate in interface org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver

compareTo

public int compareTo(RelyingPartyMetadataProvider other)

Specified by:

compareTo in interface Comparable<RelyingPartyMetadataProvider>

equals

public boolean equals(Object other)

. We are within a spring context and so equality can be determined by ID, however we also test by sortKey just in case.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object