Package org.opensaml.saml.metadata.resolver.index.impl

Class EndpointMetadataIndex

java.lang.Object

org.opensaml.saml.metadata.resolver.index.impl.EndpointMetadataIndex

All Implemented Interfaces:

org.opensaml.saml.metadata.resolver.index.MetadataIndex

public class EndpointMetadataIndex
extends Object
implements org.opensaml.saml.metadata.resolver.index.MetadataIndex

An implementation of MetadataIndex which indexes entities by their role endpoint locations.

The indexed endpoint location keys are scoped by the containing RoleDescriptor type, Endpoint type, and whether or not the endpoint value was a standard location (Endpoint.getLocation()) or a response location (Endpoint.getResponseLocation()).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndpointMetadataIndex.DefaultEndpointSelectionPredicate	The default endpoint selection predicate, which evaluates an Endpoint using a map of QName endpoint types, indexed by role type.
protected static class	EndpointMetadataIndex.EndpointMetadataIndexKey	An implementation of MetadataIndexKey representing a single SAML metadata endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<org.opensaml.saml.saml2.metadata.Endpoint>	endpointSelectionPredicate	The predicate which selects which endpoints to index.
private Logger	log	Logger.

Constructor Summary

Constructors

Constructor	Description
EndpointMetadataIndex()	Constructor.
EndpointMetadataIndex(Predicate<org.opensaml.saml.saml2.metadata.Endpoint> endpointPredicate)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>	generateKeys(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>	generateKeys(org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)
private Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>	processCriteria(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet, QName roleType, org.opensaml.saml.saml2.metadata.Endpoint endpoint)	Process the specified role and endpoint.
private Set<String>	processLocation(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet, String location)	Process the specified location.

Methods inherited from class java.lang.Object

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

Field Detail

log

private Logger log

Logger.

endpointSelectionPredicate

@Nonnull
private Predicate<org.opensaml.saml.saml2.metadata.Endpoint> endpointSelectionPredicate

The predicate which selects which endpoints to index.

Constructor Detail

EndpointMetadataIndex

public EndpointMetadataIndex()

Constructor.

All entity descriptor endpoints will be indexed.

EndpointMetadataIndex

public EndpointMetadataIndex(@Nonnull @ParameterName(name="endpointPredicate")
                             Predicate<org.opensaml.saml.saml2.metadata.Endpoint> endpointPredicate)

Constructor.

Parameters:

endpointPredicate - the predicate which selects which endpoints to index

Method Detail

generateKeys

@Nullable
@NonnullElements
@Unmodifiable
@NotLive
public Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey> generateKeys(@Nonnull
                                                                                    org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)

Specified by:

generateKeys in interface org.opensaml.saml.metadata.resolver.index.MetadataIndex

generateKeys

@Nullable
@NonnullElements
@Unmodifiable
@NotLive
public Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey> generateKeys(@Nonnull
                                                                                    net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)

Specified by:

generateKeys in interface org.opensaml.saml.metadata.resolver.index.MetadataIndex

processCriteria

@Nonnull
private Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey> processCriteria(@Nonnull
                                                                                        net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet,
                                                                                        @Nonnull
                                                                                        QName roleType,
                                                                                        @Nonnull
                                                                                        org.opensaml.saml.saml2.metadata.Endpoint endpoint)

Process the specified role and endpoint.

Parameters:

criteriaSet - the criteria being processed

roleType - the type of role containing the endpoint

endpoint - the endpoint to process

Returns:

the set of metadata index keys for the endpoint

processLocation

@Nonnull
private Set<String> processLocation(@Nonnull
                                    net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet,
                                    @Nonnull
                                    String location)

Process the specified location.

Parameters:

criteriaSet - the criteria being processed

location - the location to process

Returns:

the variants of the location to be indexed