Module io.inverno.mod.security.jose

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

Class GenericJWSBuilder<A>

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>

io.inverno.mod.security.jose.internal.jws.GenericJWSBuilder<A>

Type Parameters:

A - the payload type

All Implemented Interfaces:

JOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>, JWSBuilder<A,GenericJWSHeader,GenericJWSBuilder<A>>

Direct Known Subclasses:

SignatureJWSBuilder

public class GenericJWSBuilder<A>
extends AbstractJOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>
implements JWSBuilder<A,GenericJWSHeader,GenericJWSBuilder<A>>

Generic JSON Web Signature builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<GenericJWSHeader>	headerConfigurer	The JWS header configurer.

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

dataConversionService, jwkService, keys, mapper, payload, type

Constructor Summary

Constructors

Constructor	Description
GenericJWSBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper, io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService, JWKService jwkService, Type type, org.reactivestreams.Publisher<? extends JWK> keys)	Creates a generic JWS builder.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<JWS<A>>	build(String contentType)	Builds the JOSE object using the specified payload media type.
reactor.core.publisher.Mono<JWS<A>>	build(Function<A,reactor.core.publisher.Mono<String>> payloadEncoder)	Builds the JOSE object using the specified payload encoder.
protected GenericJWSHeader	buildJWSHeader()	Builds the JWS header.
protected reactor.core.publisher.Mono<GenericJWSPayload<A>>	buildJWSPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder, String overridingContentType, GenericJWSHeader jwsHeader)	Builds the JWS payload.
GenericJWSBuilder<A>	header(Consumer<GenericJWSHeader> configurer)	Specifies the JOSE header.

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

checkHeader, checkPayload, getKeys, getPayloadEncoder, getProcessedParameters, 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.JOSEObjectBuilder

build, payload

Field Details

headerConfigurer

protected Consumer<GenericJWSHeader> headerConfigurer

The JWS header configurer.

Constructor Details

GenericJWSBuilder

public GenericJWSBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper,
 io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService,
 JWKService jwkService,
 Type type,
 org.reactivestreams.Publisher<? extends JWK> keys)

Creates a generic JWS builder.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the payload type

keys - the keys to consider to sign the JWS

Method Details

header

public GenericJWSBuilder<A> header(Consumer<GenericJWSHeader> configurer)

Description copied from interface: JOSEObjectBuilder

Specifies the JOSE header.

Specified by:

header in interface JOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>

Parameters:

configurer - a JOSE header configurer

Returns:

this builder

build

public reactor.core.publisher.Mono<JWS<A>> build(String contentType)
                                          throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JOSEObjectBuilder

Builds the JOSE object using the specified payload media type.

The builder will use the specified media type to determine the converter to use to serialize the payload and ignore the content type specified in the JOSE header. The operation will fail if there is no media type converters defined for that particular media type. Media types converters are provided when building the JOSE module. Please consider build method JOSEObjectBuilder.build(java.util.function.Function) to provide a custom payload encoder.

Specified by:

build in interface JOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>

Parameters:

contentType - the payload media type

Returns:

a single JOSE object publisher

Throws:

JOSEObjectBuildException - if there was an error building the JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSBuildException

build

public reactor.core.publisher.Mono<JWS<A>> build(Function<A,reactor.core.publisher.Mono<String>> payloadEncoder)
                                          throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JOSEObjectBuilder

Builds the JOSE object using the specified payload encoder.

The builder will use the specified payload encoder to serialize the payload and ignore the content type specified in the JOSE header.

Specified by:

build in interface JOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>

Parameters:

payloadEncoder - a payload encoder

Returns:

a single JOSE object publisher

Throws:

JOSEObjectBuildException - if there was an error building the JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSBuildException

buildJWSHeader

protected GenericJWSHeader buildJWSHeader()
                                   throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Builds the JWS header.

Returns:

the JWS header

Throws:

JWSBuildException - if there was an error building the JWS header

JOSEObjectBuildException - if there was an error building the JWS header

JOSEProcessingException - if there was a JOSE processing error

buildJWSPayload

protected reactor.core.publisher.Mono<GenericJWSPayload<A>> buildJWSPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder,
 String overridingContentType,
 GenericJWSHeader jwsHeader)
                                                                     throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Builds the JWS payload.

Parameters:

overridingPayloadEncoder - an overriding payload encoder

overridingContentType - an overriding payload content type

jwsHeader - the JWS header

Returns:

a single JWS payload publisher

Throws:

JWSBuildException - if there was an error building the JWS payload

JOSEObjectBuildException - if there was an error building the JWS payload

JOSEProcessingException - if there was a JOSE processing error