Interface SignatureContext

All Known Implementing Classes:
ComponentValueProvider
public interface SignatureContext
The signature context that provides component values.

RFC 9421 HTTP Message Signatures, Section 1.1. Conventions and Terminology, explains Signature Context as follows:

The data source from which the HTTP message component values are drawn. The context includes the target message and any additional information the signer or verifier might have, such as the full target URI of a request or the related request message for a response.

The constructor of the SignatureBaseBuilder class requires an instance that implements this SignatureContext interface.

See Also:

  • Method Details

    • getComponentValue

      String getComponentValue(SignatureMetadata metadata, ComponentIdentifier identifier) throws SignatureException
      Get the component value.
      Parameters:
      metadata - The signature metadata where the component identifier is included.
      identifier - The component identifier.
      Returns:
      The value of the component identified by the component identifier. null if the component value is not available.
      Throws:
      SignatureException - Something wrong happened.