Method Detail

• jwkSetUri

  public JoseHeader.Builder jwkSetUri(String jwkSetUri)

  Sets the JWK Set URL that refers to the resource of a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  jwkSetUri - the JWK Set URL

  Returns:

  the JoseHeader.Builder

• jwk

  public JoseHeader.Builder jwk(Map<String,Object> jwk)

  Sets the JSON Web Key which is the public key that corresponds to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  jwk - the JSON Web Key

  Returns:

  the JoseHeader.Builder

• keyId

  public JoseHeader.Builder keyId(String keyId)

  Sets the key ID that is a hint indicating which key was used to secure the JWS or JWE.

  Parameters:

  keyId - the key ID

  Returns:

  the JoseHeader.Builder

• x509Uri

  public JoseHeader.Builder x509Uri(String x509Uri)

  Sets the X.509 URL that refers to the resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  x509Uri - the X.509 URL

  Returns:

  the JoseHeader.Builder

• x509CertificateChain

  public JoseHeader.Builder x509CertificateChain(List<String> x509CertificateChain)

  Sets the X.509 certificate chain that contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  x509CertificateChain - the X.509 certificate chain

  Returns:

  the JoseHeader.Builder

• x509SHA1Thumbprint

  public JoseHeader.Builder x509SHA1Thumbprint(String x509SHA1Thumbprint)

  Sets the X.509 certificate SHA-1 thumbprint that is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of the X.509 certificate corresponding to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  x509SHA1Thumbprint - the X.509 certificate SHA-1 thumbprint

  Returns:

  the JoseHeader.Builder

• x509SHA256Thumbprint

  public JoseHeader.Builder x509SHA256Thumbprint(String x509SHA256Thumbprint)

  Sets the X.509 certificate SHA-256 thumbprint that is a base64url-encoded SHA-256 thumbprint (a.k.a. digest) of the DER encoding of the X.509 certificate corresponding to the key used to digitally sign the JWS or encrypt the JWE.

  Parameters:

  x509SHA256Thumbprint - the X.509 certificate SHA-256 thumbprint

  Returns:

  the JoseHeader.Builder

• critical

  public JoseHeader.Builder critical(Set<String> headerNames)

  Sets the critical headers that indicates which extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed.

  Parameters:

  headerNames - the critical header names

  Returns:

  the JoseHeader.Builder

• type

  public JoseHeader.Builder type(String type)

  Sets the type header that declares the media type of the JWS/JWE.

  Parameters:

  type - the type header

  Returns:

  the JoseHeader.Builder

• contentType

  public JoseHeader.Builder contentType(String contentType)

  Sets the content type header that declares the media type of the secured content (the payload).

  Parameters:

  contentType - the content type header

  Returns:

  the JoseHeader.Builder

• header

  public JoseHeader.Builder header(String name,
                                   Object value)

  Sets the header.

  Parameters:

  name - the header name

  value - the header value

  Returns:

  the JoseHeader.Builder

• headers

  public JoseHeader.Builder headers(Consumer<Map<String,Object>> headersConsumer)

  A Consumer to be provided access to the headers allowing the ability to add, replace, or remove.

  Parameters:

  headersConsumer - a Consumer of the headers

  Returns:

  the JoseHeader.Builder

• build

  public JoseHeader build()

  Builds a new JoseHeader.

  Returns:

  a JoseHeader