Class AbstractNameIDFormatExactPolicyRule
java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.idp.attribute.filter.policyrule.impl.AbstractPolicyRule
net.shibboleth.idp.attribute.filter.policyrule.saml.impl.AbstractNameIDFormatExactPolicyRule
- All Implemented Interfaces:
PolicyRequirementRule,Component,DestructableComponent,IdentifiableComponent,IdentifiedComponent,InitializableComponent
- Direct Known Subclasses:
IssuerNameIDFormatExactPolicyRule,RequesterNameIDFormatExactPolicyRule
Checks if the attribute issuer supports the required NameID format.
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule
PolicyRequirementRule.Tristate -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final org.slf4j.LoggerClass logger.private StringThe NameID format that needs to be supported by the entity.Fields inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule
MATCHES_ALL, MATCHES_NONE, REQUIREMENT_RULE_FAILS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidprotected abstract SSODescriptorgetEntitySSODescriptor(AttributeFilterContext filterContext) Gets the SSO role descriptor for the entity to be checked.Get the NameID format that needs to be supported by the entity.matches(AttributeFilterContext filterContext) Evaluate what this rule means.voidsetNameIdFormat(String format) Sets the NameID format that needs to be supported by the entity.Methods inherited from class net.shibboleth.idp.attribute.filter.policyrule.impl.AbstractPolicyRule
getLogPrefixMethods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
setIdMethods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentExceptionMethods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent
checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitializedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.shibboleth.shared.component.IdentifiedComponent
getId
-
Field Details
-
log
@Nonnull private final org.slf4j.Logger logClass logger. -
nameIdFormat
The NameID format that needs to be supported by the entity.
-
-
Constructor Details
-
AbstractNameIDFormatExactPolicyRule
public AbstractNameIDFormatExactPolicyRule()
-
-
Method Details
-
getNameIdFormat
Get the NameID format that needs to be supported by the entity.- Returns:
- NameID format that needs to be supported by the entity
-
setNameIdFormat
Sets the NameID format that needs to be supported by the entity.- Parameters:
format- NameID format that needs to be supported by the entity
-
doInitialize
- Overrides:
doInitializein classAbstractPolicyRule- Throws:
ComponentInitializationException
-
getEntitySSODescriptor
@Nullable protected abstract SSODescriptor getEntitySSODescriptor(@Nonnull AttributeFilterContext filterContext) Gets the SSO role descriptor for the entity to be checked.- Parameters:
filterContext- current filtering context- Returns:
- the SSO role descriptor of the entity or null if the entity does not have such a descriptor
-
matches
@Nonnull public PolicyRequirementRule.Tristate matches(@Nonnull AttributeFilterContext filterContext) Evaluate what this rule means.- Parameters:
filterContext- the context.- Returns:
- whether the rule holds
-