Package org.opensaml.xmlsec.signature

Interface KeyInfo

All Superinterfaces:
XMLObject
All Known Subinterfaces:
OriginatorKeyInfo, RecipientKeyInfo
All Known Implementing Classes:
KeyInfoImpl, OriginatorKeyInfoImpl, RecipientKeyInfoImpl
public interface KeyInfo extends XMLObject
XMLObject representing XML Digital Signature, version 20020212, KeyInfo element.

  • Field Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      static final String DEFAULT_ELEMENT_LOCAL_NAME
      Element local name.
      See Also:

    • DEFAULT_ELEMENT_NAME

      static final QName DEFAULT_ELEMENT_NAME
      Default element name.

    • TYPE_LOCAL_NAME

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

    • TYPE_NAME

      static final QName TYPE_NAME
      QName of the XSI type.

    • ID_ATTRIB_NAME

      static final String ID_ATTRIB_NAME
      Id attribute name.
      See Also:

  • Method Details

    • getID

      @Nullable String getID()
      Get the Id attribute value.
      Returns:
      the Id attribute value

    • setID

      void setID(@Nullable String newID)
      Set the Id attribute value.
      Parameters:
      newID - the new Id attribute value

    • getXMLObjects

      @Nonnull List<XMLObject> getXMLObjects()
      Get the list of all XMLObject children.
      Returns:
      the list of XMLObject children

    • getXMLObjects

      @Nonnull List<XMLObject> getXMLObjects(@Nonnull QName typeOrName)
      Get the list of XMLObject children whose type or element QName matches the specified QName.
      Parameters:
      typeOrName - the QName of the desired elements
      Returns:
      the matching list of XMLObject children

    • getKeyNames

      @Nonnull List<KeyName> getKeyNames()
      Get the list of KeyName child elements.
      Returns:
      the list of KeyName child elements

    • getKeyValues

      @Nonnull List<KeyValue> getKeyValues()
      Get the list of KeyValue child elements.
      Returns:
      the list of KeyValue child elements

    • getDEREncodedKeyValues

      @Nonnull List<DEREncodedKeyValue> getDEREncodedKeyValues()
      Get the list of DEREncodedKeyValue child elements.
      Returns:
      the list of DEREncodedKeyValue child elements

    • getRetrievalMethods

      @Nonnull List<RetrievalMethod> getRetrievalMethods()
      Get the list of RetrievalMethod child elements.
      Returns:
      the list of RetrievalMethod child elements

    • getKeyInfoReferences

      @Nonnull List<KeyInfoReference> getKeyInfoReferences()
      Get the list of KeyInfoReference child elements.
      Returns:
      the list of KeyInfoReference child elements

    • getX509Datas

      @Nonnull List<X509Data> getX509Datas()
      Get the list of X509Data child elements.
      Returns:
      the list of X509Data child elements

    • getPGPDatas

      @Nonnull List<PGPData> getPGPDatas()
      Get the list of PGPData child elements.
      Returns:
      the list of PGPData child elements

    • getSPKIDatas

      @Nonnull List<SPKIData> getSPKIDatas()
      Get the list of SPKIData child elements.
      Returns:
      the list of SPKIData child elements

    • getMgmtDatas

      @Nonnull List<MgmtData> getMgmtDatas()
      Get the list of MgmtData child elements.
      Returns:
      the list of MgmtData child elements

    • getAgreementMethods

      @Nonnull List<AgreementMethod> getAgreementMethods()
      Get the list of AgreementMethod child elements. Note: AgreementMethod is actually defined in the XML Encryption schema, and is not explicitly defined in the KeyInfoType content model, but for convenience this named getter method is exposed.
      Returns:
      the list of AgreementMethod child elements

    • getEncryptedKeys

      @Nonnull List<EncryptedKey> getEncryptedKeys()
      Get the list of EncryptedKey child elements Note: EncryptedKey is actually defined in the XML Encryption schema, and is not explicitly defined in the KeyInfoType content model, but for convenience this named getter method is exposed.
      Returns:
      the list of EncryptedKey child elements