Package org.opensaml.saml.saml1.core

Interface Assertion

All Superinterfaces:
Evidentiary, SAMLObject, SignableSAMLObject, SignableXMLObject, XMLObject
All Known Implementing Classes:
AssertionImpl
public interface Assertion extends SignableSAMLObject, Evidentiary
This interface defines how the object representing a SAML 1 Assertion element behaves.

  • Field Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      @Nonnull @NotEmpty static final String DEFAULT_ELEMENT_LOCAL_NAME
      Element name, no namespace.
      See Also:

    • DEFAULT_ELEMENT_NAME

      @Nonnull static final QName DEFAULT_ELEMENT_NAME
      Default element name.

    • TYPE_LOCAL_NAME

      @Nonnull @NotEmpty static final String TYPE_LOCAL_NAME
      Local name of the XSI type.
      See Also:

    • TYPE_NAME

      @Nonnull static final QName TYPE_NAME
      QName of the XSI type.

    • MAJORVERSION_ATTRIB_NAME

      @Nonnull @NotEmpty static final String MAJORVERSION_ATTRIB_NAME
      Name for the attribute which defines Major Version (attribute's value must be 1).
      See Also:

    • MINORVERSION_ATTRIB_NAME

      @Nonnull @NotEmpty static final String MINORVERSION_ATTRIB_NAME
      Name for the attribute which defines Minor Version.
      See Also:

    • ASSERTIONID_ATTRIB_NAME

      @Nonnull @NotEmpty static final String ASSERTIONID_ATTRIB_NAME
      Name for the attribute which defines Assertion ID.
      See Also:

    • ISSUER_ATTRIB_NAME

      @Nonnull @NotEmpty static final String ISSUER_ATTRIB_NAME
      Name for the attribute which defines Issuer.
      See Also:

    • ISSUEINSTANT_ATTRIB_NAME

      @Nonnull @NotEmpty static final String ISSUEINSTANT_ATTRIB_NAME
      Name for the attribute which defines the issue instant.
      See Also:

    • ISSUEINSTANT_ATTRIB_QNAME

      @Nonnull static final QName ISSUEINSTANT_ATTRIB_QNAME
      QName for the attribute which defines the issue instant.

    • ID_ATTRIB_NAME

      @Nonnull @NotEmpty static final String ID_ATTRIB_NAME
      Name for the attribute which defines the Issue Instant.
      See Also:

  • Method Details

    • getID

      @Nullable String getID()
      Set the ID.
      Returns:
      the ID

    • setID

      void setID(@Nullable String id)
      Get the ID.
      Parameters:
      id - what to set

    • getMajorVersion

      @Deprecated(since="5.0.0", forRemoval=true) @Nullable Integer getMajorVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the MajorVersion attribute.

      Deprecated, use getVersion().

      Returns:
      the stored MajorVersion

    • getMinorVersion

      @Deprecated(since="5.0.0", forRemoval=true) @Nullable Integer getMinorVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the MinorVersion attribute.

      Deprecated, use getVersion().

      Returns:
      the stored MinorVersion

    • getVersion

      @Nullable SAMLVersion getVersion()
      Gets the SAML version for this message.
      Returns:
      SAML version for this message
      Since:
      5.0.0

    • setVersion

      void setVersion(@Nullable SAMLVersion version)
      Set the SAML version of this assertion.
      Parameters:
      version - the SAML version of this assertion

    • getIssuer

      @Nullable String getIssuer()
      Get the Issuer (which is an attribute) .
      Returns:
      the Issuer

    • setIssuer

      void setIssuer(@Nullable String issuer)
      Set the Issuer (attribute).
      Parameters:
      issuer - the value to set

    • getIssueInstant

      @Nullable Instant getIssueInstant()
      Get the IssueInstant (attribute).
      Returns:
      the Issue Instant (as a Date)

    • setIssueInstant

      void setIssueInstant(@Nullable Instant issueInstant)
      Set the IssueInstance (attribute).
      Parameters:
      issueInstant - the issue instant value to set

    • getConditions

      @Nullable Conditions getConditions()
      Return the (singleton) Object, representing the Conditions sub element.
      Returns:
      the Conditions object.

    • setConditions

      void setConditions(@Nullable Conditions conditions)
      Set the Object representing the Conditions Sub element.
      Parameters:
      conditions - the condition to List

    • getAdvice

      @Nullable Advice getAdvice()
      advice is a (singleton) Object, representing the Advice sub element.
      Returns:
      the advice object in this assertion

    • setAdvice

      void setAdvice(@Nullable Advice advice)
      Set the Object representing the Advice sub element.
      Parameters:
      advice - the object to set

    • getStatements

      @Nonnull @Live List<Statement> getStatements()
      Return the List representing all the Statement sub elements.
      Returns:
      the List representing all the statements

    • getStatements

      @Nonnull @Live List<Statement> getStatements(@Nonnull QName typeOrName)
      Return the List representing all the Statement sub elements with a given schema type or element name.
      Parameters:
      typeOrName - the schema type or element name
      Returns:
      the List representing all the statements

    • getSubjectStatements

      @Nonnull @Live List<SubjectStatement> getSubjectStatements()
      Return the List representing all the SubjectStatement sub elements.
      Returns:
      all the SubjectStatements

    • getAuthenticationStatements

      @Nonnull @Live List<AuthenticationStatement> getAuthenticationStatements()
      Return the List representing all the AuthenticationStatement sub elements.
      Returns:
      all the AuthenticationStatements

    • getAuthorizationDecisionStatements

      @Nonnull @Live List<AuthorizationDecisionStatement> getAuthorizationDecisionStatements()
      Return the List representing all the AuthorizationStatement sub elements.
      Returns:
      all the authorizationDecisionStatements.

    • getAttributeStatements

      @Nonnull @Live List<AttributeStatement> getAttributeStatements()
      Return all the AttributeStatement elements.
      Returns:
      all the attributeStatements