Class JsonWebSignature.Header

java.lang.Object
java.util.AbstractMap<String,Object>
com.google.api.client.util.GenericData
com.google.api.client.json.GenericJson
com.google.api.client.json.webtoken.JsonWebToken.Header
com.google.api.client.json.webtoken.JsonWebSignature.Header
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
JsonWebSignature
public static class JsonWebSignature.Header extends JsonWebToken.Header
Header as specified in Reserved Header Parameter Names.
Since:
1.14 (since 1.7 as com.google.api.client.auth.jsontoken.JsonWebSignature)
Author:
Yaniv Inbar

  • Constructor Details

    • Header

      public Header()

  • Method Details

    • setType

      public JsonWebSignature.Header setType(String type)
      Description copied from class: JsonWebToken.Header
      Sets the type header parameter used to declare the type of this object or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Overrides:
      setType in class JsonWebToken.Header

    • getAlgorithm

      public final String getAlgorithm()
      Returns the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS or null for none.

    • setAlgorithm

      public JsonWebSignature.Header setAlgorithm(String algorithm)
      Sets the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getJwkUrl

      public final String getJwkUrl()
      Returns the JSON Web Key URL header parameter that is an absolute URL that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key that was used to digitally sign the JWS or null for none.

    • setJwkUrl

      public JsonWebSignature.Header setJwkUrl(String jwkUrl)
      Sets the JSON Web Key URL header parameter that is an absolute URL that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key that was used to digitally sign the JWS or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getJwk

      public final String getJwk()
      Returns the JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS or null for none.

    • setJwk

      public JsonWebSignature.Header setJwk(String jwk)
      Sets the JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getKeyId

      public final String getKeyId()
      Returns the key ID header parameter that is a hint indicating which specific key owned by the signer should be used to validate the digital signature or null for none.

    • setKeyId

      public JsonWebSignature.Header setKeyId(String keyId)
      Sets the key ID header parameter that is a hint indicating which specific key owned by the signer should be used to validate the digital signature or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getX509Url

      public final String getX509Url()
      Returns the X.509 URL header parameter that is an absolute URL that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or null for none.

    • setX509Url

      public JsonWebSignature.Header setX509Url(String x509Url)
      Sets the X.509 URL header parameter that is an absolute URL that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getX509Thumbprint

      public final String getX509Thumbprint()
      Returns the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate that can be used to match the certificate or null for none.

    • setX509Thumbprint

      public JsonWebSignature.Header setX509Thumbprint(String x509Thumbprint)
      Sets the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate that can be used to match the certificate or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getX509Certificates

      public final List<String> getX509Certificates()
      Returns the X.509 certificate chain header parameter contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or null for none.
      Since:
      1.19.1.

    • setX509Certificates

      public JsonWebSignature.Header setX509Certificates(List<String> x509Certificates)
      Sets the X.509 certificate chain header parameter contains the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.19.1.

    • getCritical

      public final List<String> getCritical()
      Returns an array listing the header parameter names that define extensions used in the JWS header that MUST be understood and processed or null for none.
      Since:
      1.16

    • setCritical

      public JsonWebSignature.Header setCritical(List<String> critical)
      Sets the header parameter names that define extensions used in the JWS header that MUST be understood and processed or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.16

    • set

      public JsonWebSignature.Header set(String fieldName, Object value)
      Description copied from class: GenericData
      Sets the given field value (may be null) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient than GenericData.put(String, Object) because it avoids accessing the field's original value.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Overrides:
      set in class JsonWebToken.Header

    • clone

      public JsonWebSignature.Header clone()
      Description copied from class: GenericData
      Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
      Overrides:
      clone in class JsonWebToken.Header