com.sun.identity.saml2.protocol

Interface StatusResponse

All Known Subinterfaces:

ArtifactResponse, LogoutResponse, ManageNameIDResponse, NameIDMappingResponse, Response

public interface StatusResponse

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 Summary

Modifier and Type	Method and Description
String	getConsent() Returns the value of the consent property.
String	getDestination() Returns the value of the destination property.
Extensions	getExtensions() Returns the value of the extensions property.
String	getID() Returns the value of the id property.
String	getInResponseTo() Returns the value of the inResponseTo property.
Date	getIssueInstant() Returns the value of the issueInstant property.
Issuer	getIssuer() Returns the value of the issuer property.
String	getSignature() Returns the signature element, the StatusResponse contains as String.
Status	getStatus() Returns the value of the status property.
String	getVersion() Returns the value of the version property.
boolean	isMutable() Returns true if the object is mutable false otherwise
boolean	isSignatureValid(Set<X509Certificate> verificationCerts) Returns whether the signature on the StatusResponse is valid or not.
boolean	isSigned() Returns whether the StatusResponse is signed or not.
void	makeImmutable() Makes the object immutable
void	setConsent(String value) Sets the value of the consent property.
void	setDestination(String value) Sets the value of the destination property.
void	setExtensions(Extensions value) Sets the value of the extensions property.
void	setID(String value) Sets the value of the id property.
void	setInResponseTo(String value) Sets the value of the inResponseTo property.
void	setIssueInstant(Date value) Sets the value of the issueInstant property.
void	setIssuer(Issuer value) Sets the value of the issuer property.
void	setStatus(Status value) Sets the value of the status property.
void	setVersion(String value) Sets the value of the version property.
void	sign(PrivateKey privateKey, X509Certificate cert) Signs the StatusResponse.
String	toXMLString() Returns the StatusResponse in an XML document String format based on the StatusResponse schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns the StatusResponse in an XML document String format based on the StatusResponse schema described above.

Method Detail

getVersion

String getVersion()

Returns the value of the version property.

Returns:

the value of the version property

See Also:

StatusResponse.setVersion(String)

setVersion

void setVersion(String value)
         throws SAML2Exception

Sets the value of the version property.

Parameters:

value - the value of the version property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getVersion()

getIssueInstant

Date getIssueInstant()

Returns the value of the issueInstant property.

Returns:

the value of the issueInstant property

See Also:

StatusResponse.setIssueInstant(java.util.Date)

setIssueInstant

void setIssueInstant(Date value)
              throws SAML2Exception

Sets the value of the issueInstant property.

Parameters:

value - the value of the issueInstant property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getIssueInstant()

getDestination

String getDestination()

Returns the value of the destination property.

Returns:

the value of the destination property

See Also:

StatusResponse.setDestination(String)

setDestination

void setDestination(String value)
             throws SAML2Exception

Sets the value of the destination property.

Parameters:

value - the value of the destination property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getDestination()

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:

StatusResponse.setExtensions(Extensions)

setExtensions

void setExtensions(Extensions value)
            throws SAML2Exception

Sets the value of the extensions property.

Parameters:

value - the value of the extensions property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getExtensions()

getConsent

String getConsent()

Returns the value of the consent property.

Returns:

the value of the consent property

See Also:

StatusResponse.setConsent(String)

setConsent

void setConsent(String value)
         throws SAML2Exception

Sets the value of the consent property.

Parameters:

value - the value of the consent property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getConsent()

getInResponseTo

String getInResponseTo()

Returns the value of the inResponseTo property.

Returns:

the value of the inResponseTo property

See Also:

StatusResponse.setInResponseTo(String)

setInResponseTo

void setInResponseTo(String value)
              throws SAML2Exception

Sets the value of the inResponseTo property.

Parameters:

value - the value of the inResponseTo property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getInResponseTo()

getStatus

Status getStatus()

Returns the value of the status property.

Returns:

the value of the status property

See Also:

StatusResponse.setStatus(Status)

setStatus

void setStatus(Status value)
        throws SAML2Exception

Sets the value of the status property.

Parameters:

value - the value of the status property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getStatus()

getID

String getID()

Returns the value of the id property.

Returns:

the value of the id property

See Also:

StatusResponse.setID(String)

setID

void setID(String value)
    throws SAML2Exception

Sets the value of the id property.

Parameters:

value - the value of the id property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getID()

getIssuer

Issuer getIssuer()

Returns the value of the issuer property.

Returns:

the value of the issuer property

See Also:

StatusResponse.setIssuer(Issuer)

setIssuer

void setIssuer(Issuer value)
        throws SAML2Exception

Sets the value of the issuer property.

Parameters:

value - the value of the issuer property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

StatusResponse.getIssuer()

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 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:

SAML2Exception - if the signature could not be verified

sign

void sign(PrivateKey privateKey,
          X509Certificate cert)
   throws SAML2Exception

Signs the StatusResponse.

Parameters:

privateKey - Signing key

cert - Certificate which contain the public key correlated to the signing key; It if is not null, then the signature will include the certificate; Otherwise, the signature will not include any certificate.

Throws:

SAML2Exception - if it could not sign the StatusResponse.

toXMLString

String toXMLString()
            throws SAML2Exception

Returns the StatusResponse in an XML document String format based on the StatusResponse schema described above.

Returns:

An XML String representing the StatusResponse.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns the StatusResponse in an XML document String format based on the StatusResponse 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 StatusResponse.

Throws:

SAML2Exception - if some error occurs during conversion to String.

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