Package com.broadleafcommerce.sandbox.service

Interface PreviewTokenEncoder

All Known Implementing Classes:
JWTPreviewTokenEncoder
public interface PreviewTokenEncoder
An interface used for encoding preview tokens.
Author:
Nick Crum (ncrum)
See Also:
  • for the decoder used for the preview token

  • Method Summary

    Modifier and Type
    Method
    Description
    com.broadleafcommerce.data.tracking.core.preview.PreviewToken
    encode(com.broadleafcommerce.data.tracking.core.preview.PreviewToken previewToken)
    Encodes a token from the PreviewToken and should return the same object with `token` property containing the encoded token string.

  • Method Details

    • encode

      com.broadleafcommerce.data.tracking.core.preview.PreviewToken encode(com.broadleafcommerce.data.tracking.core.preview.PreviewToken previewToken) throws PreviewTokenEncoderException
      Encodes a token from the PreviewToken and should return the same object with `token` property containing the encoded token string.
      Parameters:
      previewToken - the preview token without an encoded preview token string
      Returns:
      the preview token with an encoded preview token string
      Throws:
      PreviewTokenEncoderException - when it fails to encode the preview token