Package org.keycloak.jose.jws

Class JWSHeader

java.lang.Object

org.keycloak.jose.jws.JWSHeader

All Implemented Interfaces:

Serializable, JOSEHeader

public class JWSHeader
extends Object
implements JOSEHeader

Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JWSHeader()
JWSHeader(Algorithm algorithm, String type, String contentType)
JWSHeader(Algorithm algorithm, String type, String keyId, JWK key)

Method Summary

Modifier and Type	Method	Description
void	addX5c(String x5c)
void	addX5c(Certificate x5c)
Algorithm	getAlgorithm()
String	getContentType()
JWK	getKey()
String	getKeyId()
Map<String,Object>	getOtherClaims()	This is a map of any other claims and data that might be in the header.
String	getRawAlgorithm()	Returns the algorithm used to sign or encrypt the JWT from the JOSE header.
String	getType()
List<String>	getX5c()
void	setAlgorithm(Algorithm algorithm)
void	setContentType(String contentType)
void	setKey(JWK key)
void	setKeyId(String keyId)
void	setOtherClaims(String name, Object value)
void	setType(String type)
void	setX5c(List<String> x5c)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JWSHeader

public JWSHeader()

JWSHeader

public JWSHeader(Algorithm algorithm,
 String type,
 String contentType)

JWSHeader

public JWSHeader(Algorithm algorithm,
 String type,
 String keyId,
 JWK key)

Method Details

getAlgorithm

public Algorithm getAlgorithm()

setAlgorithm

public void setAlgorithm(Algorithm algorithm)

getRawAlgorithm

public String getRawAlgorithm()

Description copied from interface: JOSEHeader

Returns the algorithm used to sign or encrypt the JWT from the JOSE header.

Specified by:

getRawAlgorithm in interface JOSEHeader

Returns:

the algorithm from the JOSE header

getType

public String getType()

setType

public void setType(String type)

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getKeyId

public String getKeyId()

Specified by:

getKeyId in interface JOSEHeader

setKeyId

public void setKeyId(String keyId)

getKey

public JWK getKey()

setKey

public void setKey(JWK key)

getX5c

public List<String> getX5c()

setX5c

public void setX5c(List<String> x5c)

addX5c

public void addX5c(String x5c)

addX5c

public void addX5c(Certificate x5c)

getOtherClaims

public Map<String,Object> getOtherClaims()

This is a map of any other claims and data that might be in the header. Could be custom claims set up by a custom implementation or the auth server

setOtherClaims

public void setOtherClaims(String name,
 Object value)

toString

public String toString()

Overrides:

toString in class Object