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.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
`Header()`

Method Summary

All Methods

Instance Methods

Concrete Methods

Deprecated Methods
Modifier and Type	Method and Description
`JsonWebSignature.Header`	`clone()` Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
`String`	`getAlgorithm()` Returns the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS or `null` for none.
`List<String>`	`getCritical()` Returns the array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed or `null` for none.
`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.
`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.
`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.
`String`	`getX509Certificate()` Deprecated.
`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.
`String`	`getX509Thumbprint()` Returns the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a.
`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.
`JsonWebSignature.Header`	`set(String fieldName, Object value)` Sets the given field value (may be `null`) for the given field name.
`JsonWebSignature.Header`	`setAlgorithm(String algorithm)` Sets the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS or `null` for none.
`JsonWebSignature.Header`	`setCritical(List<String> critical)` Sets the array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed or `null` for none.
`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.
`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.
`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.
`JsonWebSignature.Header`	`setType(String type)` Sets the type header parameter used to declare the type of this object or `null` for none.
`JsonWebSignature.Header`	`setX509Certificate(String x509Certificate)` Deprecated.
`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.
`JsonWebSignature.Header`	`setX509Thumbprint(String x509Thumbprint)` Sets the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a.
`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.

Methods inherited from class com.google.api.client.json.webtoken.JsonWebToken.Header
getContentType, getType, setContentType

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Header
```
public Header()
```
- Method Detail
  - 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.
  - 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.
  - getX509Certificate
```
@Deprecated
public final String getX509Certificate()
```
    Deprecated.
    
    Returns the X.509 certificate chain header parameter contains the X.509 public key certificate or corresponding to the key used to digitally sign the JWS or null for none.
    @deprecated Since release 1.19.1, replaced by getX509Certificates().
  - 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.
  - setX509Certificate
```
@Deprecated
public JsonWebSignature.Header setX509Certificate(String x509Certificate)
```
    Deprecated.
    
    Sets the X.509 certificate chain header parameter contains the X.509 public key certificate 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.
    
    @deprecated Since release 1.19.1, replaced by setX509Certificates(List x509Certificates).
  - 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 the array listing the header parameter names that define extensions that are 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 array listing the header parameter names that define extensions that are 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.
  - 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.

Class JsonWebSignature.Header

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Constructors

Method Summary

Methods inherited from class com.google.api.client.json.webtoken.JsonWebToken.Header

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Header

Method Detail

setType

getAlgorithm

setAlgorithm

getJwkUrl

setJwkUrl

getJwk

setJwk

getKeyId

setKeyId

getX509Url

setX509Url

getX509Thumbprint

setX509Thumbprint

getX509Certificate

getX509Certificates

setX509Certificate

setX509Certificates

getCritical

setCritical

set

clone