Package com.sun.identity.saml2.protocol.impl

Class StatusResponseImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.StatusResponseImpl

All Implemented Interfaces:

StatusResponse

Direct Known Subclasses:

ArtifactResponseImpl, LogoutResponseImpl, ManageNameIDResponseImpl, NameIDMappingResponseImpl, ResponseImpl

public abstract class StatusResponseImpl
extends Object
implements StatusResponse

This class defines methods for setting and retrieving attributes and elements associated with a SAML response message used in SAML protocols. This class is the base class for all SAML Responses.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	consent
protected String	destination
protected Extensions	extensions
protected String	inResponseTo
protected boolean	isMutable
protected Boolean	isSignatureValid
protected boolean	isSigned
protected Date	issueInstant
protected Issuer	issuer
protected PublicKey	publicKey
protected String	responseId
protected String	signatureString
protected String	signedXMLString
protected Status	status
protected String	version

Constructor Summary

Constructors

Constructor	Description
StatusResponseImpl()

Method Summary

Modifier and Type	Method	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 object is mutable.
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 this 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.
protected void	validateData()
protected void	validateID(String responseId)
protected void	validateIssueInstant(String issueInstantStr)
protected void	validateStatus()
protected void	validateVersion(String version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

protected String version

issueInstant

protected Date issueInstant

destination

protected String destination

signatureString

protected String signatureString

extensions

protected Extensions extensions

consent

protected String consent

inResponseTo

protected String inResponseTo

status

protected Status status

responseId

protected String responseId

issuer

protected Issuer issuer

isSigned

protected boolean isSigned

isSignatureValid

protected Boolean isSignatureValid

isMutable

protected boolean isMutable

publicKey

protected PublicKey publicKey

signedXMLString

protected String signedXMLString

Constructor Detail

StatusResponseImpl

public StatusResponseImpl()

Method Detail

getVersion

public String getVersion()

Returns the value of the version property.

Specified by:

getVersion in interface StatusResponse

Returns:

the value of the version property

See Also:

setVersion(String)

setVersion

public void setVersion(String value)
                throws SAML2Exception

Sets the value of the version property.

Specified by:

setVersion in interface StatusResponse

Parameters:

value - the value of the version property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getVersion()

getIssueInstant

public Date getIssueInstant()

Returns the value of the issueInstant property.

Specified by:

getIssueInstant in interface StatusResponse

Returns:

the value of the issueInstant property

See Also:

setIssueInstant(java.util.Date)

setIssueInstant

public void setIssueInstant(Date value)
                     throws SAML2Exception

Sets the value of the issueInstant property.

Specified by:

setIssueInstant in interface StatusResponse

Parameters:

value - the value of the issueInstant property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getIssueInstant()

getDestination

public String getDestination()

Returns the value of the destination property.

Specified by:

getDestination in interface StatusResponse

Returns:

the value of the destination property

See Also:

setDestination(String)

setDestination

public void setDestination(String value)
                    throws SAML2Exception

Sets the value of the destination property.

Specified by:

setDestination in interface StatusResponse

Parameters:

value - the value of the destination property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getDestination()

getSignature

public String getSignature()

Returns the signature element, the StatusResponse contains as String. It returns null if the StatusResponse has no signature.

Specified by:

getSignature in interface StatusResponse

Returns:

String representation of the signature.

sign

public void sign(PrivateKey privateKey,
                 X509Certificate cert)
          throws SAML2Exception

Signs the StatusResponse

Specified by:

sign in interface 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 Request.

getExtensions

public Extensions getExtensions()

Returns the value of the extensions property.

Specified by:

getExtensions in interface StatusResponse

Returns:

the value of the extensions property

See Also:

setExtensions(Extensions)

setExtensions

public void setExtensions(Extensions value)
                   throws SAML2Exception

Sets the value of the extensions property.

Specified by:

setExtensions in interface StatusResponse

Parameters:

value - the value of the extensions property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getExtensions()

getConsent

public String getConsent()

Returns the value of the consent property.

Specified by:

getConsent in interface StatusResponse

Returns:

the value of the consent property

See Also:

setConsent(String)

setConsent

public void setConsent(String value)
                throws SAML2Exception

Sets the value of the consent property.

Specified by:

setConsent in interface StatusResponse

Parameters:

value - the value of the consent property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getConsent()

getInResponseTo

public String getInResponseTo()

Returns the value of the inResponseTo property.

Specified by:

getInResponseTo in interface StatusResponse

Returns:

the value of the inResponseTo property

See Also:

setInResponseTo(String)

setInResponseTo

public void setInResponseTo(String value)
                     throws SAML2Exception

Sets the value of the inResponseTo property.

Specified by:

setInResponseTo in interface StatusResponse

Parameters:

value - the value of the inResponseTo property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getInResponseTo()

getStatus

public Status getStatus()

Returns the value of the status property.

Specified by:

getStatus in interface StatusResponse

Returns:

the value of the status property

See Also:

setStatus(Status)

setStatus

public void setStatus(Status value)
               throws SAML2Exception

Sets the value of the status property.

Specified by:

setStatus in interface StatusResponse

Parameters:

value - the value of the status property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatus()

getID

public String getID()

Returns the value of the id property.

Specified by:

getID in interface StatusResponse

Returns:

the value of the id property

See Also:

setID(String)

setID

public void setID(String value)
           throws SAML2Exception

Sets the value of the id property.

Specified by:

setID in interface StatusResponse

Parameters:

value - the value of the id property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getID()

getIssuer

public Issuer getIssuer()

Returns the value of the issuer property.

Specified by:

getIssuer in interface StatusResponse

Returns:

the value of the issuer property

See Also:

setIssuer(Issuer)

setIssuer

public void setIssuer(Issuer value)
               throws SAML2Exception

Sets the value of the issuer property.

Specified by:

setIssuer in interface StatusResponse

Parameters:

value - the value of the issuer property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getIssuer()

isSigned

public boolean isSigned()

Returns whether the StatusResponse is signed or not.

Specified by:

isSigned in interface StatusResponse

Returns:

true if the StatusResponse is signed.

isSignatureValid

public boolean isSignatureValid(Set<X509Certificate> verificationCerts)
                         throws SAML2Exception

Description copied from interface: StatusResponse

Returns whether the signature on the StatusResponse is valid or not.

Specified by:

isSignatureValid in interface StatusResponse

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

toXMLString

public String toXMLString()
                   throws SAML2Exception

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

Specified by:

toXMLString in interface StatusResponse

Returns:

An XML String representing the StatusResponse.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

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

Specified by:

toXMLString in interface StatusResponse

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

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface StatusResponse

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface StatusResponse

Returns:

true if object is mutable.

validateID

protected void validateID(String responseId)
                   throws SAML2Exception

Throws:

SAML2Exception

validateVersion

protected void validateVersion(String version)
                        throws SAML2Exception

Throws:

SAML2Exception

validateIssueInstant

protected void validateIssueInstant(String issueInstantStr)
                             throws SAML2Exception

Throws:

SAML2Exception

validateStatus

protected void validateStatus()
                       throws SAML2Exception

Throws:

SAML2Exception

validateData

protected void validateData()
                     throws SAML2Exception

Throws:

SAML2Exception