Package se.curity.identityserver.sdk.attribute.scim.v2

Class Name

Object
se.curity.identityserver.sdk.attribute.MapAttributeValue
se.curity.identityserver.sdk.attribute.scim.v2.Name
All Implemented Interfaces:
Iterable<Attribute>, AttributeContainer<MapAttributeValue>, AttributeOrAttributeValue<AttributeValue>, AttributeValue
public final class Name extends MapAttributeValue
The name attribute of the SCIM core schema.

  • Field Details

  • Method Details

    • of

      public static Name of(MapAttributeValue attributeValue)

    • of

      public static Name of(String formatted)
      Create a name object with the formatted string set.
      Parameters:
      formatted - the string to use as the formatted name
      Returns:
      Name

    • of

      public static Name of(Iterable<Attribute> attributes)
      Create a name object from a list of attributes.
      Parameters:
      attributes - to create from. Should contain Attribute like GIVEN_NAME, FAMILY_NAME and such
      Returns:
      Name

    • of

      public static Name of(String givenName, String familyName)
      Create a name object from given and family name.
      Parameters:
      givenName - the given name
      familyName - the family name
      Returns:
      Name object

    • getHonorificSuffix

      @Nullable public @Nullable String getHonorificSuffix()
      The honorific suffix(es) of the User, or suffix in most Western languages.

      Example: "III" given the full name "Ms. Barbara Jane Jensen, III".

      Returns:
      honorificSuffix, or null if not found

    • getHonorificPrefix

      @Nullable public @Nullable String getHonorificPrefix()
      The honorific prefix(es) of the User, or title in most Western languages.

      Example: "Ms." given the full name "Ms. Barbara Jane Jensen, III".

      Returns:
      honorificPrefix, or null if not found

    • getMiddleName

      @Nullable public @Nullable String getMiddleName()
      The middle name(s) of the User.

      Example: "Jane" given the full name "Ms. Barbara Jane Jensen, III".

      Returns:
      middleName, or null if not found

    • getGivenName

      @Nullable public @Nullable String getGivenName()
      The given name of the User, or first name in most Western languages.

      Exmple: "Barbara" given the full name "Ms. Barbara Jane Jensen, III".

      Returns:
      givenName, or null if not found

    • getFamilyName

      @Nullable public @Nullable String getFamilyName()
      The family name of the User, or last name in most Western languages.

      Example: "Jensen" given the full name "Ms. Barbara Jane Jensen, III".

      Returns:
      familyName, or null if not found

    • getFormatted

      @Nullable public @Nullable String getFormatted()
      The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

      Example: "Ms. Barbara Jane Jensen, III"

      Returns:
      formatted, default attribute if not set. Returns empty string if no values are set.

    • withFamilyName

      public Name withFamilyName(String familyName)
      Create copy of the name, with the familyName set.
      Parameters:
      familyName - to set
      Returns:
      copied Name object
      See Also:

    • withGivenName

      public Name withGivenName(String givenName)
      Create copy of the name, with the givenName set.
      Parameters:
      givenName - to set
      Returns:
      copied Name object
      See Also:

    • withMiddleName

      public Name withMiddleName(String middleName)
      Create copy of the name, with the middleName set.
      Parameters:
      middleName - to set
      Returns:
      copied Name object
      See Also:

    • withHonorificPrefix

      public Name withHonorificPrefix(String honorificPrefix)
      Create copy of the name, with the honorificPrefix set.
      Parameters:
      honorificPrefix - to set
      Returns:
      copied Name object
      See Also:

    • withHonorificSuffix

      public Name withHonorificSuffix(String honorificSuffix)
      Create copy of the name, with the honorificSuffix set.
      Parameters:
      honorificSuffix - to set
      Returns:
      copied Name object
      See Also: