Interface NameIDType

  • All Known Subinterfaces:
    Issuer, NameID

    @SupportedAll
    public interface NameIDType
    The NameIDType is used when an element serves to represent an entity by a string-valued name. In addition to the string content containing the actual identifier, it provides the following optional attributes: NameQualifier SPNameQualifier Format SPProvidedID
    • Method Detail

      • getValue

        String getValue()
        Returns the string-valued identifier
        Returns:
        the string-valued identifier
      • setValue

        void setValue​(String value)
               throws SAML2Exception
        Sets the string-valued identifier
        Parameters:
        value - the string-valued identifier
        Throws:
        SAML2Exception - if the object is immutable
      • getNameQualifier

        String getNameQualifier()
        Returns the name qualifier
        Returns:
        the name qualifier
      • setNameQualifier

        void setNameQualifier​(String value)
                       throws SAML2Exception
        Sets the name qualifier
        Parameters:
        value - the name qualifier
        Throws:
        SAML2Exception - if the object is immutable
      • getSPProvidedID

        String getSPProvidedID()
        Returns the SP provided ID
        Returns:
        the SP provided ID
      • setSPProvidedID

        void setSPProvidedID​(String value)
                      throws SAML2Exception
        Sets the SP provided ID
        Parameters:
        value - the SP provided ID
        Throws:
        SAML2Exception - if the object is immutable
      • getSPNameQualifier

        String getSPNameQualifier()
        Returns the SP name qualifier
        Returns:
        the SP name qualifier
      • setSPNameQualifier

        void setSPNameQualifier​(String value)
                         throws SAML2Exception
        Sets the SP name qualifier
        Parameters:
        value - the SP name qualifier
        Throws:
        SAML2Exception - if the object is immutable
      • getFormat

        String getFormat()
        Returns the format
        Returns:
        the format
      • toXMLString

        String toXMLString​(boolean includeNSPrefix,
                           boolean declareNS)
                    throws SAML2Exception
        Returns a String representation
        Parameters:
        includeNSPrefix - 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 representation
        Throws:
        SAML2Exception - if something is wrong during conversion
      • toXMLString

        String toXMLString()
                    throws SAML2Exception
        Returns a String representation
        Returns:
        A String representation
        Throws:
        SAML2Exception - if something is wrong during conversion
      • makeImmutable

        void makeImmutable()
        Makes the object immutable
      • isMutable

        boolean isMutable()
        Returns true if the object is mutable
        Returns:
        true if the object is mutable