Package 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
@SupportedAll 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.

  • Field Details

    • _authenticationMethod

      protected String _authenticationMethod

    • _authenticationInstant

      protected Date _authenticationInstant

    • _subjectLocality

      protected SubjectLocality _subjectLocality

    • _authorityBinding

      protected List _authorityBinding

  • Constructor Details

    • AuthenticationStatement

      protected AuthenticationStatement()
      Default constructor

    • AuthenticationStatement

      public AuthenticationStatement(Element element) throws SAMLException
      Constructs 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(String authMethod, Date authInstant, Subject subject) throws SAMLException
      Constructs 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(String authMethod, Date authInstant, Subject subject, SubjectLocality subjectLocality, List authorityBinding) throws SAMLException
      Constructs AuthenticationStatement
      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 Details

    • getSubjectLocality

      public SubjectLocality getSubjectLocality()
      Returns the SubjectLocality from AuthenticationStatement
      Returns:
      The SubjectLocality object within the authentication statement.

    • setSubjectLocality

      public boolean setSubjectLocality(SubjectLocality subjectlocality)
      Sets the SubjectLocality for AuthenticationStatement.
      Parameters:
      subjectlocality - The SubjectLocality object within the AuthenticationStatement.
      Returns:
      true if the operation is successful.

    • getAuthenticaionMethod

      public String getAuthenticaionMethod()
      Returns AuthenticationMethod from authentication statement
      Returns:
      A String representing the authentication method of the authentication statement.

    • setAuthenticaionMethod

      public boolean setAuthenticaionMethod(String authenticationmethod)
      Sets AuthenticationMethod for AuthenticationStatement.
      Parameters:
      authenticationmethod - input authentication method
      Returns:
      true if the operation is successful. Otherwise return false.

    • getAuthenticationInstant

      public Date getAuthenticationInstant()
      Returns AuthenticationInstant from authentication statement.
      Returns:
      The date/time when the authentication statement is created.

    • setAuthenticationInstant

      public boolean setAuthenticationInstant(Date authenticationinstant)
      Sets AuthenticationInstant for AuthenticationStatement.
      Parameters:
      authenticationinstant - The date/time when the authentication statement is created.
      Returns:
      true if the operation is successful.

    • getAuthorityBinding

      public List getAuthorityBinding()
      Returns the AuthorityBinding from AuthenticationStatement.
      Returns:
      A list of the AuthorityBinding objects

    • setAuthorityBinding

      public boolean setAuthorityBinding(List authoritybinding)
      Sets the AuthorityBinding for AuthenticationStatement.
      Parameters:
      authoritybinding - A list of the AuthorityBinding objects.
      Returns:
      true if the operation is successful.

    • getStatementType

      public int getStatementType()
      Gets the real type of the Statement. This method returns Statement.AUTHENTICATION_STATEMENT.
      Specified by:
      getStatementType in class Statement
      Returns:
      an integer which is Statement.AUTHENTICATION_STATEMENT.

    • toString

      public String toString()
      Returns a String representation of the Authentication Statement.
      Overrides:
      toString in class Object
      Returns:
      A String representation of the <saml:AuthenticationStatement> element.

    • toString

      public String toString(boolean includeNS, boolean declareNS)
      Returns a String representation of the AuthenticationStatement
      Specified by:
      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.

    • createSubject

      protected Subject createSubject(Element subjectElement) throws SAMLException
      Throws:
      SAMLException

    • createSubjectLocality

      protected SubjectLocality createSubjectLocality(Element subjectLocalityElement) throws SAMLException
      Throws:
      SAMLException

    • createAuthorityBinding

      protected AuthorityBinding createAuthorityBinding(Element authorityBindingElement) throws SAMLException
      Throws:
      SAMLException