com.sun.identity.saml2.assertion.impl

Class AuthnStatementImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.AuthnStatementImpl

All Implemented Interfaces:

AuthnStatement, Statement

public class AuthnStatementImpl
extends Object
implements AuthnStatement

This is the default implementation of interface AuthnStatement. 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>
 

Constructor Summary

Constructors

Constructor and Description
AuthnStatementImpl() Class constructor.
AuthnStatementImpl(Element element) Class constructor with AuthnStatement in Element format.
AuthnStatementImpl(String xmlString) Class constructor with AuthnStatement in xml string format.

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.
boolean	isMutable() Returns the mutability of the object.
void	makeImmutable() Makes the object immutable.
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.
String	toXMLString() Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthnStatementImpl

public AuthnStatementImpl()

Class constructor. Caller may need to call setters to populate the object.

AuthnStatementImpl

public AuthnStatementImpl(Element element)
                   throws SAML2Exception

Class constructor with AuthnStatement in Element format.

Throws:

SAML2Exception

AuthnStatementImpl

public AuthnStatementImpl(String xmlString)
                   throws SAML2Exception

Class constructor with AuthnStatement in xml string format.

Throws:

SAML2Exception

Method Detail

getAuthnContext

public AuthnContext getAuthnContext()

Returns the value of the AuthnContext property.

Specified by:

getAuthnContext in interface AuthnStatement

Returns:

AuthnContext of the statement.

See Also:

setAuthnContext(AuthnContext)

setAuthnContext

public void setAuthnContext(AuthnContext value)
                     throws SAML2Exception

Sets the value of the AuthnContext property.

Specified by:

setAuthnContext in interface AuthnStatement

Parameters:

value - new AuthnContext.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContext()

getAuthnInstant

public Date getAuthnInstant()

Returns the value of the AuthnInstant attribute.

Specified by:

getAuthnInstant in interface AuthnStatement

Returns:

the value of the AuthnInstant attribute.

See Also:

setAuthnInstant(Date)

setAuthnInstant

public void setAuthnInstant(Date value)
                     throws SAML2Exception

Sets the value of the AuthnInstant attribute.

Specified by:

setAuthnInstant in interface AuthnStatement

Parameters:

value - new value of AuthnInstant attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnInstant()

getSubjectLocality

public SubjectLocality getSubjectLocality()

Returns the value of the SubjectLocality property.

Specified by:

getSubjectLocality in interface AuthnStatement

Returns:

SubjectLocality of the statement.

See Also:

setSubjectLocality(SubjectLocality)

setSubjectLocality

public void setSubjectLocality(SubjectLocality value)
                        throws SAML2Exception

Sets the value of the SubjectLocality property.

Specified by:

setSubjectLocality in interface AuthnStatement

Parameters:

value - the new value of SubjectLocality.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getSubjectLocality()

getSessionIndex

public String getSessionIndex()

Returns the value of the SessionIndex attribute.

Specified by:

getSessionIndex in interface AuthnStatement

Returns:

the value of the SessionIndex attribute.

See Also:

setSessionIndex(String)

setSessionIndex

public void setSessionIndex(String value)
                     throws SAML2Exception

Sets the value of the SessionIndex attribute.

Specified by:

setSessionIndex in interface AuthnStatement

Parameters:

value - new value of SessionIndex attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getSessionIndex()

getSessionNotOnOrAfter

public Date getSessionNotOnOrAfter()

Returns the value of the SessionNotOnOrAfter attribute.

Specified by:

getSessionNotOnOrAfter in interface AuthnStatement

Returns:

the value of SessionNotOnOrAfter attribute.

See Also:

setSessionNotOnOrAfter(Date)

setSessionNotOnOrAfter

public void setSessionNotOnOrAfter(Date value)
                            throws SAML2Exception

Sets the value of the SessionNotOnOrAfter attribute.

Specified by:

setSessionNotOnOrAfter in interface AuthnStatement

Parameters:

value - new SessionNotOnOrAfter attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getSessionNotOnOrAfter()

makeImmutable

public void makeImmutable()

Makes the object immutable.

Specified by:

makeImmutable in interface Statement

isMutable

public boolean isMutable()

Returns the mutability of the object.

Specified by:

isMutable in interface Statement

Returns:

true if the object is mutable; false otherwise.

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Statement

Returns:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

Throws:

SAML2Exception - if the object does not conform to the schema.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Statement

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A string containing the valid XML for this element

Throws:

SAML2Exception - if the object does not conform to the schema.