org.opensaml.saml2.core
Interface LogoutRequest

All Superinterfaces:
RequestAbstractType, SAMLObject, SignableSAMLObject, org.opensaml.xml.signature.SignableXMLObject, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject
All Known Implementing Classes:
LogoutRequestImpl

public interface LogoutRequest
extends RequestAbstractType

SAML 2.0 Core LogoutRequest.


Field Summary
static java.lang.String DEFAULT_ELEMENT_LOCAL_NAME
          Element local name.
static javax.xml.namespace.QName DEFAULT_ELEMENT_NAME
          Default element name.
static java.lang.String NOT_ON_OR_AFTER_ATTRIB_NAME
          NotOnOrAfter attribute name.
static java.lang.String REASON_ATTRIB_NAME
          Reason attribute name.
static java.lang.String TYPE_LOCAL_NAME
          Local name of the XSI type.
static javax.xml.namespace.QName TYPE_NAME
          QName of the XSI type.
 
Fields inherited from interface org.opensaml.saml2.core.RequestAbstractType
CONSENT_ATTRIB_NAME, DESTINATION_ATTRIB_NAME, EXPLICIT_CONSENT, ID_ATTRIB_NAME, IMPLICIT_CONSENT, INAPPLICABLE_CONSENT, ISSUE_INSTANT_ATTRIB_NAME, OBTAINED_CONSENT, PRIOR_CONSENT, UNAVAILABLE_CONSENT, UNSPECIFIED_CONSENT, VERSION_ATTRIB_NAME
 
Method Summary
 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.
 org.joda.time.DateTime getNotOnOrAfter()
          Get the NotOnOrAfter attrib value of the request.
 java.lang.String getReason()
          Get the Reason attrib value of the request.
 java.util.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(org.joda.time.DateTime newNotOnOrAfter)
          Set the NotOnOrAfter attrib value of the request.
 void setReason(java.lang.String newReason)
          Set the Reason attrib value of the request.
 
Methods inherited from interface org.opensaml.saml2.core.RequestAbstractType
getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getVersion, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion
 
Methods inherited from interface org.opensaml.common.SignableSAMLObject
getSignatureReferenceID
 
Methods inherited from interface org.opensaml.xml.signature.SignableXMLObject
getSignature, isSigned, setSignature
 
Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject
deregisterValidator, getValidators, registerValidator, validate
 
Methods inherited from interface org.opensaml.xml.XMLObject
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
 

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

static final java.lang.String DEFAULT_ELEMENT_LOCAL_NAME
Element local name.

See Also:
Constant Field Values

DEFAULT_ELEMENT_NAME

static final javax.xml.namespace.QName DEFAULT_ELEMENT_NAME
Default element name.


TYPE_LOCAL_NAME

static final java.lang.String TYPE_LOCAL_NAME
Local name of the XSI type.

See Also:
Constant Field Values

TYPE_NAME

static final javax.xml.namespace.QName TYPE_NAME
QName of the XSI type.


REASON_ATTRIB_NAME

static final java.lang.String REASON_ATTRIB_NAME
Reason attribute name.

See Also:
Constant Field Values

NOT_ON_OR_AFTER_ATTRIB_NAME

static final java.lang.String NOT_ON_OR_AFTER_ATTRIB_NAME
NotOnOrAfter attribute name.

See Also:
Constant Field Values
Method Detail

getReason

java.lang.String getReason()
Get the Reason attrib value of the request.

Returns:
the Reason value of the request

setReason

void setReason(java.lang.String newReason)
Set the Reason attrib value of the request.

Parameters:
newReason - the new Reason value of the request

getNotOnOrAfter

org.joda.time.DateTime getNotOnOrAfter()
Get the NotOnOrAfter attrib value of the request.

Returns:
the NotOnOrAfter value of the request

setNotOnOrAfter

void setNotOnOrAfter(org.joda.time.DateTime 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

java.util.List<SessionIndex> getSessionIndexes()
Get the list of SessionIndexes for the request.

Returns:
the list of SessionIndexes


Copyright © 2006-2012 Internet2. All Rights Reserved.