Class JsonWebSignature.Header
- Enclosing class:
JsonWebSignature
-
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> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none.Array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed ornull
for none.private String
JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS ornull
for none.private String
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 ornull
for none.private String
Key ID header parameter that is a hint indicating which specific key owned by the signer should be used to validate the digital signature ornull
for none.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 ornull
for none.private String
X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a.private String
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 ornull
for none. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.final String
Returns the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none.Returns the array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed ornull
for none.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 ornull
for none.final String
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 ornull
for none.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 ornull
for none.final String
Deprecated.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 ornull
for none.final String
Returns the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a.final String
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 ornull
for none.Sets the given field value (may benull
) for the given field name.setAlgorithm
(String algorithm) Sets the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none.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 ornull
for none.Sets the JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS ornull
for none.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 ornull
for none.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 ornull
for none.Sets the type header parameter used to declare the type of this object ornull
for none.setX509Certificate
(String x509Certificate) Deprecated.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 ornull
for none.setX509Thumbprint
(String x509Thumbprint) Sets the X.509 certificate thumbprint header parameter that provides a base64url encoded SHA-1 thumbprint (a.k.a.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 ornull
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
-
Field Details
-
algorithm
Algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none. -
jwkUrl
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 ornull
for none. -
jwk
JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS ornull
for none. -
keyId
Key ID header parameter that is a hint indicating which specific key owned by the signer should be used to validate the digital signature ornull
for none. -
x509Url
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 ornull
for none. -
x509Thumbprint
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 ornull
for none. -
x509Certificates
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 ornull
for none.- Since:
- 1.19.1.
-
critical
Array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed ornull
for none.
-
-
Constructor Details
-
Header
public Header()
-
-
Method Details
-
setType
Description copied from class:JsonWebToken.Header
Sets the type header parameter used to declare the type of this object ornull
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 classJsonWebToken.Header
-
getAlgorithm
Returns the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none. -
setAlgorithm
Sets the algorithm header parameter that identifies the cryptographic algorithm used to secure the JWS ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
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 ornull
for none. -
setJwkUrl
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 ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
getJwk
Returns the JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS ornull
for none. -
setJwk
Sets the JSON Web Key header parameter that is a public key that corresponds to the key used to digitally sign the JWS ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
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 ornull
for none. -
setKeyId
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 ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
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 ornull
for none. -
setX509Url
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 ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
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 ornull
for none. -
setX509Thumbprint
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 ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
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 ornull
for none.@deprecated Since release 1.19.1, replaced by
getX509Certificates()
. -
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 ornull
for none.- Since:
- 1.19.1.
-
setX509Certificate
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 ornull
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
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 ornull
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
Returns the array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed ornull
for none.- Since:
- 1.16
-
setCritical
Sets the array listing the header parameter names that define extensions that are used in the JWS header that MUST be understood and processed ornull
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
Description copied from class:GenericData
Sets the given field value (may benull
) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient thanGenericData.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 classJsonWebToken.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 classJsonWebToken.Header
-