|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractMatchFunctor
edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.saml.AbstractEntityAttributeMatchFunctor
public abstract class AbstractEntityAttributeMatchFunctor
Base class for match functions that check whether a particular entity attribute is present and contains a given value.
Constructor Summary | |
---|---|
AbstractEntityAttributeMatchFunctor()
|
Method Summary | |
---|---|
protected boolean |
doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
Evaluates this matching criteria. |
protected boolean |
doEvaluateValue(ShibbolethFilteringContext filterContext,
String attributeId,
Object attributeValue)
Evaluates this matching criteria. |
protected abstract boolean |
entityAttributeValueMatches(String entityAttributeValue)
Checks whether the given entity attribute value matches the rules for particular implementation of this functor. |
protected org.opensaml.saml2.core.Attribute |
getEntityAttribute(org.opensaml.saml2.metadata.EntityDescriptor entityDescriptor)
Gets the entity attribute from the given entity metadata. |
protected abstract org.opensaml.saml2.metadata.EntityDescriptor |
getEntityMetadata(ShibbolethFilteringContext filterContext)
Gets the entity descriptor for the entity to check. |
String |
getName()
Gets the name of the entity attribute the entity must have. |
String |
getNameFormat()
Gets the name format of the entity attribute the entity must have. |
protected boolean |
hasEntityAttribute(ShibbolethFilteringContext filterContext)
Checks to see if the entity returned by getEntityMetadata(ShibbolethFilteringContext) contains the
entity attribute specified by this functor's configuration. |
void |
setName(String attributeName)
Sets the name of the entity attribute the entity must have. |
void |
setNameFormat(String attributeNameFormat)
Sets the name format of the entity attribute the entity must have. |
Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractMatchFunctor |
---|
evaluateDenyRule, evaluatePermitValue, evaluatePolicyRequirement |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractEntityAttributeMatchFunctor()
Method Detail |
---|
public String getName()
public void setName(String attributeName)
attributeName
- name of the entity attribute the entity must havepublic String getNameFormat()
public void setNameFormat(String attributeNameFormat)
attributeNameFormat
- name format of the entity attribute the entity must haveprotected boolean doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext) throws FilterProcessingException
doEvaluatePolicyRequirement
in class AbstractMatchFunctor
filterContext
- current filtering context
FilterProcessingException
- thrown if the function can not be evaluatedprotected boolean doEvaluateValue(ShibbolethFilteringContext filterContext, String attributeId, Object attributeValue) throws FilterProcessingException
doEvaluateValue
in class AbstractMatchFunctor
filterContext
- the current filtering contextattributeId
- ID of the attribute being evaluatedattributeValue
- value of the attribute being evaluated
FilterProcessingException
- thrown if the function can not be evaluatedprotected boolean hasEntityAttribute(ShibbolethFilteringContext filterContext)
getEntityMetadata(ShibbolethFilteringContext)
contains the
entity attribute specified by this functor's configuration.
filterContext
- current request context
protected abstract org.opensaml.saml2.metadata.EntityDescriptor getEntityMetadata(ShibbolethFilteringContext filterContext)
filterContext
- current filter request context
protected org.opensaml.saml2.core.Attribute getEntityAttribute(org.opensaml.saml2.metadata.EntityDescriptor entityDescriptor)
entityDescriptor
- the metadata for the entity
protected abstract boolean entityAttributeValueMatches(String entityAttributeValue)
entityAttributeValue
- the entity attribute value, never null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |