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

Class LogoutRequestImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

com.sun.identity.saml2.protocol.impl.LogoutRequestImpl

All Implemented Interfaces:

LogoutRequest, RequestAbstract

public class LogoutRequestImpl
extends RequestAbstractImpl
implements LogoutRequest

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

Field Summary

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

consent, destinationURI, elementName, extensions, isMutable, isSignatureValid, isSigned, issueInstant, nameID, publicKey, requestId, signatureString, signedXMLString, version

Constructor Summary

Constructors

Constructor	Description
LogoutRequestImpl()	Constructs the LogoutRequest Object.
LogoutRequestImpl(String xmlString)	Constructs the LogoutRequest Object.
LogoutRequestImpl(Element element)	Constructs the LogoutRequest Object.

Method Summary

Modifier and Type	Method	Description
BaseID	getBaseID()	Returns the value of the baseID property.
EncryptedID	getEncryptedID()	Returns the value of the encryptedID property.
NameID	getNameID()	Returns the value of the nameID property.
Date	getNotOnOrAfter()	Returns the value of the notOnOrAfter property.
String	getReason()	Returns the value of the reason property.
List	getSessionIndex()	Returns the value of the SessionIndex property.
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
void	setBaseID(BaseID value)	Sets the value of the baseID property.
void	setEncryptedID(EncryptedID value)	Sets the value of the encryptedID property.
void	setNameID(NameID value)	Sets the value of the nameID property.
void	setNotOnOrAfter(Date value)	Sets the value of the notOnOrAfter property.
void	setReason(String value)	Sets the value of the reason property.
void	setSessionIndex(List sessionIndexList)	Sets the value of the SessionIndex property.
String	toXMLString()	Returns the LogoutRequest in an XML document String format based on the LogoutRequest schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns the LogoutRequest in an XML document String format based on the LogoutRequest schema described above.

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

getAttributesString, getConsent, getDestination, getElements, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, getXMLString, isSignatureValid, isSigned, parseDOMAttributes, parseDOMChileElements, parseDOMElement, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, validateData, validateID, validateIssueInstant, 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.RequestAbstract

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

Constructor Detail

LogoutRequestImpl

public LogoutRequestImpl()

Constructs the LogoutRequest Object.

LogoutRequestImpl

public LogoutRequestImpl(Element element)
                  throws SAML2Exception

Constructs the LogoutRequest Object.

Parameters:

element - the Document Element of LogoutRequest object.

Throws:

SAML2Exception - if LogoutRequest cannot be created.

LogoutRequestImpl

public LogoutRequestImpl(String xmlString)
                  throws SAML2Exception

Constructs the LogoutRequest Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if LogoutRequest cannot be created.

Method Detail

getNotOnOrAfter

public Date getNotOnOrAfter()

Returns the value of the notOnOrAfter property.

Specified by:

getNotOnOrAfter in interface LogoutRequest

Returns:

java.util.Date value of the notOnOrAfter property

See Also:

setNotOnOrAfter(Date)

setNotOnOrAfter

public void setNotOnOrAfter(Date value)
                     throws SAML2Exception

Sets the value of the notOnOrAfter property.

Specified by:

setNotOnOrAfter in interface LogoutRequest

Parameters:

value - java.util.Date value of the notOnOrAfter property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getNotOnOrAfter()

getReason

public String getReason()

Returns the value of the reason property.

Specified by:

getReason in interface LogoutRequest

Returns:

String value of the reason property

See Also:

setReason(String)

setReason

public void setReason(String value)
               throws SAML2Exception

Sets the value of the reason property.

Specified by:

setReason in interface LogoutRequest

Parameters:

value - String value of the reason property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getReason()

getEncryptedID

public EncryptedID getEncryptedID()

Returns the value of the encryptedID property.

Specified by:

getEncryptedID in interface LogoutRequest

Returns:

the value of the encryptedID property

See Also:

setEncryptedID(EncryptedID)

setEncryptedID

public void setEncryptedID(EncryptedID value)
                    throws SAML2Exception

Sets the value of the encryptedID property.

Specified by:

setEncryptedID in interface LogoutRequest

Parameters:

value - the value of the encryptedID property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getEncryptedID()

getNameID

public NameID getNameID()

Returns the value of the nameID property.

Specified by:

getNameID in interface LogoutRequest

Returns:

the value of the nameID property

See Also:

setNameID(NameID)

setNameID

public void setNameID(NameID value)
               throws SAML2Exception

Sets the value of the nameID property.

Specified by:

setNameID in interface LogoutRequest

Parameters:

value - the value of the nameID property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getNameID()

getBaseID

public BaseID getBaseID()

Returns the value of the baseID property.

Specified by:

getBaseID in interface LogoutRequest

Returns:

the value of the baseID property

See Also:

setBaseID(BaseID)

setBaseID

public void setBaseID(BaseID value)
               throws SAML2Exception

Sets the value of the baseID property.

Specified by:

setBaseID in interface LogoutRequest

Parameters:

value - the value of the baseID property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getBaseID()

getSessionIndex

public List getSessionIndex()

Returns the value of the SessionIndex property.

Specified by:

getSessionIndex in interface LogoutRequest

Returns:

A list containing objects of type java.lang.String

See Also:

setSessionIndex(List)

setSessionIndex

public void setSessionIndex(List sessionIndexList)
                     throws SAML2Exception

Sets the value of the SessionIndex property.

Specified by:

setSessionIndex in interface LogoutRequest

Parameters:

sessionIndexList - A list containing objects of type java.lang.String

Throws:

SAML2Exception - if the object is immutable

See Also:

getSessionIndex()

toXMLString

public String toXMLString()
                   throws SAML2Exception

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

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

Returns:

An XML String representing the LogoutRequest.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

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

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

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

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

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface RequestAbstract

Overrides:

makeImmutable in class RequestAbstractImpl

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface RequestAbstract

Overrides:

isMutable in class RequestAbstractImpl

Returns:

true if object is immutable.