Package org.opensaml.xmlsec.signature.impl

Class SignatureImpl

java.lang.Object
org.opensaml.core.xml.AbstractXMLObject
org.opensaml.xmlsec.signature.impl.SignatureImpl
All Implemented Interfaces:
XMLObject, Signature
public class SignatureImpl extends AbstractXMLObject implements Signature
XMLObject representing an enveloped or detached XML Digital Signature, version 20020212, Signature element.

  • Field Details

    • canonicalizationAlgorithm

      @Nullable private String canonicalizationAlgorithm
      Canonicalization algorithm used in signature.

    • signatureAlgorithm

      @Nullable private String signatureAlgorithm
      Algorithm used to generate the signature.

    • hmacOutputLength

      @Nullable private Integer hmacOutputLength
      Optional HMAC output length parameter to the signature algorithm.

    • signingCredential

      @Nullable private Credential signingCredential
      Key used to sign the signature.

    • keyInfo

      @Nullable private KeyInfo keyInfo
      Public key information to embed in the signature.

    • contentReferences

      @Nonnull private List<ContentReference> contentReferences
      References to content to be signed.

    • xmlSignature

      @Nullable private org.apache.xml.security.signature.XMLSignature xmlSignature
      Constructed Apache XML Security signature object.

  • Constructor Details

    • SignatureImpl

      protected SignatureImpl(@Nullable String namespaceURI, @Nonnull String elementLocalName, @Nullable String namespacePrefix)
      Constructor.
      Parameters:
      namespaceURI - the namespace the element is in
      elementLocalName - the local name of the XML element this Object represents
      namespacePrefix - the prefix for the given namespace

  • Method Details

    • getCanonicalizationAlgorithm

      @Nullable public String getCanonicalizationAlgorithm()
      Gets the canonicalization algorithm used to create the signature content.
      Specified by:
      getCanonicalizationAlgorithm in interface Signature
      Returns:
      the canonicalization algorithm used to create the signature content

    • setCanonicalizationAlgorithm

      public void setCanonicalizationAlgorithm(@Nullable String newAlgorithm)
      Sets the canonicalization algorithm used to create the signature content.
      Specified by:
      setCanonicalizationAlgorithm in interface Signature
      Parameters:
      newAlgorithm - the canonicalization algorithm used to create the signature content

    • getSignatureAlgorithm

      @Nullable public String getSignatureAlgorithm()
      Gets the algorithm used to compute the signature.
      Specified by:
      getSignatureAlgorithm in interface Signature
      Returns:
      the algorithm used to compute the signature

    • setSignatureAlgorithm

      public void setSignatureAlgorithm(@Nullable String newAlgorithm)
      Sets the algorithm used to compute the signature.
      Specified by:
      setSignatureAlgorithm in interface Signature
      Parameters:
      newAlgorithm - the algorithm used to compute the signature

    • getHMACOutputLength

      @Nullable public Integer getHMACOutputLength()
      Gets the HMAC output length value, optionally used when signing with an HMAC signature algorithm.
      Specified by:
      getHMACOutputLength in interface Signature
      Returns:
      the HMACOutputLength value

    • setHMACOutputLength

      public void setHMACOutputLength(@Nullable Integer length)
      Sets the HMAC output length value, optionally used when signing with an HMAC signature algorithm.
      Specified by:
      setHMACOutputLength in interface Signature
      Parameters:
      length - the new HMACOutputLength value

    • getSigningCredential

      @Nullable public Credential getSigningCredential()
      Gets the signature signing credential.
      Specified by:
      getSigningCredential in interface Signature
      Returns:
      the signature signing credential

    • setSigningCredential

      public void setSigningCredential(@Nullable Credential newCredential)
      Sets the signature signing credential.
      Specified by:
      setSigningCredential in interface Signature
      Parameters:
      newCredential - the signature signing credential

    • getKeyInfo

      @Nullable public KeyInfo getKeyInfo()
      Gets the key info added to this signature.
      Specified by:
      getKeyInfo in interface Signature
      Returns:
      the key info added to this signature

    • setKeyInfo

      public void setKeyInfo(@Nullable KeyInfo newKeyInfo)
      Sets the key info added to this signature.
      Specified by:
      setKeyInfo in interface Signature
      Parameters:
      newKeyInfo - the key info added to this signature

    • getContentReferences

      @Nonnull @Live public List<ContentReference> getContentReferences()
      Gets the list of signature content references.
      Specified by:
      getContentReferences in interface Signature
      Returns:
      the list of signature content references

    • getOrderedChildren

      @Nullable @Unmodifiable @NotLive public List<XMLObject> getOrderedChildren()
      Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
      Specified by:
      getOrderedChildren in interface XMLObject
      Returns:
      ordered list of child elements

    • releaseDOM

      public void releaseDOM()
      Releases the DOM representation of this XMLObject, if there is one.
      Specified by:
      releaseDOM in interface XMLObject
      Overrides:
      releaseDOM in class AbstractXMLObject

    • getXMLSignature

      @Nullable public org.apache.xml.security.signature.XMLSignature getXMLSignature()
      Get the Apache XML Security signature instance held by this object.
      Returns:
      an Apache XML Security signature object

    • setXMLSignature

      public void setXMLSignature(@Nullable org.apache.xml.security.signature.XMLSignature signature)
      Set the Apache XML Security signature instance held by this object.
      Parameters:
      signature - an Apache XML Security signature object