JoseHeader (spring-security-oauth2-authorization-server 0.0.1 API)

java.lang.Object
- org.springframework.security.oauth2.jose.JoseHeader

```
public final class JoseHeader
extends Object
```
The JOSE header is a JSON object representing the header parameters of a JSON Web Token, whether the JWT is a JWS or JWE, that describe the cryptographic operations applied to the JWT and optionally, additional properties of the JWT.
Since:
0.0.1
See Also:
Jwt, JWT JOSE Header, JWS JOSE Header, JWE JOSE Header

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class JoseHeader.Builder
A builder for JoseHeader.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JoseHeader.Builder` A builder for `JoseHeader`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JoseHeader.Builder`	`from(JoseHeader headers)` Returns a new `JoseHeader.Builder`, initialized with the provided `headers`.
`String`	`getContentType()` Returns the content type header that declares the media type of the secured content (the payload).
`Set<String>`	`getCritical()` Returns the critical headers that indicates which extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed.
`<T> T`	`getHeader(String name)` Returns the header value.
`Map<String,Object>`	`getHeaders()` Returns the headers.
`Map<String,Object>`	`getJwk()` Returns the JSON Web Key which is the public key that corresponds to the key used to digitally sign the JWS or encrypt the JWE.
`String`	`getJwkSetUri()` Returns 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.
`JwsAlgorithm`	`getJwsAlgorithm()` Returns the JWS algorithm used to digitally sign the JWS.
`String`	`getKeyId()` Returns the key ID that is a hint indicating which key was used to secure the JWS or JWE.
`String`	`getType()` Returns the type header that declares the media type of the JWS/JWE.
`List<String>`	`getX509CertificateChain()` Returns 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.
`String`	`getX509SHA1Thumbprint()` Returns the X.509 certificate SHA-1 thumbprint that is a base64url-encoded SHA-1 thumbprint (a.k.a.
`String`	`getX509SHA256Thumbprint()` Returns the X.509 certificate SHA-256 thumbprint that is a base64url-encoded SHA-256 thumbprint (a.k.a.
`String`	`getX509Uri()` Returns 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.
`static JoseHeader.Builder`	`withAlgorithm(JwsAlgorithm jwsAlgorithm)` Returns a new `JoseHeader.Builder`, initialized with the provided `JwsAlgorithm`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getJwsAlgorithm
```
public JwsAlgorithm getJwsAlgorithm()
```
    Returns the JWS algorithm used to digitally sign the JWS.
    Returns:
    the JWS algorithm
  - getJwkSetUri
```
public String getJwkSetUri()
```
    Returns 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.
    Returns:
    the JWK Set URL
  - getJwk
```
public Map<String,Object> getJwk()
```
    Returns the JSON Web Key which is the public key that corresponds to the key used to digitally sign the JWS or encrypt the JWE.
    Returns:
    the JSON Web Key
  - getKeyId
```
public String getKeyId()
```
    Returns the key ID that is a hint indicating which key was used to secure the JWS or JWE.
    Returns:
    the key ID
  - getX509Uri
```
public String getX509Uri()
```
    Returns 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.
    Returns:
    the X.509 URL
  - getX509CertificateChain
```
public List<String> getX509CertificateChain()
```
    Returns 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.
    Returns:
    the X.509 certificate chain
  - getX509SHA1Thumbprint
```
public String getX509SHA1Thumbprint()
```
    Returns 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.
    Returns:
    the X.509 certificate SHA-1 thumbprint
  - getX509SHA256Thumbprint
```
public String getX509SHA256Thumbprint()
```
    Returns 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.
    Returns:
    the X.509 certificate SHA-256 thumbprint
  - getCritical
```
public Set<String> getCritical()
```
    Returns the critical headers that indicates which extensions to the JWS/JWE/JWA specifications are being used that MUST be understood and processed.
    Returns:
    the critical headers
  - getType
```
public String getType()
```
    Returns the type header that declares the media type of the JWS/JWE.
    Returns:
    the type header
  - getContentType
```
public String getContentType()
```
    Returns the content type header that declares the media type of the secured content (the payload).
    Returns:
    the content type header
  - getHeaders
```
public Map<String,Object> getHeaders()
```
    Returns the headers.
    Returns:
    the headers
  - getHeader
```
public <T> T getHeader(String name)
```
    Returns the header value.
    Type Parameters:
    T - the type of the header value
    Parameters:
    name - the header name
    Returns:
    the header value
  - withAlgorithm
```
public static JoseHeader.Builder withAlgorithm(JwsAlgorithm jwsAlgorithm)
```
    Returns a new JoseHeader.Builder, initialized with the provided JwsAlgorithm.
    Parameters:
    jwsAlgorithm - the JwsAlgorithm
    Returns:
    the JoseHeader.Builder
  - from
```
public static JoseHeader.Builder from(JoseHeader headers)
```
    Returns a new JoseHeader.Builder, initialized with the provided headers.
    Parameters:
    headers - the headers
    Returns:
    the JoseHeader.Builder

Class JoseHeader

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getJwsAlgorithm

getJwkSetUri

getJwk

getKeyId

getX509Uri

getX509CertificateChain

getX509SHA1Thumbprint

getX509SHA256Thumbprint

getCritical

getType

getContentType

getHeaders

getHeader

withAlgorithm

from