Package com.broadleafcommerce.data.tracking.core.preview

Class JWTPreviewTokenDecoder

java.lang.Object

com.broadleafcommerce.data.tracking.core.preview.JWTPreviewTokenDecoder

All Implemented Interfaces:

PreviewTokenDecoder

public class JWTPreviewTokenDecoder
extends Object
implements PreviewTokenDecoder

A default implementation of the PreviewTokenDecoder that decoded the PreviewToken from a JWT token string.

Author:

Nick Crum (ncrum)

Constructor Summary

Constructors

Constructor	Description
JWTPreviewTokenDecoder(com.broadleafcommerce.common.extension.TypeFactory typeFactory, com.fasterxml.jackson.databind.ObjectMapper mapper)	Optional constructor if looking to manually configure the decoder using the setters.
JWTPreviewTokenDecoder(JWTPreviewTokenDecoderProperties properties, com.broadleafcommerce.common.extension.TypeFactory typeFactory, com.fasterxml.jackson.databind.ObjectMapper mapper)	Primary constructor for initializing the decoder

Method Summary

Modifier and Type	Method	Description
protected PreviewToken	convertToPreviewToken(com.nimbusds.jwt.JWTClaimsSet claims)
PreviewToken	decode(String encodedTokenString)	Decoded an encoded preview token string into a PreviewToken.
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper()
protected JWTPreviewTokenDecoderProperties	getProperties()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected com.nimbusds.jose.JWSVerifier	getVerifier()
void	setEncodedPublicKey(String encodedPublicKey)	Sets the value of JWTPreviewTokenDecoderProperties.getEncodedPublicKey(), and initializes the verifier used to verify JWT tokens.
void	setIssuer(String issuer)	Setter for overwriting the current issuer on JWTPreviewTokenDecoderProperties.
protected void	validateJWT(com.nimbusds.jwt.SignedJWT signedJWT)

Methods inherited from class java.lang.Object

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

Constructor Details

JWTPreviewTokenDecoder

public JWTPreviewTokenDecoder(JWTPreviewTokenDecoderProperties properties,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Primary constructor for initializing the decoder

Parameters:

properties - the property configuration for the decoder

JWTPreviewTokenDecoder

public JWTPreviewTokenDecoder(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Optional constructor if looking to manually configure the decoder using the setters.

Method Details

setEncodedPublicKey

public void setEncodedPublicKey(String encodedPublicKey)

Sets the value of JWTPreviewTokenDecoderProperties.getEncodedPublicKey(), and initializes the verifier used to verify JWT tokens.

Parameters:

encodedPublicKey - the encoded public key

setIssuer

public void setIssuer(String issuer)

Setter for overwriting the current issuer on JWTPreviewTokenDecoderProperties.

Parameters:

issuer - the issuer

decode

public PreviewToken decode(String encodedTokenString)
                    throws PreviewTokenParseException

Description copied from interface: PreviewTokenDecoder

Decoded an encoded preview token string into a PreviewToken.

Specified by:

decode in interface PreviewTokenDecoder

Parameters:

encodedTokenString - the encoded preview token string

Returns:

the decoded preview token

Throws:

PreviewTokenParseException - when there is an issue with the parsing of the encoded token

validateJWT

protected void validateJWT(com.nimbusds.jwt.SignedJWT signedJWT)
                    throws ParseException,
PreviewTokenParseException

Throws:

ParseException

PreviewTokenParseException

convertToPreviewToken

protected PreviewToken convertToPreviewToken(com.nimbusds.jwt.JWTClaimsSet claims)
                                      throws PreviewTokenParseException

Throws:

PreviewTokenParseException

getProperties

protected JWTPreviewTokenDecoderProperties getProperties()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()

getVerifier

protected com.nimbusds.jose.JWSVerifier getVerifier()