Package com.sun.identity.saml2.protocol

Interface StatusDetail

  • All Known Implementing Classes:
    StatusDetailImpl
    public interface StatusDetail
    This class represents the StatusDetailType complex type in SAML protocol schema. The StatusDetail element MAY be used to specify additional information concerning the status of the request. 
     <complexType name="StatusDetailType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List getAny()
      Returns the value of the Any property.
      boolean isMutable()
      Returns true if the object is mutable false otherwise
      void makeImmutable()
      Makes the obejct immutable
      void setAny​(List anyList)
      Sets the value of the Any property.
      String toXMLString()
      Returns the StatusDetail in an XML document String format based on the StatusDetail schema described above.
      String toXMLString​(boolean includeNSPrefix, boolean declareNS)
      Returns the StatusDetail in an XML document String format based on the StatusDetail schema described above.

    • Method Detail

      • getAny

        List getAny()
        Returns the value of the Any property.
        Returns:
        A list containing objects of type String
        See Also:
        setAny(List)

      • setAny

        void setAny​(List anyList)
     throws SAML2Exception
        Sets the value of the Any property.
        Parameters:
        anyList - A list containing objects of type String
        Throws:
        SAML2Exception - if the object is immutable
        See Also:
        getAny()

      • toXMLString

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

      • toXMLString

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

      • makeImmutable

        void makeImmutable()
        Makes the obejct immutable

      • isMutable

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