Package net.shibboleth.idp.attribute.filter.policyrule.saml.impl

Class AbstractNameIDFormatExactPolicyRule

java.lang.Object
net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
net.shibboleth.utilities.java.support.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
public abstract class AbstractNameIDFormatExactPolicyRule extends AbstractPolicyRule
Checks if the attribute issuer supports the required NameID format.

  • Field Details

    • log

      @Nonnull private final org.slf4j.Logger log
      Class logger.

    • nameIdFormat

      @NonnullAfterInit @NotEmpty private String nameIdFormat
      The NameID format that needs to be supported by the entity.

  • Constructor Details

    • AbstractNameIDFormatExactPolicyRule

      public AbstractNameIDFormatExactPolicyRule()

  • Method Details

    • getNameIdFormat

      @NonnullAfterInit @NotEmpty public String 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

      public void setNameIdFormat(@Nullable String format)
      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

      protected void doInitialize() throws ComponentInitializationException
      Overrides:
      doInitialize in class AbstractPolicyRule
      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

      public PolicyRequirementRule.Tristate matches(@Nonnull AttributeFilterContext filterContext)
      Checks to see if the metadata for the entity supports the required NameID format.
      Parameters:
      filterContext - current filter context
      Returns:
      true if the entity supports the required NameID format, false otherwise whether the rule holds