Package com.sun.identity.saml2.assertion

Interface SubjectConfirmationData

All Superinterfaces:
XmlSerializable
All Known Subinterfaces:
KeyInfoConfirmationData
@SupportedAll public interface SubjectConfirmationData extends XmlSerializable
The SubjectConfirmationData specifies additional data that allows the subject to be confirmed or constrains the circumstances under which the act of subject confirmation can take place. Subject confirmation takes place when a relying party seeks to verify the relationship between an entity presenting the assertion and the subject of the assertion's claims.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAddress()
    Returns the network address/location from which an attesting entity can present the assertion
    List
    getContent()
    Returns a list of arbitrary XML elements to be added to this SubjectConfirmationData object.
    String
    getContentType()
    Returns the content type attribute
    String
    getInResponseTo()
    Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertion
    Date
    getNotBefore()
    Returns the time instant before which the subject cannot be confirmed
    Date
    getNotOnOrAfter()
    Returns the time instant at which the subject can no longer be confirmed
    String
    getRecipient()
    Returns the URI specifying the entity or location to which an attesting entity can present the assertion
    boolean
    isMutable()
    Returns true if the object is mutable
    void
    makeImmutable()
    Makes the object immutable
    void
    setAddress(String value)
    Sets the network address/location from which an attesting entity can present the assertion
    void
    setContent(List content)
    Sets a list of arbitrary XML elements to be added to this SubjectConfirmationData object.
    void
    setContentType(String attribute)
    Sets the content type attribute
    void
    setInResponseTo(String value)
    Sets the ID of a SAML protocol message in response to which an attesting entity can present the assertion
    void
    setNotBefore(Date value)
    Sets the time instant before which the subject cannot be confirmed
    void
    setNotOnOrAfter(Date value)
    Sets the time instant at which the subject can no longer be confirmed
    void
    setRecipient(String value)
    Sets the URI specifying the entity or location to which an attesting entity can present the assertion

    Methods inherited from interface com.sun.identity.saml2.common.XmlSerializable

    toDocumentFragment, toXMLString, toXMLString

  • Method Details

    • getNotOnOrAfter

      Date getNotOnOrAfter()
      Returns the time instant at which the subject can no longer be confirmed
      Returns:
      the time instant at which the subject can no longer be confirmed

    • setNotOnOrAfter

      void setNotOnOrAfter(Date value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the time instant at which the subject can no longer be confirmed
      Parameters:
      value - the time instant at which the subject can no longer be confirmed
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getInResponseTo

      String getInResponseTo()
      Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertion
      Returns:
      the ID of a SAML protocol message in response to which an attesting entity can present the assertion

    • setInResponseTo

      void setInResponseTo(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the ID of a SAML protocol message in response to which an attesting entity can present the assertion
      Parameters:
      value - the ID of a SAML protocol message in response to which an attesting entity can present the assertion
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getContent

      List getContent()
      Returns a list of arbitrary XML elements to be added to this SubjectConfirmationData object.
      Returns:
      a list of arbitrary XML elements to be added to this SubjectConfirmationData object.

    • setContent

      void setContent(List content) throws com.sun.identity.saml2.common.SAML2Exception
      Sets a list of arbitrary XML elements to be added to this SubjectConfirmationData object.
      Parameters:
      content - a list of arbitrary XML elements to be added to this SubjectConfirmationData object.
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getRecipient

      String getRecipient()
      Returns the URI specifying the entity or location to which an attesting entity can present the assertion
      Returns:
      the URI specifying the entity or location to which an attesting entity can present the assertion

    • setRecipient

      void setRecipient(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the URI specifying the entity or location to which an attesting entity can present the assertion
      Parameters:
      value - the URI specifying the entity or location to which an attesting entity can present the assertion
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getNotBefore

      Date getNotBefore()
      Returns the time instant before which the subject cannot be confirmed
      Returns:
      the time instant before which the subject cannot be confirmed

    • setNotBefore

      void setNotBefore(Date value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the time instant before which the subject cannot be confirmed
      Parameters:
      value - the time instant before which the subject cannot be confirmed
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getAddress

      String getAddress()
      Returns the network address/location from which an attesting entity can present the assertion
      Returns:
      the network address/location from which an attesting entity can present the assertion

    • setAddress

      void setAddress(String value) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the network address/location from which an attesting entity can present the assertion
      Parameters:
      value - the network address/location from which an attesting entity can present the assertion
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable

    • getContentType

      String getContentType()
      Returns the content type attribute
      Returns:
      the content type attribute
      See Also:

    • setContentType

      void setContentType(String attribute) throws com.sun.identity.saml2.common.SAML2Exception
      Sets the content type attribute
      Parameters:
      attribute - attribute type value for the content that will be added
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the object is immutable
      See Also:

    • makeImmutable

      void makeImmutable()
      Makes the object immutable

    • isMutable

      boolean isMutable()
      Returns true if the object is mutable
      Returns:
      true if the object is mutable