JwsHeader (IG Aggregated Javadoc 2023.11.0 Documentation)

java.lang.Object
- org.forgerock.json.jose.jwt.JWObject
- - org.forgerock.json.jose.jwt.JwtHeader
  - - org.forgerock.json.jose.jws.JwtSecureHeader
    - - org.forgerock.json.jose.jws.JwsHeader

```
public class JwsHeader
extends JwtSecureHeader
```
An implementation for the JWS Header parameters.

Since:

2.0.0

Constructor Summary

Constructors
Constructor	Description
`JwsHeader()`	Constructs a new, empty JwsHeader.
`JwsHeader(Map<String,Object> headerParameters)`	Constructs a new JwsHeader, with its parameters set to the contents of the given Map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

JwsAlgorithm getAlgorithm()
Gets the Algorithm set in the JWT header.
- Methods inherited from class org.forgerock.json.jose.jws.JwtSecureHeader
  getCompressionAlgorithm, getContentType, getCriticalHeaders, getJsonWebKey, getJwkSetUrl, getKeyId, getParameter, getX509CertificateChain, getX509CertificateThumbprint, getX509Url, setCompressionAlgorithm, setContentType, setCriticalHeaders, setJsonWebKey, setJwkSetUrl, setKeyId, setParameter, setX509CertificateChain, setX509CertificateThumbprint, setX509Url
- Methods inherited from class org.forgerock.json.jose.jwt.JwtHeader
  build, getAlgorithmString, getParameter, getParameters, getType, setAlgorithm, setParameters, setType
- Methods inherited from class org.forgerock.json.jose.jwt.JWObject
  checkListValuesAreOfType, checkValueIsOfType, equals, get, hashCode, isDefined, isValueOfType, keys, put, toJsonValue, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JwsHeader
```
public JwsHeader()
```
    Constructs a new, empty JwsHeader.
  - JwsHeader
```
public JwsHeader(Map<String,Object> headerParameters)
```
    Constructs a new JwsHeader, with its parameters set to the contents of the given Map.
    
    Parameters:
    
    headerParameters - A Map containing the parameters to be set in the header.
- Method Detail
  - getAlgorithm
```
public JwsAlgorithm getAlgorithm()
```
    Gets the Algorithm set in the JWT header.
    If there is no algorithm set in the JWT header, then the JwsAlgorithm NONE will be returned.
    
    Specified by:
    
    getAlgorithm in class JwtHeader
    
    Returns:
    
    The Algorithm.