Package org.opensaml.saml.metadata.resolver.filter.impl

Class NameIDFormatFilter

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
org.opensaml.saml.metadata.resolver.filter.AbstractMetadataFilter
org.opensaml.saml.metadata.resolver.filter.impl.NameIDFormatFilter
All Implemented Interfaces:
Component, DestructableComponent, InitializableComponent, MetadataFilter
public class NameIDFormatFilter extends AbstractMetadataFilter
A filter that adds NameIDFormat content to entities in order to drive software behavior based on them. The entities to annotate are identified with a Predicate, and multiple formats can be associated with each.

  • Field Details

    • log

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

    • removeExistingFormats

      private boolean removeExistingFormats
      Whether to strip any existing Formats when adding new ones.

    • applyMap

      @Nonnull private Multimap<Predicate<EntityDescriptor>,String> applyMap
      Rules for adding formats.

    • formatBuilder

      @Nonnull private final SAMLObjectBuilder<NameIDFormat> formatBuilder
      Builder for NameIDFormat.

  • Constructor Details

    • NameIDFormatFilter

      public NameIDFormatFilter()
      Constructor.

  • Method Details

    • setRemoveExistingFormats

      public void setRemoveExistingFormats(boolean flag)
      Set whether the filter should remove any existing formats from an entity to which it adds new ones.

      Defaults to false (for compatibility).

      Parameters:
      flag - flag to set

    • setRules

      public void setRules(@Nonnull Map<Predicate<EntityDescriptor>,Collection<String>> rules)
      Set the mappings from Predicate to format collection to apply.
      Parameters:
      rules - rules to apply

    • filter

      @Nullable public XMLObject filter(@Nullable XMLObject metadata, @Nonnull MetadataFilterContext context) throws FilterException
      Filters the given metadata, perhaps to remove elements that are not wanted.
      Parameters:
      metadata - the metadata to be filtered.
      context - the metadata filter context
      Returns:
      the filtered XMLObject, which may or may not be the same as the XMLObject instance passed in to the method. Maybe be null, for example if the top-level element was removed by the filter.
      Throws:
      FilterException - thrown if an error occurs during the filtering process

    • filterEntityDescriptor

      protected void filterEntityDescriptor(@Nonnull EntityDescriptor descriptor)
      Filters entity descriptor.
      Parameters:
      descriptor - entity descriptor to filter

    • filterRoleDescriptor

      protected void filterRoleDescriptor(@Nonnull RoleDescriptor role, @Nonnull Collection<String> formats)
      Filters role descriptor.
      Parameters:
      role - role to modify
      formats - formats to attach

    • filterEntitiesDescriptor

      protected void filterEntitiesDescriptor(@Nonnull EntitiesDescriptor descriptor)
      Filters entities descriptor.
      Parameters:
      descriptor - entities descriptor to filter