Package net.shibboleth.idp.saml.relyingparty.impl

Class RelyingPartyConfigurationSupport

java.lang.Object

net.shibboleth.idp.saml.relyingparty.impl.RelyingPartyConfigurationSupport

public final class RelyingPartyConfigurationSupport
extends Object

Support functions for building RelyingPartyConfiguration objects with SAML functionality.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RelyingPartyConfigurationSupport()	Constructor.

Method Summary

Modifier and Type	Method	Description
static RelyingPartyConfiguration	byGroup(Collection<String> groupNames, MetadataResolver resolver)	A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on one or more EntitiesDescriptor groups, and optionally via AffiliationDescriptor lookup.
static RelyingPartyConfiguration	byMappedTag(Collection<EntityAttributesPredicate.Candidate> candidates, boolean trim, boolean matchAll)	A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on a MappedEntityAttributesPredicate.
static RelyingPartyConfiguration	byName(Collection<String> relyingPartyIds)	A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on one or more relying party IDs.
static RelyingPartyConfiguration	byTag(Collection<EntityAttributesPredicate.Candidate> candidates, boolean trim, boolean matchAll)	A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on an EntityAttributesPredicate.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelyingPartyConfigurationSupport

private RelyingPartyConfigurationSupport()

Constructor.

Method Detail

byName

@Nonnull
public static RelyingPartyConfiguration byName(@Nonnull @NonnullElements
                                               Collection<String> relyingPartyIds)

A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on one or more relying party IDs.

If a single ID is supplied, then the ID is also set as the identifier for the configuration.

Parameters:

relyingPartyIds - the relying parties for which the configuration should be active

Returns:

a default-constructed configuration with the appropriate condition set

byGroup

@Nonnull
public static RelyingPartyConfiguration byGroup(@Nonnull @NonnullElements
                                                Collection<String> groupNames,
                                                @Nullable
                                                MetadataResolver resolver)

A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on one or more EntitiesDescriptor groups, and optionally via AffiliationDescriptor lookup.

Parameters:

groupNames - the group names

resolver - optional metadata source for affiliation lookup

Returns:

a default-constructed configuration with the appropriate condition set

byTag

@Nonnull
public static RelyingPartyConfiguration byTag(@Nonnull @NonnullElements
                                              Collection<EntityAttributesPredicate.Candidate> candidates,
                                              boolean trim,
                                              boolean matchAll)

A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on an EntityAttributesPredicate.

Parameters:

candidates - the candidate rules

trim - true iff tag values in metadata should be trimmed before comparison

matchAll - true iff all the candidate rules are required to match

Returns:

a default-constructed configuration with the appropriate condition set

byMappedTag

@Nonnull
public static RelyingPartyConfiguration byMappedTag(@Nonnull @NonnullElements
                                                    Collection<EntityAttributesPredicate.Candidate> candidates,
                                                    boolean trim,
                                                    boolean matchAll)

A shorthand method for constructing a RelyingPartyConfiguration with an activation condition based on a MappedEntityAttributesPredicate.

Parameters:

candidates - the candidate rules

trim - true iff tag values in metadata should be trimmed before comparison

matchAll - true iff all the candidate rules are required to match

Returns:

a default-constructed configuration with the appropriate condition set