Module io.inverno.mod.security.jose

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

Class AbstractJWKFactory<A extends AbstractJWK,B extends AbstractJWKBuilder<A,B>,C extends AbstractJWKGenerator<A,C>>

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKFactory<A,B,C>

Type Parameters:

A - the JWK type

B - the JWK builder type

C - the JWK generator type

All Implemented Interfaces:

JWKFactory<A,B,C>

Direct Known Subclasses:

AbstractX509JWKFactory, GenericOCTJWKFactory, GenericPBES2JWKFactory

public abstract class AbstractJWKFactory<A extends AbstractJWK,B extends AbstractJWKBuilder<A,B>,C extends AbstractJWKGenerator<A,C>>
extends Object
implements JWKFactory<A,B,C>

Base JSON Web Key factory implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected final JOSEConfiguration	configuration	The JOSE module configuration.
protected final JWKStore	jwkStore	The JWK Key store.
protected final JWKKeyResolver	keyResolver	The JWK Key resolver.
protected final com.fasterxml.jackson.databind.ObjectMapper	mapper	The object mapper.

Constructor Summary

Constructors

Constructor	Description
AbstractJWKFactory(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, com.fasterxml.jackson.databind.ObjectMapper mapper)	Creates a JWK factory

Method Summary

Modifier and Type	Method	Description
abstract B	builder(Map<String,Object> parameters)	Returns a new JWK builder initialized with the specified parameters map.
reactor.core.publisher.Mono<A>	generate(String alg, Map<String,Object> parameters)	Generates a new key using the specified parameters.
abstract C	generator(String alg, Map<String,Object> parameters)	Returns a new JWK generator initialized with the specified parameters map.
reactor.core.publisher.Mono<A>	read(String jwk)	Reads the specified JWK or JWK set serialized as JSON.
reactor.core.publisher.Mono<A>	read(Map<String,Object> jwk)	Read the specified JWK or JWK set represented in the specified map.

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.jwk.JWKFactory

builder, generator, supports, supportsAlgorithm

Field Details

configuration

protected final JOSEConfiguration configuration

The JOSE module configuration.

jwkStore

protected final JWKStore jwkStore

The JWK Key store.

keyResolver

protected final JWKKeyResolver keyResolver

The JWK Key resolver.

mapper

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

The object mapper.

Constructor Details

AbstractJWKFactory

public AbstractJWKFactory(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a JWK factory

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

mapper - an object mapper

Method Details

read

public reactor.core.publisher.Mono<A> read(String jwk)
                                    throws JWKReadException,
JWKBuildException,
JWKResolveException,
JWKProcessingException

Description copied from interface: JWKFactory

Reads the specified JWK or JWK set serialized as JSON.

Specified by:

read in interface JWKFactory<A extends AbstractJWK,B extends AbstractJWKBuilder<A,B>,C extends AbstractJWKGenerator<A,C>>

Parameters:

jwk - a JSON serialized JWK or JWK set

Returns:

a publisher of keys

Throws:

JWKReadException - if there was an error reading the input or a particular key

JWKBuildException - if there was an error building a key

JWKResolveException - if there was an error resolving a key

JWKProcessingException - if there was an error processing a key

read

public reactor.core.publisher.Mono<A> read(Map<String,Object> jwk)
                                    throws JWKReadException,
JWKBuildException,
JWKResolveException,
JWKProcessingException

Description copied from interface: JWKFactory

Read the specified JWK or JWK set represented in the specified map.

Specified by:

read in interface JWKFactory<A extends AbstractJWK,B extends AbstractJWKBuilder<A,B>,C extends AbstractJWKGenerator<A,C>>

Parameters:

jwk - a map representing a JWK or a JWK set

Returns:

a publisher of keys

Throws:

JWKReadException - if there was an error reading the input or a particular key

JWKBuildException - if there was an error building a key

JWKResolveException - if there was an error resolving a key

JWKProcessingException - if there was an error processing a key

generate

public reactor.core.publisher.Mono<A> generate(String alg,
 Map<String,Object> parameters)
                                        throws JWKGenerateException,
JWKProcessingException

Description copied from interface: JWKFactory

Generates a new key using the specified parameters.

This is a convenience method, you should prefer using JWKFactory.generator() which is more robust.

Specified by:

generate in interface JWKFactory<A extends AbstractJWK,B extends AbstractJWKBuilder<A,B>,C extends AbstractJWKGenerator<A,C>>

Parameters:

alg - a JWA algorithm

parameters - a map of key parameters

Returns:

a single publisher of key

Throws:

JWKGenerateException - if there was an error generating the key

JWKProcessingException - if there was a processing error

builder

public abstract B builder(Map<String,Object> parameters)

Returns a new JWK builder initialized with the specified parameters map.

Parameters:

parameters - a parameters map

Returns:

a new JWK builder

generator

public abstract C generator(String alg,
 Map<String,Object> parameters)

Returns a new JWK generator initialized with the specified parameters map.

Parameters:

alg - a JWK algorithm

parameters - a parameters map

Returns:

a new JWK generator