Interface StatusMessage


  • @SupportedAll
    public interface StatusMessage
    This class represents the StatusMessage element in SAML protocol schema. The StatusMessage element specifies a message that MAY be returned to an operator.
     <element name="StatusMessage" type="{http://www.w3.org/2001/XMLSchema}string"/>
     
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getValue()
      Returns the StatusMessage value.
      String toXMLString()
      Returns the StatusMessage in an XML document String format based on the StatusMessage schema described above.
      String toXMLString​(boolean includeNSPrefix, boolean declareNS)
      Returns the StatusMessage in an XML document String format based on the StatusMessage schema described above.
    • Method Detail

      • getValue

        String getValue()
        Returns the StatusMessage value.
        Returns:
        A String value of the StatusMessage
      • toXMLString

        String toXMLString()
                    throws SAML2Exception
        Returns the StatusMessage in an XML document String format based on the StatusMessage schema described above.
        Returns:
        An XML String representing the StatusMessage.
        Throws:
        SAML2Exception - if some error occurs during conversion to String.
      • toXMLString

        String toXMLString​(boolean includeNSPrefix,
                           boolean declareNS)
                    throws SAML2Exception
        Returns the StatusMessage in an XML document String format based on the StatusMessage schema described above.
        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 XML String representing the StatusMessage.
        Throws:
        SAML2Exception - if some error occurs during conversion to String.