Package com.sun.identity.saml.assertion

Class NameIdentifier

java.lang.Object
com.sun.identity.saml.assertion.NameIdentifier
@SupportedAll public class NameIdentifier extends Object
The NameIdentifier element specifies a Subject by a combination of a name and a security domain governing the name of the Subject.

  • Constructor Details

    • NameIdentifier

      protected NameIdentifier()
      Default contructor

    • NameIdentifier

      public NameIdentifier(Element nameIdentifierElement) throws SAMLException
      Constructs a NameIdentifer element from an existing XML block.
      Parameters:
      nameIdentifierElement - A org.w3c.dom.Element representing DOM tree for NameIdentifier object
      Throws:
      SAMLException - if it could not process the org.w3c.dom.Element properly, implying that there is an error in the sender or in the element definition.

    • NameIdentifier

      public NameIdentifier(String name) throws SAMLException
      Constructor
      Parameters:
      name - - The string representing the name of the Subject
      Throws:
      SAMLException - if the input has an error.

    • NameIdentifier

      public NameIdentifier(String name, String nameQualifier) throws SAMLException
      Constructs a NameQualifier instance.
      Parameters:
      name - The string representing the name of the Subject
      nameQualifier - The security or administrative domain that qualifies the name of the Subject. This is optional, could be null or "".
      Throws:
      SAMLException - if the input has an error.

    • NameIdentifier

      public NameIdentifier(String name, String nameQualifier, String format) throws SAMLException
      Constructs a NameQualifier instance.
      Parameters:
      name - The string representing the name of the Subject
      nameQualifier - The security or administrative domain that qualifies the name of the Subject. This is optional could be null or "".
      format - The syntax used to describe the name of the Subject. This optional, could be null or "".
      Throws:
      SAMLException - if the input has an error.

  • Method Details

    • getFormat

      public String getFormat()
      Returns format.
      Returns:
      format element. Returns null if there is no format specified.

    • setFormat

      public boolean setFormat(String format)
      Sets the format attribute.
      Parameters:
      format - A String representing the format.
      Returns:
      true if operation succeeds.

    • getNameQualifier

      public String getNameQualifier()
      Returns the name.
      Returns:
      A String representing the nameQualifier. Returns null if there is no nameQualifier.

    • setNameQualifier

      public boolean setNameQualifier(String nameQualifier)
      Sets nameQualifier attribute.
      Parameters:
      nameQualifier - name qualifier.
      Returns:
      true if operation succeeds.

    • setName

      protected boolean setName(String name)
      Sets the name attribute.
      Parameters:
      name - name of the nameQualifier.
      Returns:
      true if operation succeeds.

    • getName

      public String getName()
      Returns the name from NameQualifier.
      Returns:
      name

    • toString

      public String toString()
      Returns a String representation of the element.
      Overrides:
      toString in class Object
      Returns:
      A string containing the valid XML for this element By default name space name is prepended to the element name example <saml:NameIdentifier>.

    • toString

      public String toString(boolean includeNS, boolean declareNS)
      Returns String representation of the <NameIdentifier> element.
      Parameters:
      includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted.
      declareNS - Determines whether or not the namespace is declared within the Element.
      Returns:
      A string containing the valid XML for this element

    • equals

      public boolean equals(NameIdentifier nid)
      Checks for equality between this object and the NameQualifier passed down as parameter. Checks if Name is equal and if it has NameQualifier and Format defined checks for equality in those too.
      Parameters:
      nid - NameIdentifier to be checked
      Returns:
      true if the two NameQualifier are equal or not