|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
This class represents the LogoutRequest element in
SAML protocol schema.
A session participant or session authority sends a LogoutRequest
message to indicate that a session has been terminated.
<element name="LogoutRequest" type="{urn:oasis:names:tc:SAML:2.0:protocol}LogoutRequestType"/>
<complexType name="LogoutRequestType">
<complexContent>
<extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
<sequence>
<choice>
<element ref="{urn:oasis:names:tc:SAML:2.0:assertion}BaseID"/>
<element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/>
<element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/>
</choice>
<element ref="{urn:oasis:names:tc:SAML:2.0:protocol}SessionIndex" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
<attribute name="NotOnOrAfter" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
<attribute name="Reason" type="{http://www.w3.org/2001/XMLSchema}string" />
</extension>
</complexContent>
</complexType>
| Method Summary | |
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. |
java.util.Date |
getNotOnOrAfter()
Returns the value of the notOnOrAfter property. |
java.lang.String |
getReason()
Returns the value of the reason property. |
java.util.List |
getSessionIndex()
Returns the value of the SessionIndex property. |
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(java.util.Date value)
Sets the value of the notOnOrAfter property. |
void |
setReason(java.lang.String value)
Sets the value of the reason property. |
void |
setSessionIndex(java.util.List sessionIndexList)
Sets the value of the SessionIndex property. |
| Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract |
getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, toXMLString, toXMLString |
| Method Detail |
public java.util.Date getNotOnOrAfter()
java.util.Date value of the notOnOrAfter propertysetNotOnOrAfter(Date)
public void setNotOnOrAfter(java.util.Date value)
throws SAML2Exception
value - java.util.Date value of the notOnOrAfter
property to be set
SAML2Exception - if the object is immutablegetNotOnOrAfter()public java.lang.String getReason()
String value of the reason propertysetReason(String)
public void setReason(java.lang.String value)
throws SAML2Exception
value - String value of the reason property to be set
SAML2Exception - if the object is immutablegetReason()public EncryptedID getEncryptedID()
setEncryptedID(EncryptedID)
public void setEncryptedID(EncryptedID value)
throws SAML2Exception
value - the value of the encryptedID property to be set
SAML2Exception - if the object is immutablegetEncryptedID()public NameID getNameID()
setNameID(NameID)
public void setNameID(NameID value)
throws SAML2Exception
value - the value of the nameID property to be set
SAML2Exception - if the object is immutablegetNameID()public BaseID getBaseID()
setBaseID(BaseID)
public void setBaseID(BaseID value)
throws SAML2Exception
value - the value of the baseID property to be set
SAML2Exception - if the object is immutablegetBaseID()public java.util.List getSessionIndex()
java.lang.StringsetSessionIndex(List)
public void setSessionIndex(java.util.List sessionIndexList)
throws SAML2Exception
sessionIndexList - A list containing objects of type java.lang.String
SAML2Exception - if the object is immutablegetSessionIndex()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||