org.opensaml.saml.common.binding

Class AbstractEndpointResolver<EndpointType extends Endpoint>

java.lang.Object

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

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

org.opensaml.saml.common.binding.AbstractEndpointResolver<EndpointType>

Type Parameters:

EndpointType - type of endpoint

All Implemented Interfaces:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resolver<EndpointType,CriteriaSet>, EndpointResolver<EndpointType>

Direct Known Subclasses:

DefaultEndpointResolver

public abstract class AbstractEndpointResolver<EndpointType extends Endpoint>
extends AbstractIdentifiedInitializableComponent
implements EndpointResolver<EndpointType>

Base implementation that resolves and validates protocol/profile endpoints using a combination of supplied parameters and SAML metadata.

SAML metadata rules are followed for deriving candidate endpoints to evaluate. The base class implements only a subset of required functionality, then extracts a set of candidates from metadata if present, and delegates to a subclass to actually evaluate each one for acceptability.

The supported Criterion types and their use follows:

EndpointCriterion (required)

Contains a "template" for the eventual Endpoint(s) to resolve that identifies at minimum the type of endpoint object (via schema type or element name) to resolve. It MAY contain other attributes that will be used in matching candidate endpoints for suitability, such as index, binding, location, etc. If so marked, it may also be resolved as a trusted endpoint without additional verification required.

RoleDescriptorCriterion

If present, provides access to the candidate endpoint(s) to attempt resolution against. Strictly optional, but if absent, the supplied endpoint (from EndpointCriterion) is returned as the sole result, whatever its completeness/usability, allowing for subclass validation.

Subclasses should override the {doCheckEndpoint(CriteriaSet, Endpoint) method to implement further criteria.

Constructor Summary

Constructors

Constructor and Description
AbstractEndpointResolver() Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	doCheckEndpoint(CriteriaSet criteria, EndpointType endpoint) Apply the supplied criteria to a candidate endpoint to determine its suitability.
protected String	getLogPrefix() Return a prefix for logging messages for this component.
Iterable<EndpointType>	resolve(CriteriaSet criteria) Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.
EndpointType	resolveSingle(CriteriaSet criteria) Process the specified criteria and return a single instance of the product type which satisfies the criteria.

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

Constructor Detail

AbstractEndpointResolver

public AbstractEndpointResolver()

Constructor.

Method Detail

resolve

@Nonnull
 @NonnullElements
public Iterable<EndpointType> resolve(@Nullable
                                                                 CriteriaSet criteria)
                                                          throws ResolverException

Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.

Specified by:

resolve in interface Resolver<EndpointType extends Endpoint,CriteriaSet>

Parameters:

criteria - the criteria to evaluate or process

Returns:

instances which satisfy the criteria

Throws:

ResolverException - thrown if there is an error processing the specified criteria

resolveSingle

@Nullable
public EndpointType resolveSingle(@Nullable
                                            CriteriaSet criteria)
                                     throws ResolverException

Process the specified criteria and return a single instance of the product type which satisfies the criteria. If multiple items satisfy the criteria, the choice of which single item to return is implementation-dependent.

Specified by:

resolveSingle in interface Resolver<EndpointType extends Endpoint,CriteriaSet>

Parameters:

criteria - the criteria to evaluate or process

Returns:

a single instance satisfying the criteria, or null

Throws:

ResolverException - thrown if there is an error processing the specified criteria

doCheckEndpoint

protected boolean doCheckEndpoint(@Nonnull
                                  CriteriaSet criteria,
                                  @Nonnull
                                  EndpointType endpoint)

Apply the supplied criteria to a candidate endpoint to determine its suitability.

Parameters:

criteria - input criteria set

endpoint - candidate endpoint

Returns:

true iff the endpoint meets the supplied criteria

getLogPrefix

@Nonnull
protected String getLogPrefix()

Return a prefix for logging messages for this component.

Returns:

a string for insertion at the beginning of any log messages