org.opensaml.saml.common.profile.logic

Class EntityAttributesPredicate

java.lang.Object

org.opensaml.saml.common.profile.logic.EntityAttributesPredicate

All Implemented Interfaces:

Predicate<EntityDescriptor>

public class EntityAttributesPredicate
extends Object
implements Predicate<EntityDescriptor>

Predicate to determine whether an EntityDescriptor or its parent groups contain an extension Attribute that matches the predicate's criteria.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityAttributesPredicate.Candidate An object to encapsulate the set of criteria that must be satisfied by an EntityAttributes extension to satisfy the enclosing predicate.
private class	EntityAttributesPredicate.EntityAttributesMatcher Determines whether an EntityAttributesPredicate.Candidate criterion is satisfied by the Attributes in an EntityAttributes extension.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<EntityAttributesPredicate.Candidate>	candidateSet Candidates to check for.
private Logger	log Class logger.
private boolean	matchAll Whether all the candidates must match.
private boolean	trimTags Whether to trim the values in the metadata before comparison.

Constructor Summary

Constructors

Constructor and Description
EntityAttributesPredicate(Collection<EntityAttributesPredicate.Candidate> candidates) Constructor.
EntityAttributesPredicate(Collection<EntityAttributesPredicate.Candidate> candidates, boolean trim) Constructor.
EntityAttributesPredicate(Collection<EntityAttributesPredicate.Candidate> candidates, boolean trim, boolean all) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(EntityDescriptor input)
Collection<EntityAttributesPredicate.Candidate>	getCandidates() Get the candidate criteria.
boolean	getTrimTags() Get whether to trim tags for comparison.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Predicate

equals

Field Detail

log

@Nonnull
private final Logger log

Class logger.

trimTags

private final boolean trimTags

Whether to trim the values in the metadata before comparison.

matchAll

private final boolean matchAll

Whether all the candidates must match.

candidateSet

@Nonnull
@NonnullElements
private final Collection<EntityAttributesPredicate.Candidate> candidateSet

Candidates to check for.

Constructor Detail

EntityAttributesPredicate

public EntityAttributesPredicate(@Nonnull@NonnullElements
                         Collection<EntityAttributesPredicate.Candidate> candidates)

Constructor.

Parameters:

candidates - the EntityAttributesPredicate.Candidate criteria to check for

EntityAttributesPredicate

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

Constructor.

Parameters:

candidates - the EntityAttributesPredicate.Candidate criteria to check for

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

EntityAttributesPredicate

public EntityAttributesPredicate(@Nonnull@NonnullElements
                         Collection<EntityAttributesPredicate.Candidate> candidates,
                         boolean trim,
                         boolean all)

Constructor.

Parameters:

candidates - the EntityAttributesPredicate.Candidate criteria to check for

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

all - true iff all the criteria must match to be a successful test

Method Detail

getTrimTags

public boolean getTrimTags()

Get whether to trim tags for comparison.

Returns:

true iff tags are to be trimmed for comparison

getCandidates

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Collection<EntityAttributesPredicate.Candidate> getCandidates()

Get the candidate criteria.

Returns:

the candidate criteria

apply

public boolean apply(@Nullable
            EntityDescriptor input)

Specified by:

apply in interface Predicate<EntityDescriptor>