Package com.broadleafcommerce.cartoperation.service.csr

Class JWTTransferCartTokenEncoder

java.lang.Object

com.broadleafcommerce.cartoperation.service.csr.JWTTransferCartTokenEncoder

All Implemented Interfaces:

TransferCartTokenEncoder

public class JWTTransferCartTokenEncoder
extends Object
implements TransferCartTokenEncoder

A default implementation of the TransferCartTokenEncoder that encodes the TransferCartToken into a JWT token string.

Constructor Summary

Constructors

Constructor	Description
JWTTransferCartTokenEncoder()	Optional constructor if looking to manually configure the encoder using the setters.
JWTTransferCartTokenEncoder(JWTTransferCartTokenEncoderProperties properties)	Primary constructor for initializing the encoder

Method Summary

Modifier and Type	Method	Description
TransferCartToken	encode(TransferCartToken transferCartToken)	Encodes a token from the TransferCartToken and should return the same object with `token` property containing the encoded token string.
protected com.nimbusds.jwt.JWTClaimsSet	getClaims(TransferCartToken transferCartToken)
protected Date	getExpirationTime()
protected JWTTransferCartTokenEncoderProperties	getProperties()
protected com.nimbusds.jose.JWSSigner	getSigner()
void	setEncodedPrivateKey(String encodedPrivateKey)	Sets the value of JWTTransferCartTokenEncoderProperties.getEncodedPrivateKey(), and initializes the signer used to sign JWT tokens.
void	setExpirationTimeout(Duration expirationTimeout)	Setter for overwriting the current expiration time for JWTTransferCartTokenEncoderProperties.
void	setIssuer(String issuer)	Setter for overwriting the current issuer for JWTTransferCartTokenEncoderProperties.

Methods inherited from class java.lang.Object

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

Constructor Details

JWTTransferCartTokenEncoder

public JWTTransferCartTokenEncoder(@NonNull
 JWTTransferCartTokenEncoderProperties properties)

Primary constructor for initializing the encoder

Parameters:

properties - the property configuration for the encoder

JWTTransferCartTokenEncoder

public JWTTransferCartTokenEncoder()

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

Method Details

setEncodedPrivateKey

public void setEncodedPrivateKey(String encodedPrivateKey)

Sets the value of JWTTransferCartTokenEncoderProperties.getEncodedPrivateKey(), and initializes the signer used to sign JWT tokens.

Parameters:

encodedPrivateKey - the encoded private key

setIssuer

public void setIssuer(String issuer)

Setter for overwriting the current issuer for JWTTransferCartTokenEncoderProperties.

Parameters:

issuer - the issuer

setExpirationTimeout

public void setExpirationTimeout(Duration expirationTimeout)

Setter for overwriting the current expiration time for JWTTransferCartTokenEncoderProperties.

Parameters:

expirationTimeout - the expiration timeout duration

encode

public TransferCartToken encode(TransferCartToken transferCartToken)
                         throws TransferCartTokenEncoderException

Description copied from interface: TransferCartTokenEncoder

Encodes a token from the TransferCartToken and should return the same object with `token` property containing the encoded token string.

Specified by:

encode in interface TransferCartTokenEncoder

Parameters:

transferCartToken - the transfer cart token without an encoded token string

Returns:

the transfer cart token with an encoded token string

Throws:

TransferCartTokenEncoderException - when it fails to encode the token

getClaims

protected com.nimbusds.jwt.JWTClaimsSet getClaims(TransferCartToken transferCartToken)

getExpirationTime

protected Date getExpirationTime()

getProperties

protected JWTTransferCartTokenEncoderProperties getProperties()

getSigner

protected com.nimbusds.jose.JWSSigner getSigner()