com.sun.identity.saml2.assertion

Interface AuthnStatement

All Superinterfaces:

Statement

public interface AuthnStatement
extends Statement

The AuthnStatement element describes a statement by the SAML authority asserting that the assertion subject was authenticated by a particular means at a particular time. It is of type AuthnStatementType.

 <complexType name="AuthnStatementType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:assertion}
     StatementAbstractType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         SubjectLocality" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         AuthnContext"/>
       </sequence>
       <attribute name="AuthnInstant" use="required"
       type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="SessionIndex"
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="SessionNotOnOrAfter"
       type="{http://www.w3.org/2001/XMLSchema}dateTime" />
     </extension>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method and Description
AuthnContext	getAuthnContext() Returns the value of the AuthnContext property.
Date	getAuthnInstant() Returns the value of the AuthnInstant attribute.
String	getSessionIndex() Returns the value of the SessionIndex attribute.
Date	getSessionNotOnOrAfter() Returns the value of the SessionNotOnOrAfter attribute.
SubjectLocality	getSubjectLocality() Returns the value of the SubjectLocality property.
void	setAuthnContext(AuthnContext value) Sets the value of the AuthnContext property.
void	setAuthnInstant(Date value) Sets the value of the AuthnInstant attribute.
void	setSessionIndex(String value) Sets the value of the SessionIndex attribute.
void	setSessionNotOnOrAfter(Date value) Sets the value of the SessionNotOnOrAfter attribute.
void	setSubjectLocality(SubjectLocality value) Sets the value of the SubjectLocality property.

Methods inherited from interface com.sun.identity.saml2.assertion.Statement

isMutable, makeImmutable, toXMLString, toXMLString

Method Detail

getAuthnContext

AuthnContext getAuthnContext()

Returns the value of the AuthnContext property.

Returns:

AuthnContext of the statement.

See Also:

AuthnStatement.setAuthnContext(AuthnContext)

setAuthnContext

void setAuthnContext(AuthnContext value)
              throws SAML2Exception

Sets the value of the AuthnContext property.

Parameters:

value - new AuthnContext.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnStatement.getAuthnContext()

getAuthnInstant

Date getAuthnInstant()

Returns the value of the AuthnInstant attribute.

Returns:

the value of the AuthnInstant attribute.

See Also:

AuthnStatement.setAuthnInstant(Date)

setAuthnInstant

void setAuthnInstant(Date value)
              throws SAML2Exception

Sets the value of the AuthnInstant attribute.

Parameters:

value - new value of AuthnInstant attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnStatement.getAuthnInstant()

getSubjectLocality

SubjectLocality getSubjectLocality()

Returns the value of the SubjectLocality property.

Returns:

SubjectLocality of the statement.

See Also:

AuthnStatement.setSubjectLocality(SubjectLocality)

setSubjectLocality

void setSubjectLocality(SubjectLocality value)
                 throws SAML2Exception

Sets the value of the SubjectLocality property.

Parameters:

value - the new value of SubjectLocality.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnStatement.getSubjectLocality()

getSessionIndex

String getSessionIndex()

Returns the value of the SessionIndex attribute.

Returns:

the value of the SessionIndex attribute.

See Also:

AuthnStatement.setSessionIndex(String)

setSessionIndex

void setSessionIndex(String value)
              throws SAML2Exception

Sets the value of the SessionIndex attribute.

Parameters:

value - new value of SessionIndex attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnStatement.getSessionIndex()

getSessionNotOnOrAfter

Date getSessionNotOnOrAfter()

Returns the value of the SessionNotOnOrAfter attribute.

Returns:

the value of SessionNotOnOrAfter attribute.

See Also:

AuthnStatement.setSessionNotOnOrAfter(Date)

setSessionNotOnOrAfter

void setSessionNotOnOrAfter(Date value)
                     throws SAML2Exception

Sets the value of the SessionNotOnOrAfter attribute.

Parameters:

value - new SessionNotOnOrAfter attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnStatement.getSessionNotOnOrAfter()