com.sun.identity.saml.assertion
Class AuthenticationStatement

java.lang.Object
  |
  +--com.sun.identity.saml.assertion.Statement
        |
        +--com.sun.identity.saml.assertion.SubjectStatement
              |
              +--com.sun.identity.saml.assertion.AuthenticationStatement

public class AuthenticationStatement

extends SubjectStatement

The <AuthenticationStatement> element supplies a statement by the issuer that its subject was authenticated by a particular means at a particular time. The <AuthenticationStatement> element is of type AuthenticationStatementType, which extends the SubjectStatementAbstractType with the additional element and attributes.

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

ATTRIBUTE_STATEMENT, AUTHENTICATION_STATEMENT, AUTHORIZATION_DECISION_STATEMENT, NOT_SUPPORTED

Constructor Summary

AuthenticationStatement(org.w3c.dom.Element element)
This constructor builds an authentication statement element from an existing XML block.

AuthenticationStatement(java.lang.String authMethod, java.util.Date authInstant, Subject subject)
Constructor for authentication statement

AuthenticationStatement(java.lang.String authMethod, java.util.Date authInstant, Subject subject, SubjectLocality subjectLocality, java.util.List authorityBinding)
Constructor for authentication statement

Method Summary

java.lang.String	getAuthenticaionMethod() Returns AuthenticationMethod from authentication statement
java.util.Date	getAuthenticationInstant() Returns AuthenticationInstant from authentication statement.
java.util.List	getAuthorityBinding() Returns the AuthorityBinding from AuthenticationStatement.
int	getStatementType() Get the real type of the Statement.
SubjectLocality	getSubjectLocality() Returns the SubjectLocality from AuthenticationStatement
boolean	setAuthenticaionMethod(java.lang.String authenticationmethod) Set AuthenticationMethod for AuthenticationStatement.
boolean	setAuthenticationInstant(java.util.Date authenticationinstant) Set AuthenticationInstant for AuthenticationStatement.
boolean	setAuthorityBinding(java.util.List authoritybinding) Set the AuthorityBinding for AuthenticationStatement.
boolean	setSubjectLocality(SubjectLocality subjectlocality) Set the SubjectLocality for AuthenticationStatement.
java.lang.String	toString() Returns a String representation of the Authentication Statement.
java.lang.String	toString(boolean includeNS, boolean declareNS) Returns a String representation of the AuthenticationStatement

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

AuthenticationStatement

public AuthenticationStatement(org.w3c.dom.Element element)
                        throws SAMLException

This constructor builds an authentication statement element from an existing XML block.

Parameters:

element - representing a DOM tree element.

Throws:

SAMLException - if there is an error in the sender or in the element definition.

AuthenticationStatement

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

Constructor for authentication statement

Parameters:

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

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

subject - (required) A Subject object

Throws:

SAMLException - if there is an error in the sender.

AuthenticationStatement

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

Constructor for authentication statement

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.

Throws:

SAMLException - if there is an error in the sender.

Method Detail

getSubjectLocality

public SubjectLocality getSubjectLocality()

Returns the SubjectLocality from AuthenticationStatement

Returns:

The SubjectLocality object within the authentication statement.

setSubjectLocality

public boolean setSubjectLocality(SubjectLocality subjectlocality)

Set the SubjectLocality for AuthenticationStatement.

Parameters:

subjectlocality - The SubjectLocality object within the AuthenticationStatement.

Returns:

true if the operation is successful.

getAuthenticaionMethod

public java.lang.String getAuthenticaionMethod()

Returns AuthenticationMethod from authentication statement

Returns:

A String representing the authentication method of the authentication statement.

setAuthenticaionMethod

public boolean setAuthenticaionMethod(java.lang.String authenticationmethod)

Set AuthenticationMethod for AuthenticationStatement.

Parameters:

authenticationmethod - input authentication method

Returns:

true if the operation is successful. Otherwise return false.

getAuthenticationInstant

public java.util.Date getAuthenticationInstant()

Returns AuthenticationInstant from authentication statement.

Returns:

The date/time when the authentication statement is created.

setAuthenticationInstant

public boolean setAuthenticationInstant(java.util.Date authenticationinstant)

Set AuthenticationInstant for AuthenticationStatement.

Parameters:

authenticationinstant - The date/time when the authentication statement is created.

Returns:

true if the operation is successful.

getAuthorityBinding

public java.util.List getAuthorityBinding()

Returns the AuthorityBinding from AuthenticationStatement.

Returns:

A list of the AuthorityBinding objects

setAuthorityBinding

public boolean setAuthorityBinding(java.util.List authoritybinding)

Set the AuthorityBinding for AuthenticationStatement.

Parameters:

authoritybinding - A list of the AuthorityBinding objects.

Returns:

true if the operation is successful.

getStatementType

public int getStatementType()

Get the real type of the Statement. This method returns Statement.AUTHENTICATION_STATEMENT.

Overrides:

getStatementType in class Statement

Returns:

an integer which is Statement.AUTHENTICATION_STATEMENT.

toString

public java.lang.String toString()

Returns a String representation of the Authentication Statement.

Overrides:

toString in class java.lang.Object

Returns:

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

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)

Returns a String representation of the AuthenticationStatement

Overrides:

toString in class SubjectStatement

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.