Package com.sun.identity.saml2.protocol

Interface StatusResponse

All Superinterfaces:
XmlSerializable
All Known Subinterfaces:
ArtifactResponse, LogoutResponse, ManageNameIDResponse, NameIDMappingResponse, Response
@SupportedAll public interface StatusResponse extends XmlSerializable
This class represents the StatusResponseType complex type in SAML protocol schema. All SAML responses are of types that are derived from the StatusResponseType complex type. This type defines common attributes and elements that are associated with all SAML responses. 
 <complexType name="StatusResponseType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Issuer" minOccurs="0"/>
         <element ref="{http://www.w3.org/2000/09/xmldsig#}Signature" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Extensions" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Status"/>
       </sequence>
       <attribute name="Consent" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="Destination" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="ID" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
       <attribute name="InResponseTo" type="{http://www.w3.org/2001/XMLSchema}NCName" />
       <attribute name="IssueInstant" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="Version" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

  • Method Details

    • getVersion

      String getVersion()
      Returns the value of the version property.
      Returns:
      the value of the version property
      See Also:

    • setVersion

      void setVersion(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the version property.
      Parameters:
      value - the value of the version property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getIssueInstant

      Date getIssueInstant()
      Returns the value of the issueInstant property.
      Returns:
      the value of the issueInstant property
      See Also:

    • setIssueInstant

      void setIssueInstant(Date value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the issueInstant property.
      Parameters:
      value - the value of the issueInstant property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getDestination

      String getDestination()
      Returns the value of the destination property.
      Returns:
      the value of the destination property
      See Also:

    • setDestination

      void setDestination(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the destination property.
      Parameters:
      value - the value of the destination property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getSignature

      String getSignature()
      Returns the signature element, the StatusResponse contains as String. A null value is returned if the StatusResponse has no signature.
      Returns:
      String representation of the signature.

    • getExtensions

      Extensions getExtensions()
      Returns the value of the extensions property.
      Returns:
      the value of the extensions property
      See Also:

    • setExtensions

      void setExtensions(Extensions value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the extensions property.
      Parameters:
      value - the value of the extensions property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getConsent

      String getConsent()
      Returns the value of the consent property.
      Returns:
      the value of the consent property
      See Also:

    • setConsent

      void setConsent(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the consent property.
      Parameters:
      value - the value of the consent property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getInResponseTo

      String getInResponseTo()
      Returns the value of the inResponseTo property.
      Returns:
      the value of the inResponseTo property
      See Also:

    • setInResponseTo

      void setInResponseTo(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the inResponseTo property.
      Parameters:
      value - the value of the inResponseTo property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getStatus

      Status getStatus()
      Returns the value of the status property.
      Returns:
      the value of the status property
      See Also:

    • setStatus

      void setStatus(Status value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the status property.
      Parameters:
      value - the value of the status property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getID

      String getID()
      Returns the value of the id property.
      Returns:
      the value of the id property
      See Also:

    • setID

      void setID(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the id property.
      Parameters:
      value - the value of the id property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • getIssuer

      Issuer getIssuer()
      Returns the value of the issuer property.
      Returns:
      the value of the issuer property
      See Also:

    • setIssuer

      void setIssuer(Issuer value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the value of the issuer property.
      Parameters:
      value - the value of the issuer property to be set
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • isSigned

      boolean isSigned()
      Returns whether the StatusResponse is signed or not.
      Returns:
      true if the StatusResponse is signed false otherwise.

    • isSignatureValid

      boolean isSignatureValid(Set<X509Certificate> verificationCerts) throws com.sun.identity.saml2.common.SAML2Exception
      Returns whether the signature on the StatusResponse is valid or not.
      Parameters:
      verificationCerts - Certificates containing the public keys which may be used for signature verification; This certificate may also may be used to check against the certificate included in the signature.
      Returns:
      true if the signature is valid; false otherwise.
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the signature could not be verified

    • sign

      void sign(org.forgerock.openam.saml2.crypto.signing.SigningConfig signingConfig) throws com.sun.identity.saml2.common.SAML2Exception
      Signs the StatusResponse.
      Parameters:
      signingConfig - The signing configuration.
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if it could not sign the StatusResponse.

    • makeImmutable

      void makeImmutable()
      Makes the object immutable

    • isMutable

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