Module io.inverno.mod.security.jose

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

Class AbstractJsonJOSEObjectBuilder<A,B extends JsonJOSEObject<A>,C extends JOSEHeaderConfigurator<C>,D extends AbstractJsonJOSEObjectBuilder<A,B,C,D>>

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJsonJOSEObjectBuilder<A,B,C,D>

Type Parameters:

A - the payload type

B - the JSON JOSE object type

C - the JOSE header configurator type

D - the JSON JOSE object bulder type

All Implemented Interfaces:

JsonJOSEObjectBuilder<A,B,C,D>

Direct Known Subclasses:

GenericJsonJWEBuilder, GenericJsonJWSBuilder

public abstract class AbstractJsonJOSEObjectBuilder<A,B extends JsonJOSEObject<A>,C extends JOSEHeaderConfigurator<C>,D extends AbstractJsonJOSEObjectBuilder<A,B,C,D>>
extends Object
implements JsonJOSEObjectBuilder<A,B,C,D>

Base JSON JOSE object builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

See Also:

• GenericJsonJWSBuilder
• GenericJsonJWEBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.inverno.mod.security.jose.internal.converter.DataConversionService	dataConversionService	The data conversion service.
protected final JWKService	jwkService	The JWK service.
protected final com.fasterxml.jackson.databind.ObjectMapper	mapper	The object mapper.
protected A	payload	The payload.
protected Consumer<C>	protectedHeaderConfigurer	The protected JOSE header configurer.
protected final Type	type	The payload type.
protected Consumer<C>	unprotectedHeaderConfigurer	The unprotected JOSE header configurer.

Constructor Summary

Constructors

Constructor	Description
AbstractJsonJOSEObjectBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper, io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService, JWKService jwkService, Type type)	Creates a JSON JOSE object builder.

Method Summary

Modifier and Type	Method	Description
protected void	checkPayload()	Verifies that the payload is valid.
protected Function<A,reactor.core.publisher.Mono<String>>	getPayloadEncoder(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder, String overridingContentType, String cty)	Returns the payload encoder to use to serialize the payload.
D	headers(Consumer<C> protectedHeaderConfigurer, Consumer<C> unprotectedHeaderConfigurer)	Specifies the common protected and unprotected headers.
D	payload(A payload)	Specifies the payload.

Methods inherited from class java.lang.Object

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

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

build, build, build

Field Details

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

The object mapper.

dataConversionService

protected final io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService

The data conversion service.

jwkService

protected final JWKService jwkService

The JWK service.

type

protected final Type type

The payload type.

protectedHeaderConfigurer

protected Consumer<C extends JOSEHeaderConfigurator<C>> protectedHeaderConfigurer

The protected JOSE header configurer.

unprotectedHeaderConfigurer

protected Consumer<C extends JOSEHeaderConfigurator<C>> unprotectedHeaderConfigurer

The unprotected JOSE header configurer.

payload

protected A payload

The payload.

Constructor Details

AbstractJsonJOSEObjectBuilder

public AbstractJsonJOSEObjectBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper,
 io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService,
 JWKService jwkService,
 Type type)

Creates a JSON JOSE object builder.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the payload type

Method Details

headers

public D headers(Consumer<C> protectedHeaderConfigurer,
 Consumer<C> unprotectedHeaderConfigurer)

Description copied from interface: JsonJOSEObjectBuilder

Specifies the common protected and unprotected headers.

The payload is common and as a result it is recommended to specify the payload content type in the common headers.

Specified by:

headers in interface JsonJOSEObjectBuilder<A,B extends JsonJOSEObject<A>,C extends JOSEHeaderConfigurator<C>,D extends AbstractJsonJOSEObjectBuilder<A,B,C,D>>

Parameters:

protectedHeaderConfigurer - the protected JOSE header configurer

unprotectedHeaderConfigurer - the unprotected JOSE header configurer

Returns:

this builder

payload

public D payload(A payload)

Description copied from interface: JsonJOSEObjectBuilder

Specifies the payload.

Specified by:

payload in interface JsonJOSEObjectBuilder<A,B extends JsonJOSEObject<A>,C extends JOSEHeaderConfigurator<C>,D extends AbstractJsonJOSEObjectBuilder<A,B,C,D>>

Parameters:

payload - the payload

Returns:

this builder

checkPayload

protected void checkPayload()
                     throws JOSEObjectBuildException,
JOSEProcessingException

Verifies that the payload is valid.

This basically checks that the payload is not null.

Throws:

JOSEObjectBuildException - if the payload is invalid

JOSEProcessingException - if there was a JOSE processing error

getPayloadEncoder

protected Function<A,reactor.core.publisher.Mono<String>> getPayloadEncoder(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder,
 String overridingContentType,
 String cty)
                                                                     throws JOSEObjectBuildException,
JOSEProcessingException

Returns the payload encoder to use to serialize the payload.

This method first considers the overriding payload encoder which is returned if present. Then the overriding content type is used if present to resolve the media type converter to use. Finally the payload content type defined in JOSE headers is considered to resolve the media type converter to use.

Parameters:

overridingPayloadEncoder - the overriding payload encoder

overridingContentType - the overriding payload media type

cty - the payload content type defined in JOSE headers

Returns:

a payload encoder

Throws:

JOSEObjectBuildException - if no payload encoder could have been resolved

JOSEProcessingException - if there was a JOSE processing error