Class UserMappingProperties.FieldMapping

java.lang.Object
com.broadleafcommerce.auth.user.service.autoconfigure.UserMappingProperties.FieldMapping
Enclosing class:
UserMappingProperties

public static class UserMappingProperties.FieldMapping extends Object
  • Constructor Details

    • FieldMapping

      public FieldMapping()
  • Method Details

    • getAttributeName

      public String getAttributeName()
      The attribute name where this field's value should be stored in User.getAttributes().
    • getValuePath

      public String getValuePath()
      The JsonPath on the Customer or AdminUser to retrieve the value(s) which should be stored in that attribute.
    • isIncludeAsTokenClaim

      public boolean isIncludeAsTokenClaim()
      Whether to also include the attribute as a claim on the token. attributeName will be converted to snake case (phoneNumber -> phone_number) if it is not already when added as a claim.

      Note, this will only work if the value is a String, other objects cannot be used as claims.

    • setAttributeName

      public void setAttributeName(String attributeName)
      The attribute name where this field's value should be stored in User.getAttributes().
    • setValuePath

      public void setValuePath(String valuePath)
      The JsonPath on the Customer or AdminUser to retrieve the value(s) which should be stored in that attribute.
    • setIncludeAsTokenClaim

      public void setIncludeAsTokenClaim(boolean includeAsTokenClaim)
      Whether to also include the attribute as a claim on the token. attributeName will be converted to snake case (phoneNumber -> phone_number) if it is not already when added as a claim.

      Note, this will only work if the value is a String, other objects cannot be used as claims.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object