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

Class LogoutResponseImpl

java.lang.Object

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

com.sun.identity.saml2.protocol.impl.LogoutResponseImpl

All Implemented Interfaces:

LogoutResponse, StatusResponse

public class LogoutResponseImpl
extends StatusResponseImpl
implements LogoutResponse

This class implements the LogoutResponse element in SAML protocol schema. It provides all the methods required by LogoutResponse

Field Summary

Fields inherited from class com.sun.identity.saml2.protocol.impl.StatusResponseImpl

consent, destination, extensions, inResponseTo, isMutable, isSignatureValid, isSigned, issueInstant, issuer, publicKey, responseId, signatureString, signedXMLString, status, version

Constructor Summary

Constructors

Constructor	Description
LogoutResponseImpl()	Constructs the LogoutResponse Object.
LogoutResponseImpl(String xmlString)	Constructs the LogoutResponse Object.
LogoutResponseImpl(Element element)	Constructs the LogoutResponse Object.

Method Summary

Modifier and Type	Method	Description
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
String	toXMLString()	Returns the LogoutResponse in an XML document String format based on the LogoutResponse schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns the LogoutResponse in an XML document String format based on the LogoutResponse schema described above.

Methods inherited from class com.sun.identity.saml2.protocol.impl.StatusResponseImpl

getConsent, getDestination, getExtensions, getID, getInResponseTo, getIssueInstant, getIssuer, getSignature, getStatus, getVersion, isSignatureValid, isSigned, setConsent, setDestination, setExtensions, setID, setInResponseTo, setIssueInstant, setIssuer, setStatus, setVersion, sign, validateData, validateID, validateIssueInstant, validateStatus, validateVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.saml2.protocol.StatusResponse

getConsent, getDestination, getExtensions, getID, getInResponseTo, getIssueInstant, getIssuer, getSignature, getStatus, getVersion, isSignatureValid, isSigned, setConsent, setDestination, setExtensions, setID, setInResponseTo, setIssueInstant, setIssuer, setStatus, setVersion, sign

Constructor Detail

LogoutResponseImpl

public LogoutResponseImpl()

Constructs the LogoutResponse Object.

LogoutResponseImpl

public LogoutResponseImpl(Element element)
                   throws SAML2Exception

Constructs the LogoutResponse Object.

Parameters:

element - the Document Element of LogoutResponse object.

Throws:

SAML2Exception - if LogoutResponse cannot be created.

LogoutResponseImpl

public LogoutResponseImpl(String xmlString)
                   throws SAML2Exception

Constructs the LogoutResponse Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if LogoutResponse cannot be created.

Method Detail

toXMLString

public String toXMLString()
                   throws SAML2Exception

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

Specified by:

toXMLString in interface StatusResponse

Overrides:

toXMLString in class StatusResponseImpl

Returns:

An XML String representing the LogoutResponse.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

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

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

Specified by:

toXMLString in interface StatusResponse

Overrides:

toXMLString in class StatusResponseImpl

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 LogoutResponse.

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface StatusResponse

Overrides:

makeImmutable in class StatusResponseImpl

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface StatusResponse

Overrides:

isMutable in class StatusResponseImpl

Returns:

true if object is mutable.