Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.internal.jws

Class GenericJWSHeader

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJOSEHeader<GenericJWSHeader>

io.inverno.mod.security.jose.internal.jws.GenericJWSHeader

All Implemented Interfaces:

JOSEHeader, JOSEHeaderConfigurator<GenericJWSHeader>, JWSHeader, JWSHeaderConfigurator<GenericJWSHeader>

Direct Known Subclasses:

JsonJWSHeader

public class GenericJWSHeader
extends AbstractJOSEHeader<GenericJWSHeader>
implements JWSHeader, JWSHeaderConfigurator<GenericJWSHeader>

Generic JWS header implementation.

It processed the following parameters: b64, alg, jku, jwk, kid, x5u, x5c, x5t, x5t#S256, typ, cty, crit

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	b64	The base64url-encode payload parameter as defined by RFC7797 Section 3.
static final Set<String>	PROCESSED_PARAMETERS	The set of parameters processed in the JWS header.

Fields inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEHeader

alg, crit, cty, customParameters, encoded, jku, jwk, key, kid, typ, x5c, x5t, x5t_S256, x5u

Constructor Summary

Constructors

Constructor	Description
GenericJWSHeader()	Creates a generic JWS header.
GenericJWSHeader(String alg)	Creates a generic JWS header.

Method Summary

Modifier and Type	Method	Description
GenericJWSHeader	base64EncodePayload(Boolean b64)	Specifies whether the payload should be encoded as Base64URL or processed unencoded.
boolean	equals(Object obj)
Set<String>	getProcessedParameters()	Returns the parameters processed by the JOSE header.
int	hashCode()
Boolean	isBase64EncodePayload()	Determines whether the payload should be encoded as Base64URL or processed and serialized unencoded as defined by RFC7797 Section 5.

Methods inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEHeader

addCustomParameter, algorithm, contentType, critical, getAlgorithm, getContentType, getCritical, getCustomParameters, getEncoded, getJWK, getJWKSetURL, getKey, getKeyId, getType, getX509CertificateChain, getX509CertificateSHA1Thumbprint, getX509CertificateSHA256Thumbprint, getX509CertificateURL, jwk, jwkSetURL, keyId, setEncoded, setKey, type, x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.inverno.mod.security.jose.JOSEHeader

getAlgorithm, getContentType, getCritical, getCustomParameters, getEncoded, getJWK, getJWKSetURL, getKey, getKeyId, getType, getX509CertificateChain, getX509CertificateSHA1Thumbprint, getX509CertificateSHA256Thumbprint, getX509CertificateURL

Methods inherited from interface io.inverno.mod.security.jose.JOSEHeaderConfigurator

addCustomParameter, algorithm, contentType, critical, jwk, jwkSetURL, keyId, type, x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Field Details

PROCESSED_PARAMETERS

public static final Set<String> PROCESSED_PARAMETERS

The set of parameters processed in the JWS header.

b64

protected Boolean b64

The base64url-encode payload parameter as defined by RFC7797 Section 3.

Constructor Details

GenericJWSHeader

public GenericJWSHeader()

Creates a generic JWS header.

GenericJWSHeader

public GenericJWSHeader(String alg)

Creates a generic JWS header.

Parameters:

alg - the signature JWA algorithm

Method Details

getProcessedParameters

public Set<String> getProcessedParameters()

Description copied from class: AbstractJOSEHeader

Returns the parameters processed by the JOSE header.

Overrides:

getProcessedParameters in class AbstractJOSEHeader<GenericJWSHeader>

Returns:

a set of processed parameters

isBase64EncodePayload

public Boolean isBase64EncodePayload()

Description copied from interface: JWSHeader

Determines whether the payload should be encoded as Base64URL or processed and serialized unencoded as defined by RFC7797 Section 5.

Specified by:

isBase64EncodePayload in interface JWSHeader

Returns:

true or null if the payload must be encoded as Base64URL, false otherwise

base64EncodePayload

public GenericJWSHeader base64EncodePayload(Boolean b64)

Description copied from interface: JWSHeaderConfigurator

Specifies whether the payload should be encoded as Base64URL or processed unencoded.

Specified by:

base64EncodePayload in interface JWSHeaderConfigurator<GenericJWSHeader>

Parameters:

b64 - true or null to encode the payload as Base64URL, false otherwise

Returns:

this builder

hashCode

public int hashCode()

Specified by:

hashCode in interface JOSEHeader

Specified by:

hashCode in interface JWSHeader

Overrides:

hashCode in class AbstractJOSEHeader<GenericJWSHeader>

equals

public boolean equals(Object obj)

Specified by:

equals in interface JOSEHeader

Specified by:

equals in interface JWSHeader

Overrides:

equals in class AbstractJOSEHeader<GenericJWSHeader>