Module io.inverno.mod.security.jose

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

Class SignatureJWSBuilder<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>

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

Type Parameters:

A - the payload type

All Implemented Interfaces:

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

public class SignatureJWSBuilder<A>
extends GenericJWSBuilder<A>

JSON JWS Signature specific JWS builder used to build signature specific JWS when building a JSON JWS.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.jws.GenericJWSBuilder

headerConfigurer

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

dataConversionService, jwkService, keys, mapper, payload, type

Constructor Summary

Constructors

Constructor	Description
SignatureJWSBuilder(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, GenericJWSHeader signatureProtectedJWSHeader, GenericJWSHeader jwsHeader, GenericJWSPayload<A> jwsPayload)	Creates a JSON JWS signature builder.

Method Summary

Modifier and Type	Method	Description
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.
GenericJWSBuilder<A>	payload(A payload)	Specifies the JOSE object payload.

Methods inherited from class io.inverno.mod.security.jose.internal.jws.GenericJWSBuilder

build, build

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

checkHeader, checkPayload, getKeys, getPayloadEncoder, getProcessedParameters

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

Constructor Details

SignatureJWSBuilder

public SignatureJWSBuilder(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,
 GenericJWSHeader signatureProtectedJWSHeader,
 GenericJWSHeader jwsHeader,
 GenericJWSPayload<A> jwsPayload)

Creates a JSON JWS signature builder.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the payload type

keys - the signature specific keys to consider to sign the JWS

signatureProtectedJWSHeader - the signature specific protected JWSheader

jwsHeader - the signaTure JWS header

jwsPayload - the JSON JWS payload

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>>

Overrides:

header in class GenericJWSBuilder<A>

Parameters:

configurer - a JOSE header configurer

Returns:

this builder

payload

public GenericJWSBuilder<A> payload(A payload)

Description copied from interface: JOSEObjectBuilder

Specifies the JOSE object payload.

Specified by:

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

Overrides:

payload in class AbstractJOSEObjectBuilder<A,JWSHeader,JWS<A>,GenericJWSHeader,GenericJWSBuilder<A>>

Parameters:

payload - a payload

Returns:

this builder

buildJWSHeader

protected GenericJWSHeader buildJWSHeader()
                                   throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from class: GenericJWSBuilder

Builds the JWS header.

Overrides:

buildJWSHeader in class GenericJWSBuilder<A>

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

Description copied from class: GenericJWSBuilder

Builds the JWS payload.

Overrides:

buildJWSPayload in class GenericJWSBuilder<A>

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