com.broadleafcommerce.cartoperation.service.csr

Interface TransferCartTokenEncoder

All Known Implementing Classes:

JWTTransferCartTokenEncoder

public interface TransferCartTokenEncoder

An interface used for encoding transfer cart tokens.

See Also:

for the decoder used for the preview token

Method Summary

Modifier and Type	Method and 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.

Method Detail

encode

TransferCartToken encode(TransferCartToken transferCartToken)
                  throws TransferCartTokenEncoderException

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

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