org.opensaml.saml.metadata.resolver.impl

Class BasicRoleDescriptorResolver

java.lang.Object

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

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

org.opensaml.saml.metadata.resolver.impl.BasicRoleDescriptorResolver

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.resolver.Resolver<RoleDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>, RoleDescriptorResolver

public class BasicRoleDescriptorResolver
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements RoleDescriptorResolver

Simple impl of RoleDescriptorResolver which wraps an instance of MetadataResolver to support basic EntityDescriptor resolution, and then performs further role-related filtering over the returned EntityDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
private MetadataResolver	entityDescriptorResolver Resolver of EntityDescriptors.
private org.slf4j.Logger	log Logger.
private boolean	requireValidMetadata Whether metadata is required to be valid.

Constructor Summary

Constructors

Constructor and Description
BasicRoleDescriptorResolver(MetadataResolver mdResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
protected EntityDescriptor	doGetEntityDescriptor(java.lang.String entityID) Resolve an entity descriptor based on entityID using the wrapped metadata resolver.
protected java.util.List<RoleDescriptor>	doGetRole(java.lang.String entityID, javax.xml.namespace.QName roleName) Gets the identified roles from an EntityDescriptor.
protected RoleDescriptor	doGetRole(java.lang.String entityID, javax.xml.namespace.QName roleName, java.lang.String supportedProtocol) Gets the role which supports the given protocol.
protected java.util.List<RoleDescriptor>	getRole(java.lang.String entityID, javax.xml.namespace.QName roleName) Get role descriptors for a given entityID and role.
protected RoleDescriptor	getRole(java.lang.String entityID, javax.xml.namespace.QName roleName, java.lang.String supportedProtocol) Get role descriptor for a given entityID and role and protocol.
boolean	isRequireValidMetadata() Gets whether the metadata returned by queries must be valid.
protected boolean	isValid(XMLObject descriptor) Returns whether the given descriptor is valid.
java.lang.Iterable<RoleDescriptor>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
RoleDescriptor	resolveSingle(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
void	setRequireValidMetadata(boolean require) Sets whether the metadata returned by queries must be valid.

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

doInitialize, getId, setId

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

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

getId

Field Detail

log

private org.slf4j.Logger log

Logger.

requireValidMetadata

private boolean requireValidMetadata

Whether metadata is required to be valid.

entityDescriptorResolver

private MetadataResolver entityDescriptorResolver

Resolver of EntityDescriptors.

Constructor Detail

BasicRoleDescriptorResolver

public BasicRoleDescriptorResolver(@Nonnull
                                   MetadataResolver mdResolver)

Constructor.

Parameters:

mdResolver - the resolver of EntityDescriptors

Method Detail

isRequireValidMetadata

public boolean isRequireValidMetadata()

Gets whether the metadata returned by queries must be valid. At a minimum, metadata is valid only if the date expressed in the element, and all its ancestral element's, validUntil attribute has not passed. Specific implementations may add additional constraints.

Specified by:

isRequireValidMetadata in interface RoleDescriptorResolver

Returns:

whether the metadata returned by queries must be valid

setRequireValidMetadata

public void setRequireValidMetadata(boolean require)

Sets whether the metadata returned by queries must be valid.

Specified by:

setRequireValidMetadata in interface RoleDescriptorResolver

Parameters:

require - whether the metadata returned by queries must be valid

resolveSingle

@Nullable
public RoleDescriptor resolveSingle(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                       throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolveSingle in interface net.shibboleth.utilities.java.support.resolver.Resolver<RoleDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

resolve

@Nonnull
public java.lang.Iterable<RoleDescriptor> resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                                    throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolve in interface net.shibboleth.utilities.java.support.resolver.Resolver<RoleDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

getRole

@Nonnull
 @NonnullElements
protected java.util.List<RoleDescriptor> getRole(@Nullable
                                                                            java.lang.String entityID,
                                                                            @Nullable
                                                                            javax.xml.namespace.QName roleName)
                                                                     throws net.shibboleth.utilities.java.support.resolver.ResolverException

Get role descriptors for a given entityID and role.

Parameters:

entityID - entityID to lookup

roleName - role to lookup

Returns:

list of roles

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if an error occurs

doGetRole

@Nonnull
 @NonnullElements
protected java.util.List<RoleDescriptor> doGetRole(@Nullable
                                                                              java.lang.String entityID,
                                                                              @Nullable
                                                                              javax.xml.namespace.QName roleName)
                                                                       throws net.shibboleth.utilities.java.support.resolver.ResolverException

Gets the identified roles from an EntityDescriptor. This method should not check if the provider is initialized, if arguments are null, if the roles are valid, etc. All of this is done by the invoker of this method.

Parameters:

entityID - ID of the entity from which to retrieve the roles, never null

roleName - name of the roles to search for, never null

Returns:

the modifiable list of identified roles or an empty list if no roles exists

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem searching for the roles

doGetEntityDescriptor

protected EntityDescriptor doGetEntityDescriptor(java.lang.String entityID)
                                          throws net.shibboleth.utilities.java.support.resolver.ResolverException

Resolve an entity descriptor based on entityID using the wrapped metadata resolver.

Parameters:

entityID - the entityID of the EntityDescriptor to resolve.

Returns:

the resolved EntityDescriptor, or null if not found

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if there is a problem resolving the EntityDescriptor

getRole

@Nullable
protected RoleDescriptor getRole(@Nullable
                                           java.lang.String entityID,
                                           @Nullable
                                           javax.xml.namespace.QName roleName,
                                           @Nullable
                                           java.lang.String supportedProtocol)
                                    throws net.shibboleth.utilities.java.support.resolver.ResolverException

Get role descriptor for a given entityID and role and protocol.

Parameters:

entityID - entityID to lookup

roleName - role to lookup

supportedProtocol - protocol to lookup

Returns:

list of roles

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if an error occurs

doGetRole

protected RoleDescriptor doGetRole(java.lang.String entityID,
                                   javax.xml.namespace.QName roleName,
                                   java.lang.String supportedProtocol)
                            throws net.shibboleth.utilities.java.support.resolver.ResolverException

Gets the role which supports the given protocol.

Parameters:

entityID - ID of the entity from which to retrieve roles, never null

roleName - name of the role to search for, never null

supportedProtocol - protocol to search for, never null

Returns:

the role supporting the protocol or null if no such role exists

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem search for the roles

isValid

protected boolean isValid(XMLObject descriptor)

Returns whether the given descriptor is valid. If valid metadata is not required this method always returns true.

Parameters:

descriptor - the descriptor to check

Returns:

true if valid metadata is not required or the given descriptor is valid, false otherwise