Module io.inverno.mod.security.jose

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

Class GenericJsonJWEReader<A>

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJsonJOSEObjectReader<A,JsonJWE<A,JsonJWE.ReadRecipient<A>>,GenericJsonJWEReader<A>>

io.inverno.mod.security.jose.internal.jwe.GenericJsonJWEReader<A>

Type Parameters:

A - the expected payload type

All Implemented Interfaces:

JsonJOSEObjectReader<A,JsonJWE<A,JsonJWE.ReadRecipient<A>>,GenericJsonJWEReader<A>>, JsonJWEReader<A,GenericJsonJWEReader<A>>

public class GenericJsonJWEReader<A>
extends AbstractJsonJOSEObjectReader<A,JsonJWE<A,JsonJWE.ReadRecipient<A>>,GenericJsonJWEReader<A>>
implements JsonJWEReader<A,GenericJsonJWEReader<A>>

Generic JSON JWE reader implementation.

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GenericJsonJWEReader.RecipientInfo	Read recipient info for holding recipient specific information.

Field Summary

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

applicationProcessedParameters, dataConversionService, jwkService, mapper, type

Constructor Summary

Constructors

Constructor	Description
GenericJsonJWEReader(com.fasterxml.jackson.databind.ObjectMapper mapper, io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService, JWKService jwkService, Type type, List<JWEZip> zips)	Creates a generic JSON JWE reader.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<JsonJWE<A,JsonJWE.ReadRecipient<A>>>	read(String json, String contentType)	Reads the specified JSON representation using the specified payload media type and returns the corresponding JSON JOSE object.
reactor.core.publisher.Mono<JsonJWE<A,JsonJWE.ReadRecipient<A>>>	read(String json, Function<String,reactor.core.publisher.Mono<A>> payloadDecoder)	Reads the specified JSON representation using the specified payload decoder and returns the corresponding JSON JOSE object.
protected GenericJsonJWEReader.RecipientInfo	readJWERecipient(Object recipientElementValue, JsonJWEHeader protectedJWEHeader, JsonJWEHeader unprotectedJWEHeader)	Reads a JSON JWE recipient.
protected JsonJWEHeader	readProtectedJWEHeader(String protectedValue)	Reads the JSON JWE protected header.
protected JsonJWEHeader	readUnprotectedJWEHeader(Map<String,Object> unprotectedValue)	Reads the JSON JWE unprotected header.

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

getPayloadDecoder, processedParameters

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

processedParameters, read

Constructor Details

GenericJsonJWEReader

public GenericJsonJWEReader(com.fasterxml.jackson.databind.ObjectMapper mapper,
 io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService,
 JWKService jwkService,
 Type type,
 List<JWEZip> zips)

Creates a generic JSON JWE reader.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the expected payload type

zips - a list of supported JWE compression algorithms

Method Details

read

public reactor.core.publisher.Mono<JsonJWE<A,JsonJWE.ReadRecipient<A>>> read(String json,
 String contentType)
                                                                      throws JWEReadException,
JWEBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJOSEObjectReader

Reads the specified JSON representation using the specified payload media type and returns the corresponding JSON JOSE object.

The reader will use the specified media type to determine the converter to use to deserialize the payload and ignore the content type specified in the JOSE headers. 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 read method JsonJOSEObjectReader.read(java.lang.String, java.util.function.Function) to provide a custom payload decoder.

Specified by:

read in interface JsonJOSEObjectReader<A,JsonJWE<A,JsonJWE.ReadRecipient<A>>,GenericJsonJWEReader<A>>

Parameters:

json - a JSON JOSE object JSON representation

contentType - the expected payload media type

Returns:

a single JSON JOSE object publisher

Throws:

JOSEObjectReadException - if there was an error reading the JSON JOSE object

JOSEObjectBuildException - if there was an error building the JSON JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWEReadException

JWEBuildException

read

public reactor.core.publisher.Mono<JsonJWE<A,JsonJWE.ReadRecipient<A>>> read(String json,
 Function<String,reactor.core.publisher.Mono<A>> payloadDecoder)
                                                                      throws JWEReadException,
JWEBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJOSEObjectReader

Reads the specified JSON representation using the specified payload decoder and returns the corresponding JSON JOSE object.

The reader will use the specified payload decoder to deserialize the payload and ignore the content type specified in the JOSE headers.

Specified by:

read in interface JsonJOSEObjectReader<A,JsonJWE<A,JsonJWE.ReadRecipient<A>>,GenericJsonJWEReader<A>>

Parameters:

json - a JSON JOSE object JSON representation

payloadDecoder - a payload decoder

Returns:

a single JSON JOSE object publisher

Throws:

JOSEObjectReadException - if there was an error reading the JSON JOSE object

JOSEObjectBuildException - if there was an error building the JSON JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWEReadException

JWEBuildException

readProtectedJWEHeader

protected JsonJWEHeader readProtectedJWEHeader(String protectedValue)
                                        throws JWEReadException,
JOSEObjectReadException,
JOSEProcessingException

Reads the JSON JWE protected header.

Parameters:

protectedValue - the Base64URL encoded protected JWE header

Returns:

the protected JWE header

Throws:

JWEReadException - if there was an error reading the protected JWE header

JOSEObjectReadException - if there was an error reading the protected JWE header

JOSEProcessingException - if there was a JOSE processing error

readUnprotectedJWEHeader

protected JsonJWEHeader readUnprotectedJWEHeader(Map<String,Object> unprotectedValue)
                                          throws JWEReadException,
JOSEObjectReadException,
JOSEProcessingException

Reads the JSON JWE unprotected header.

Parameters:

unprotectedValue - the unprotected JWE header as map

Returns:

the unprotected JWE header

Throws:

JWEReadException - if there was an error reading the unprotected JWE header

JOSEObjectReadException - if there was an error reading the unprotected JWE header

JOSEProcessingException - if there was a JOSE processing error

readJWERecipient

protected GenericJsonJWEReader.RecipientInfo readJWERecipient(Object recipientElementValue,
 JsonJWEHeader protectedJWEHeader,
 JsonJWEHeader unprotectedJWEHeader)
                                                       throws JWEReadException,
JOSEObjectReadException,
JOSEProcessingException

Reads a JSON JWE recipient.

Parameters:

recipientElementValue - the extracted JSON JWE recipient element

protectedJWEHeader - the JSON JWE protected header

unprotectedJWEHeader - the JSON JWE unprotected header

Returns:

a read recipient info

Throws:

JWEReadException - if there was an error reading the JSON JWE recipient

JOSEObjectReadException - if there was an error reading the JSON JWE recipient

JOSEProcessingException - if there was a JOSE processing error