Class SAML2NameIDAttributeDefinition

All Implemented Interfaces:
AttributeDefinition, ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, DisposableBean

@Deprecated(forRemoval=true,
            since="4.1.0")
public class SAML2NameIDAttributeDefinition
extends AbstractAttributeDefinition
Deprecated, for removal: This API element is subject to removal in a future version.
An attribute definition that creates attributes whose values are NameID.

When building the NameID the textual content of the NameID is the value of the source attribute. If a getNameIdQualifier() is non-null, then that value is used as the NameID's NameQualifier otherwise the attribute issuer's entityID is used. If getNameIdSPQualifier() is non-null, then that valid is used as the NameID's SPNameQualifier, otherwise the attribute recipient's entityID is used.

  • Field Details

    • log

      @Nonnull private final org.slf4j.Logger log
      Deprecated, for removal: This API element is subject to removal in a future version.
      Class logger.
    • nameIDBuilder

      @Nonnull private final SAMLObjectBuilder<NameID> nameIDBuilder
      Deprecated, for removal: This API element is subject to removal in a future version.
      The builder for the object represented inside this attribute.
    • nameIdFormat

      private String nameIdFormat
      Deprecated, for removal: This API element is subject to removal in a future version.
      Format of the NameID.
    • nameIdQualifier

      private String nameIdQualifier
      Deprecated, for removal: This API element is subject to removal in a future version.
      Name qualifier for the NameID.
    • nameIdSPQualifier

      private String nameIdSPQualifier
      Deprecated, for removal: This API element is subject to removal in a future version.
      SP name qualifier for the NameID.
  • Constructor Details

    • SAML2NameIDAttributeDefinition

      public SAML2NameIDAttributeDefinition()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.
  • Method Details

    • getNameIdFormat

      @Nullable public String getNameIdFormat()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the format for the NameID used as an attribute value.
      Returns:
      format for the NameID used as an attribute value
    • setNameIdFormat

      public void setNameIdFormat​(@Nullable String format)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the format for the NameID used as an attribute value.
      Parameters:
      format - format for the NameID used as an attribute value
    • getNameIdQualifier

      @Nullable public String getNameIdQualifier()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the NameQualifier for the NameID used as an attribute value.
      Returns:
      NameQualifier for the NameID used as an attribute value
    • setNameIdQualifier

      public void setNameIdQualifier​(@Nullable String qualifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the NameQualifier for the NameID used as an attribute value.
      Parameters:
      qualifier - NameQualifier for the NameID used as an attribute value
    • getNameIdSPQualifier

      @Nullable public String getNameIdSPQualifier()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the SPNameQualifier for the NameID used as an attribute value.
      Returns:
      SPNameQualifier for the NameID used as an attribute value
    • setNameIdSPQualifier

      public void setNameIdSPQualifier​(@Nullable String qualifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the SPNameQualifier for the NameID used as an attribute value.
      Parameters:
      qualifier - SPNameQualifier for the NameID used as an attribute value
    • buildNameId

      protected NameID buildNameId​(@Nonnull @NotEmpty String nameIdValue, @Nonnull AttributeResolutionContext resolutionContext) throws ResolutionException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Builds a name ID. The provided value is the textual content of the NameID. The NameQualifier and SPNameQualifier are set according to the configuration, or to the local and requesting entityIDs respectively.
      Parameters:
      nameIdValue - value of the NameID
      resolutionContext - current resolution context
      Returns:
      the constructed NameID
      Throws:
      ResolutionException - if the IdP Name is empty.
    • encodeOneValue

      @Nullable private XMLObjectAttributeValue encodeOneValue​(@Nonnull IdPAttributeValue theValue, @Nonnull AttributeResolutionContext resolutionContext) throws ResolutionException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Worker function for doAttributeDefintionResolve. This returns an AttributeValue if the input value is appropriate for encoding as a NameID.
      Parameters:
      theValue - an arbitrary value.
      resolutionContext - the context to get the rest of the values from
      Returns:
      null or an attributeValue.
      Throws:
      ResolutionException - if the IdP Name is empty.
    • doAttributeDefinitionResolve

      @Nullable protected IdPAttribute doAttributeDefinitionResolve​(@Nonnull AttributeResolutionContext resolutionContext, @Nonnull AttributeResolverWorkContext workContext) throws ResolutionException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates and populates the values for the resolved attribute. Implementations should not set, or otherwise manage, the resolved attribute's display name, description or encoders. Nor should the resultant attribute be recorded in the given resolution context.
      Specified by:
      doAttributeDefinitionResolve in class AbstractAttributeDefinition
      Parameters:
      resolutionContext - current attribute resolution context
      workContext - current resolver work context
      Returns:
      resolved attribute or null if nothing to resolve.
      Throws:
      ResolutionException - thrown if there is a problem resolving and creating the attribute