org.opensaml.saml2.core
Interface AuthnStatement

All Superinterfaces:
SAMLObject, Statement, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject
All Known Implementing Classes:
AuthnStatementImpl

public interface AuthnStatement
extends Statement

SAML 2.0 Core AuthnStatement.


Field Summary
static java.lang.String AUTHN_INSTANT_ATTRIB_NAME
          AuthnInstant attribute name.
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 SESSION_INDEX_ATTRIB_NAME
          SessionIndex attribute name.
static java.lang.String SESSION_NOT_ON_OR_AFTER_ATTRIB_NAME
          SessionNoOnOrAfter 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.
 
Method Summary
 AuthnContext getAuthnContext()
          Gets the context used to authenticate the subject.
 org.joda.time.DateTime getAuthnInstant()
          Gets the time when the authentication took place.
 java.lang.String getSessionIndex()
          Get the session index between the principal and the authenticating authority.
 org.joda.time.DateTime getSessionNotOnOrAfter()
          Get the time when the session between the principal and the SAML authority ends.
 SubjectLocality getSubjectLocality()
          Get the DNS domain and IP address of the system where the principal was authenticated.
 void setAuthnContext(AuthnContext newAuthnContext)
          Sets the context used to authenticate the subject.
 void setAuthnInstant(org.joda.time.DateTime newAuthnInstant)
          Sets the time when the authentication took place.
 void setSessionIndex(java.lang.String newIndex)
          Sets the session index between the principal and the authenticating authority.
 void setSessionNotOnOrAfter(org.joda.time.DateTime newSessionNotOnOrAfter)
          Set the time when the session between the principal and the SAML authority ends.
 void setSubjectLocality(SubjectLocality newLocality)
          Set the DNS domain and IP address of the system where the principal was authenticated.
 
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.


AUTHN_INSTANT_ATTRIB_NAME

static final java.lang.String AUTHN_INSTANT_ATTRIB_NAME
AuthnInstant attribute name.

See Also:
Constant Field Values

SESSION_INDEX_ATTRIB_NAME

static final java.lang.String SESSION_INDEX_ATTRIB_NAME
SessionIndex attribute name.

See Also:
Constant Field Values

SESSION_NOT_ON_OR_AFTER_ATTRIB_NAME

static final java.lang.String SESSION_NOT_ON_OR_AFTER_ATTRIB_NAME
SessionNoOnOrAfter attribute name.

See Also:
Constant Field Values
Method Detail

getAuthnInstant

org.joda.time.DateTime getAuthnInstant()
Gets the time when the authentication took place.

Returns:
the time when the authentication took place

setAuthnInstant

void setAuthnInstant(org.joda.time.DateTime newAuthnInstant)
Sets the time when the authentication took place.

Parameters:
newAuthnInstant - the time when the authentication took place

getSessionIndex

java.lang.String getSessionIndex()
Get the session index between the principal and the authenticating authority.

Returns:
the session index between the principal and the authenticating authority

setSessionIndex

void setSessionIndex(java.lang.String newIndex)
Sets the session index between the principal and the authenticating authority.

Parameters:
newIndex - the session index between the principal and the authenticating authority

getSessionNotOnOrAfter

org.joda.time.DateTime getSessionNotOnOrAfter()
Get the time when the session between the principal and the SAML authority ends.

Returns:
the time when the session between the principal and the SAML authority ends

setSessionNotOnOrAfter

void setSessionNotOnOrAfter(org.joda.time.DateTime newSessionNotOnOrAfter)
Set the time when the session between the principal and the SAML authority ends.

Parameters:
newSessionNotOnOrAfter - the time when the session between the principal and the SAML authority ends

getSubjectLocality

SubjectLocality getSubjectLocality()
Get the DNS domain and IP address of the system where the principal was authenticated.

Returns:
the DNS domain and IP address of the system where the principal was authenticated

setSubjectLocality

void setSubjectLocality(SubjectLocality newLocality)
Set the DNS domain and IP address of the system where the principal was authenticated.

Parameters:
newLocality - the DNS domain and IP address of the system where the principal was authenticated

getAuthnContext

AuthnContext getAuthnContext()
Gets the context used to authenticate the subject.

Returns:
the context used to authenticate the subject

setAuthnContext

void setAuthnContext(AuthnContext newAuthnContext)
Sets the context used to authenticate the subject.

Parameters:
newAuthnContext - the context used to authenticate the subject


Copyright © 2006-2012 Internet2. All Rights Reserved.