org.springframework.security.saml.metadata
Class AbstractMetadataDelegate

java.lang.Object
  org.springframework.security.saml.metadata.AbstractMetadataDelegate

All Implemented Interfaces:

org.opensaml.saml2.metadata.provider.MetadataProvider, org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

Direct Known Subclasses:

ExtendedMetadataDelegate

public abstract class AbstractMetadataDelegate
extends Object
implements org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

Class wraps an existing provider and delegates all method calls to it. Subclasses can thus add additional functionality to existing implementations.

Author:

Vladimir Schaefer

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer

Constructor Summary

AbstractMetadataDelegate(org.opensaml.saml2.metadata.provider.MetadataProvider delegate)
Default constructor assigning the delegate.

Method Summary

boolean	equals(Object obj) Equality is based on the object this class delegates to.
org.opensaml.saml2.metadata.provider.MetadataProvider	getDelegate()
org.opensaml.saml2.metadata.EntitiesDescriptor	getEntitiesDescriptor(String name)
org.opensaml.saml2.metadata.EntityDescriptor	getEntityDescriptor(String entityID)
org.opensaml.xml.XMLObject	getMetadata()
org.opensaml.saml2.metadata.provider.MetadataFilter	getMetadataFilter()
List<org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer>	getObservers()
List<org.opensaml.saml2.metadata.RoleDescriptor>	getRole(String entityID, QName roleName)
org.opensaml.saml2.metadata.RoleDescriptor	getRole(String entityID, QName roleName, String supportedProtocol)
int	hashCode()
boolean	requireValidMetadata()
void	setMetadataFilter(org.opensaml.saml2.metadata.provider.MetadataFilter newFilter)
void	setRequireValidMetadata(boolean requireValidMetadata)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMetadataDelegate

public AbstractMetadataDelegate(org.opensaml.saml2.metadata.provider.MetadataProvider delegate)

Default constructor assigning the delegate. In case the provider implements observable interface the observation of this instance is delegated as well, otherwise an empty independent list of observers is created.

Parameters:

delegate - delegate to use, can't be null

Method Detail

requireValidMetadata

public boolean requireValidMetadata()

Specified by:

requireValidMetadata in interface org.opensaml.saml2.metadata.provider.MetadataProvider

setRequireValidMetadata

public void setRequireValidMetadata(boolean requireValidMetadata)

Specified by:

setRequireValidMetadata in interface org.opensaml.saml2.metadata.provider.MetadataProvider

getMetadataFilter

public org.opensaml.saml2.metadata.provider.MetadataFilter getMetadataFilter()

Specified by:

getMetadataFilter in interface org.opensaml.saml2.metadata.provider.MetadataProvider

setMetadataFilter

public void setMetadataFilter(org.opensaml.saml2.metadata.provider.MetadataFilter newFilter)
                       throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

setMetadataFilter in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getMetadata

public org.opensaml.xml.XMLObject getMetadata()
                                       throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

getMetadata in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getEntitiesDescriptor

public org.opensaml.saml2.metadata.EntitiesDescriptor getEntitiesDescriptor(String name)
                                                                     throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

getEntitiesDescriptor in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getEntityDescriptor

public org.opensaml.saml2.metadata.EntityDescriptor getEntityDescriptor(String entityID)
                                                                 throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

getEntityDescriptor in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getRole

public List<org.opensaml.saml2.metadata.RoleDescriptor> getRole(String entityID,
                                                                QName roleName)
                                                         throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

getRole in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getRole

public org.opensaml.saml2.metadata.RoleDescriptor getRole(String entityID,
                                                          QName roleName,
                                                          String supportedProtocol)
                                                   throws org.opensaml.saml2.metadata.provider.MetadataProviderException

Specified by:

getRole in interface org.opensaml.saml2.metadata.provider.MetadataProvider

Throws:

org.opensaml.saml2.metadata.provider.MetadataProviderException

getObservers

public List<org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer> getObservers()

Specified by:

getObservers in interface org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

getDelegate

public org.opensaml.saml2.metadata.provider.MetadataProvider getDelegate()

Returns:

original object the calls are delegated to

equals

public boolean equals(Object obj)

Equality is based on the object this class delegates to.

Overrides:

equals in class Object

Parameters:

obj - object

Returns:

true when obj equals delegate, in case obj is a wrapper itself only its delegate is compared

hashCode

public int hashCode()

Overrides:

hashCode in class Object