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 class FSAuthenticationStatement is used to create or parse AuthenticationStatement Element.

Field Summary

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(org.w3c.dom.Element element)
Constructor

FSAuthenticationStatement(java.lang.String authMethod, java.util.Date authInstant, Subject subject, AuthnContext authnContext)
Constructor

FSAuthenticationStatement(java.lang.String authMethod, java.util.Date authInstant, Subject subject, SubjectLocality subjectLocality, java.util.List authorityBinding, AuthnContext authnContext)
Constructor

Method Summary

AuthnContext	getAuthnContext() Gets AuthnContext.
int	getMinorVersion() Gets minor version
java.util.Date	getReauthenticateOnOrAfter() Gets ReauthenticateOnOrAfter attribute.
java.lang.String	getSessionIndex() Gets SessionIndex attribute.
void	setAuthnContext(AuthnContext authnContext) Sets AuthnContext.
void	setMinorVersion(int version) Sets minor version.
void	setReauthenticateOnOrAfter(java.util.Date reauthenticateOnOrAfter) Sets ReauthenticateOnOrAfter attribute.
void	setSessionIndex(java.lang.String sessionIndex) Sets SessionIndex attribute.
java.lang.String	toXMLString() Returns a String representation of the Authentication Statement.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the AuthenticationStatement

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

getAuthenticaionMethod, getAuthenticationInstant, getAuthorityBinding, getStatementType, getSubjectLocality, setAuthenticaionMethod, setAuthenticationInstant, setAuthorityBinding, setSubjectLocality, toString, toString

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

getSubject, setSubject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FSAuthenticationStatement

public FSAuthenticationStatement()

Default Constructor

FSAuthenticationStatement

public FSAuthenticationStatement(java.lang.String authMethod,
                                 java.util.Date authInstant,
                                 Subject subject,
                                 AuthnContext authnContext)
                          throws SAMLException

Constructor

Parameters:

authMethod - (optional) A String specifies the type of authentication that took place.

authInstant - (optional) A String specifies the time at which the authentication that took place.

subject - (required) A Subject object

authnContext - AuthnContext.

Throws:

SAMLException - if unable to construct the statement object.

FSAuthenticationStatement

public FSAuthenticationStatement(java.lang.String authMethod,
                                 java.util.Date authInstant,
                                 Subject subject,
                                 SubjectLocality subjectLocality,
                                 java.util.List authorityBinding,
                                 AuthnContext authnContext)
                          throws SAMLException

Constructor

Parameters:

authMethod - (optional) A String specifies the type of authentication that took place.

authInstant - (optional) A String specifies the time at which the authentication that took place.

subject - (required) A Subject object

subjectLocality - (optional) A SubjectLocality object.

authorityBinding - (optional) A List of AuthorityBinding objects.

authnContext - AuthnContext object.

Throws:

SAMLException - if unable to construct the object.

FSAuthenticationStatement

public FSAuthenticationStatement(org.w3c.dom.Element element)
                          throws FSMsgException,
                                 SAMLException

Constructor

Parameters:

element - DOM Element for the authentication statement.

Throws:

FSMsgException - if unable to construct the object

SAMLException - if there is an error in the sender or in the

Method Detail

getSessionIndex

public java.lang.String getSessionIndex()

Gets SessionIndex attribute.

Returns:

SessionIndex attribute.

setSessionIndex

public void setSessionIndex(java.lang.String sessionIndex)

Sets SessionIndex attribute.

Parameters:

sessionIndex - session index to be set.

getReauthenticateOnOrAfter

public java.util.Date getReauthenticateOnOrAfter()

Gets ReauthenticateOnOrAfter attribute.

Returns:

ReauthenticateOnOrAfter as date

setReauthenticateOnOrAfter

public void setReauthenticateOnOrAfter(java.util.Date reauthenticateOnOrAfter)

Sets ReauthenticateOnOrAfter attribute.

Parameters:

reauthenticateOnOrAfter - ReauthenticateOnOrAfter to be set.

getAuthnContext

public AuthnContext getAuthnContext()

Gets AuthnContext.

Returns:

AuthnContext

setAuthnContext

public void setAuthnContext(AuthnContext authnContext)

Sets AuthnContext.

Parameters:

authnContext - AuthnContext to be set

getMinorVersion

public int getMinorVersion()

Gets minor version

Returns:

minor version

setMinorVersion

public void setMinorVersion(int version)

Sets minor version.

Parameters:

version - minor version to be set.

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Returns a String representation of the Authentication Statement.

Returns:

A String representation of the <saml:AuthenticationStatement> element.

Throws:

FSMsgException - if unable to get the XML string.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Returns a String representation of the AuthenticationStatement

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 representation of the <saml:AuthenticationStatement> element.

Throws:

FSMsgException - if unable to get the XML string.