com.sun.identity.federation.message
Class FSAuthenticationStatement

java.lang.Object
  com.sun.identity.saml.assertion.Statement
      com.sun.identity.saml.assertion.SubjectStatement
          com.sun.identity.saml.assertion.AuthenticationStatement
              com.sun.identity.federation.message.FSAuthenticationStatement

public class FSAuthenticationStatement
extends AuthenticationStatement

The FSAuthenticationStatement element represents an authentication statement by the issuer that it's subject was authenticated by a particular means at a particular time.

Field Summary

protected AuthnContext	_authnContext
protected int	minorVersion
protected Date	reauthenticateOnOrAfter
protected String	sessionIndex

Fields inherited from class com.sun.identity.saml.assertion.AuthenticationStatement

_authenticationInstant, _authenticationMethod, _authorityBinding, _subjectLocality

Fields inherited from class com.sun.identity.saml.assertion.SubjectStatement

_subject

Fields inherited from class com.sun.identity.saml.assertion.Statement

ATTRIBUTE_STATEMENT, AUTHENTICATION_STATEMENT, AUTHORIZATION_DECISION_STATEMENT, NOT_SUPPORTED

Constructor Summary

FSAuthenticationStatement()
Default Constructor.

FSAuthenticationStatement(Element element)
Constructs an FSAuthenticationStatement object from a Document Element.

FSAuthenticationStatement(String authMethod, Date authInstant, Subject subject, AuthnContext authnContext)
Constructor to create FSAuthenticationStatement object.

FSAuthenticationStatement(String authMethod, Date authInstant, Subject subject, SubjectLocality subjectLocality, List authorityBinding, AuthnContext authnContext)
Constructor for create FSAuthenticationStatement object.

Method Summary

AuthnContext	getAuthnContext() Returns the Authentication Context in this authentication statement.
int	getMinorVersion() Returns the value of MinorVersion attribute.
Date	getReauthenticateOnOrAfter() Returns the re-authentication date for this authentication statement.
String	getSessionIndex() Returns the value of SessionIndex attribute.
void	setAuthnContext(AuthnContext authnContext) Sets the Authentication Context object.
void	setMinorVersion(int version) Sets the value of MinorVersion attribute.
void	setReauthenticateOnOrAfter(Date reauthenticateOnOrAfter) Sets re-authentication date for this authentication statement.
void	setSessionIndex(String sessionIndex) Sets the SessionIndex attribute.
String	toXMLString() Returns a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of this object.

Methods inherited from class com.sun.identity.saml.assertion.AuthenticationStatement

createAuthorityBinding, createSubject, createSubjectLocality, getAuthenticaionMethod, getAuthenticationInstant, getAuthorityBinding, getStatementType, getSubjectLocality, setAuthenticaionMethod, setAuthenticationInstant, setAuthorityBinding, setSubjectLocality, toString, toString

Methods inherited from class com.sun.identity.saml.assertion.SubjectStatement

getSubject, setSubject

Field Detail

reauthenticateOnOrAfter

protected Date reauthenticateOnOrAfter

sessionIndex

protected String sessionIndex

_authnContext

protected AuthnContext _authnContext

minorVersion

protected int minorVersion

Constructor Detail

FSAuthenticationStatement

public FSAuthenticationStatement()

Default Constructor.

FSAuthenticationStatement

public FSAuthenticationStatement(String authMethod,
                                 Date authInstant,
                                 Subject subject,
                                 AuthnContext authnContext)
                          throws FSMsgException,
                                 SAMLException

Constructor to create FSAuthenticationStatement object.

Parameters:

authMethod - the Authentication method in the statement.

authInstant - the authentication date in the statement.

subject - the Subject in the statement.

authnContext - the Authentication Context.

Throws:

FSMsgException - if there is error creating the object.

SAMLException - if the version is incorrect.

FSAuthenticationStatement

public FSAuthenticationStatement(String authMethod,
                                 Date authInstant,
                                 Subject subject,
                                 SubjectLocality subjectLocality,
                                 List authorityBinding,
                                 AuthnContext authnContext)
                          throws FSMsgException,
                                 SAMLException

Constructor for create FSAuthenticationStatement object.

Parameters:

authMethod - the Authentication method in the statement.

authInstant - the authentication date in the statement.

subject - the Subject in the statement.

subjectLocality - the SubjectLocality in the statement.

authorityBinding - a List of AuthorityBinding objects.

authnContext - the Authentication Context.

Throws:

FSMsgException - if there is an error creating the object.

SAMLException - on error.

FSAuthenticationStatement

public FSAuthenticationStatement(Element element)
                          throws FSMsgException,
                                 SAMLException

Constructs an FSAuthenticationStatement object from a Document Element.

Parameters:

element - the Document Element object.

Throws:

FSMsgException - if document element is null or required attributes cannot be retrieved from the element.

SAMLException - on error.

Method Detail

getSessionIndex

public String getSessionIndex()

Returns the value of SessionIndex attribute.

Returns:

the value of SessionIndex attribute.

See Also:

FSAuthenticationStatement.setSessionIndex(String)

setSessionIndex

public void setSessionIndex(String sessionIndex)

Sets the SessionIndex attribute.

Parameters:

sessionIndex - the value of SessionIndex attribute.

See Also:

FSAuthenticationStatement.getSessionIndex()

getReauthenticateOnOrAfter

public Date getReauthenticateOnOrAfter()

Returns the re-authentication date for this authentication statement.

Returns:

the re-authentication date for this object.

See Also:

FSAuthenticationStatement.setReauthenticateOnOrAfter(java.util.Date)

setReauthenticateOnOrAfter

public void setReauthenticateOnOrAfter(Date reauthenticateOnOrAfter)

Sets re-authentication date for this authentication statement.

Parameters:

reauthenticateOnOrAfter - the date object.

See Also:

FSAuthenticationStatement.getReauthenticateOnOrAfter()

getAuthnContext

public AuthnContext getAuthnContext()

Returns the Authentication Context in this authentication statement.

Returns:

the Authentication Context object.

See Also:

FSAuthenticationStatement.setAuthnContext(AuthnContext)

setAuthnContext

public void setAuthnContext(AuthnContext authnContext)

Sets the Authentication Context object.

Parameters:

authnContext - the Authentication Context object.

See Also:

FSAuthenticationStatement.getAuthnContext()

getMinorVersion

public int getMinorVersion()

Returns the value of MinorVersion attribute.

Returns:

the value of MinorVersion attribute.

See Also:

FSAuthenticationStatement.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the value of MinorVersion attribute.

Parameters:

version - the MinorVersion attribute.

See Also:

FSAuthenticationStatement.getMinorVersion()

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a String representation of this object.

Returns:

a String representation of this Object.

Throws:

FSMsgException - if there is an error creating the string.

toXMLString

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

Returns a String representation of this object.

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 object.

Throws:

FSMsgException - if there is an error creating the string.