All Superinterfaces:

RequestAbstractType, SAMLObject, SignableSAMLObject, org.opensaml.xmlsec.signature.SignableXMLObject, org.opensaml.core.xml.XMLObject
```
public interface LogoutRequest
extends RequestAbstractType
```
SAML 2.0 Core LogoutRequest.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADMIN_REASON`	Admin-initiated logout reason.
`static String`	`DEFAULT_ELEMENT_LOCAL_NAME`	Element local name.
`static QName`	`DEFAULT_ELEMENT_NAME`	Default element name.
`static String`	`GLOBAL_TIMEOUT_REASON`	Global timeout logout reason.
`static String`	`NOT_ON_OR_AFTER_ATTRIB_NAME`	NotOnOrAfter attribute name.
`static QName`	`NOT_ON_OR_AFTER_ATTRIB_QNAME`	QName for the NotOnOrAfter attribute.
`static String`	`REASON_ATTRIB_NAME`	Reason attribute name.
`static String`	`SP_TIMEOUT_REASON`	SP timeout logout reason.
`static String`	`TYPE_LOCAL_NAME`	Local name of the XSI type.
`static QName`	`TYPE_NAME`	QName of the XSI type.
`static String`	`USER_REASON`	User-initiated logout reason.

Fields inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType
CONSENT_ATTRIB_NAME, DESTINATION_ATTRIB_NAME, EXPLICIT_CONSENT, ID_ATTRIB_NAME, IMPLICIT_CONSENT, INAPPLICABLE_CONSENT, ISSUE_INSTANT_ATTRIB_NAME, ISSUE_INSTANT_ATTRIB_QNAME, OBTAINED_CONSENT, PRIOR_CONSENT, UNAVAILABLE_CONSENT, UNSPECIFIED_CONSENT, VERSION_ATTRIB_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`BaseID`	`getBaseID()`	Gets the base identifier of the principal for this request.
`EncryptedID`	`getEncryptedID()`	Gets the encrytped name identifier of the principal for this request.
`NameID`	`getNameID()`	Gets the name identifier of the principal for this request.
`Instant`	`getNotOnOrAfter()`	Get the NotOnOrAfter attrib value of the request.
`String`	`getReason()`	Get the Reason attrib value of the request.
`List<SessionIndex>`	`getSessionIndexes()`	Get the list of SessionIndexes for the request.
`void`	`setBaseID(BaseID newBaseID)`	Sets the base identifier of the principal for this request.
`void`	`setEncryptedID(EncryptedID newEncryptedID)`	Sets the encrypted name identifier of the principal for this request.
`void`	`setNameID(NameID newNameID)`	Sets the name identifier of the principal for this request.
`void`	`setNotOnOrAfter(Instant newNotOnOrAfter)`	Set the NotOnOrAfter attrib value of the request.
`void`	`setReason(String newReason)`	Set the Reason attrib value of the request.

Methods inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType
getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getVersion, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion

Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject
getSignatureReferenceID

Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject
getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.core.xml.XMLObject
detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

- Field Detail
  - DEFAULT_ELEMENT_LOCAL_NAME
```
static final String DEFAULT_ELEMENT_LOCAL_NAME
```
    Element local name.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENT_NAME
```
static final QName DEFAULT_ELEMENT_NAME
```
    Default element name.
  - TYPE_LOCAL_NAME
```
static final String TYPE_LOCAL_NAME
```
    Local name of the XSI type.
    
    See Also:
    
    Constant Field Values
  - TYPE_NAME
```
static final QName TYPE_NAME
```
    QName of the XSI type.
  - REASON_ATTRIB_NAME
```
static final String REASON_ATTRIB_NAME
```
    Reason attribute name.
    
    See Also:
    
    Constant Field Values
  - NOT_ON_OR_AFTER_ATTRIB_NAME
```
static final String NOT_ON_OR_AFTER_ATTRIB_NAME
```
    NotOnOrAfter attribute name.
    
    See Also:
    
    Constant Field Values
  - NOT_ON_OR_AFTER_ATTRIB_QNAME
```
static final QName NOT_ON_OR_AFTER_ATTRIB_QNAME
```
    QName for the NotOnOrAfter attribute.
  - USER_REASON
```
static final String USER_REASON
```
    User-initiated logout reason.
    
    See Also:
    
    Constant Field Values
  - ADMIN_REASON
```
static final String ADMIN_REASON
```
    Admin-initiated logout reason.
    
    See Also:
    
    Constant Field Values
  - GLOBAL_TIMEOUT_REASON
```
static final String GLOBAL_TIMEOUT_REASON
```
    Global timeout logout reason.
    
    See Also:
    
    Constant Field Values
  - SP_TIMEOUT_REASON
```
static final String SP_TIMEOUT_REASON
```
    SP timeout logout reason.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getReason
```
String getReason()
```
    Get the Reason attrib value of the request.
    
    Returns:
    
    the Reason value of the request
  - setReason
```
void setReason(String newReason)
```
    Set the Reason attrib value of the request.
    
    Parameters:
    
    newReason - the new Reason value of the request
  - getNotOnOrAfter
```
Instant getNotOnOrAfter()
```
    Get the NotOnOrAfter attrib value of the request.
    
    Returns:
    
    the NotOnOrAfter value of the request
  - setNotOnOrAfter
```
void setNotOnOrAfter(Instant newNotOnOrAfter)
```
    Set the NotOnOrAfter attrib value of the request.
    
    Parameters:
    
    newNotOnOrAfter - the new NotOnOrAfter value of the request
  - getBaseID
```
BaseID getBaseID()
```
    Gets the base identifier of the principal for this request.
    
    Returns:
    
    the base identifier of the principal for this request
  - setBaseID
```
void setBaseID(BaseID newBaseID)
```
    Sets the base identifier of the principal for this request.
    
    Parameters:
    
    newBaseID - the base identifier of the principal for this request
  - getNameID
```
NameID getNameID()
```
    Gets the name identifier of the principal for this request.
    
    Returns:
    
    the name identifier of the principal for this request
  - setNameID
```
void setNameID(NameID newNameID)
```
    Sets the name identifier of the principal for this request.
    
    Parameters:
    
    newNameID - the name identifier of the principal for this request
  - getEncryptedID
```
EncryptedID getEncryptedID()
```
    Gets the encrytped name identifier of the principal for this request.
    
    Returns:
    
    the encrytped name identifier of the principal for this request
  - setEncryptedID
```
void setEncryptedID(EncryptedID newEncryptedID)
```
    Sets the encrypted name identifier of the principal for this request.
    
    Parameters:
    
    newEncryptedID - the new encrypted name identifier of the principal for this request
  - getSessionIndexes
```
List<SessionIndex> getSessionIndexes()
```
    Get the list of SessionIndexes for the request.
    
    Returns:
    
    the list of SessionIndexes

Interface LogoutRequest

Field Summary

Fields inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType

Method Summary

Methods inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType

Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject

Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

Methods inherited from interface org.opensaml.core.xml.XMLObject

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

DEFAULT_ELEMENT_NAME

TYPE_LOCAL_NAME

TYPE_NAME

REASON_ATTRIB_NAME

NOT_ON_OR_AFTER_ATTRIB_NAME

NOT_ON_OR_AFTER_ATTRIB_QNAME

USER_REASON

ADMIN_REASON

GLOBAL_TIMEOUT_REASON

SP_TIMEOUT_REASON

Method Detail

getReason

setReason

getNotOnOrAfter

setNotOnOrAfter

getBaseID

setBaseID

getNameID

setNameID

getEncryptedID

setEncryptedID

getSessionIndexes