com.sun.identity.saml2.protocol
Interface LogoutRequest

All Superinterfaces:
RequestAbstract

public interface LogoutRequest
extends RequestAbstract

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

getNotOnOrAfter

Date getNotOnOrAfter()
Returns the value of the notOnOrAfter property.

Returns:
java.util.Date value of the notOnOrAfter property
See Also:
LogoutRequest.setNotOnOrAfter(Date)

setNotOnOrAfter

void setNotOnOrAfter(Date value)
                     throws SAML2Exception
Sets the value of the notOnOrAfter property.

Parameters:
value - java.util.Date value of the notOnOrAfter property to be set
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getNotOnOrAfter()

getReason

String getReason()
Returns the value of the reason property.

Returns:
String value of the reason property
See Also:
LogoutRequest.setReason(String)

setReason

void setReason(String value)
               throws SAML2Exception
Sets the value of the reason property.

Parameters:
value - String value of the reason property to be set
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getReason()

getEncryptedID

EncryptedID getEncryptedID()
Returns the value of the encryptedID property.

Returns:
the value of the encryptedID property
See Also:
LogoutRequest.setEncryptedID(EncryptedID)

setEncryptedID

void setEncryptedID(EncryptedID value)
                    throws SAML2Exception
Sets the value of the encryptedID property.

Parameters:
value - the value of the encryptedID property to be set
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getEncryptedID()

getNameID

NameID getNameID()
Returns the value of the nameID property.

Returns:
the value of the nameID property
See Also:
LogoutRequest.setNameID(NameID)

setNameID

void setNameID(NameID value)
               throws SAML2Exception
Sets the value of the nameID property.

Parameters:
value - the value of the nameID property to be set
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getNameID()

getBaseID

BaseID getBaseID()
Returns the value of the baseID property.

Returns:
the value of the baseID property
See Also:
LogoutRequest.setBaseID(BaseID)

setBaseID

void setBaseID(BaseID value)
               throws SAML2Exception
Sets the value of the baseID property.

Parameters:
value - the value of the baseID property to be set
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getBaseID()

getSessionIndex

List getSessionIndex()
Returns the value of the SessionIndex property.

Returns:
list containing objects of type java.lang.String
See Also:
LogoutRequest.setSessionIndex(List)

setSessionIndex

void setSessionIndex(List sessionIndexList)
                     throws SAML2Exception
Sets the value of the SessionIndex property.

Parameters:
sessionIndexList - list containing objects of type java.lang.String
Throws:
SAML2Exception - if the object is immutable
See Also:
LogoutRequest.getSessionIndex()