Package com.broadleafcommerce.sandbox.service

Class DefaultPreviewTokenService

java.lang.Object
com.broadleafcommerce.sandbox.service.DefaultPreviewTokenService
All Implemented Interfaces:
PreviewTokenService
public class DefaultPreviewTokenService extends Object implements PreviewTokenService
The default implementation of the PreviewTokenService interface that makes use of PreviewTokenEncoder for the encoding of the PreviewToken.
Author:
Nick Crum (ncrum)

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultPreviewTokenService(com.broadleafcommerce.common.extension.TypeFactory typeFactory, PreviewTokenEncoder encoder, com.broadleafcommerce.data.tracking.core.preview.PreviewTokenDecoder decoder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.broadleafcommerce.data.tracking.core.preview.PreviewToken
    createPreviewToken(PreviewTokenRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Creates a new PreviewToken that can be exchanged for proof of access to a particular set of sandboxes for a user.
    protected com.broadleafcommerce.data.tracking.core.preview.PreviewTokenDecoder
    getDecoder()
     
    protected PreviewTokenEncoder
    getEncoder()
     
    protected com.broadleafcommerce.common.extension.TypeFactory
    getTypeFactory()
     
    com.broadleafcommerce.data.tracking.core.preview.PreviewToken
    validatePreviewToken(String tokenString, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Attempts to decoded and validate the provided token string into a PreviewToken.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DefaultPreviewTokenService

      public DefaultPreviewTokenService(com.broadleafcommerce.common.extension.TypeFactory typeFactory, PreviewTokenEncoder encoder, com.broadleafcommerce.data.tracking.core.preview.PreviewTokenDecoder decoder)

  • Method Details

    • createPreviewToken

      public com.broadleafcommerce.data.tracking.core.preview.PreviewToken createPreviewToken(PreviewTokenRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: PreviewTokenService
      Creates a new PreviewToken that can be exchanged for proof of access to a particular set of sandboxes for a user. This is used to provide a way for admin users to preview their sandbox data in a commerce application.
      Specified by:
      createPreviewToken in interface PreviewTokenService
      Parameters:
      request - the request with information on which sandboxes will be targeted
      contextInfo - the context information for this request
      Returns:
      a preview token object with an encoded token that is used to prove access to a sandbox

    • validatePreviewToken

      public com.broadleafcommerce.data.tracking.core.preview.PreviewToken validatePreviewToken(@NonNull String tokenString, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) throws PreviewTokenValidationException
      Description copied from interface: PreviewTokenService
      Attempts to decoded and validate the provided token string into a PreviewToken. This is used to provide a way to check that a token is valid and to extract the contents for display purposes.
      Specified by:
      validatePreviewToken in interface PreviewTokenService
      Parameters:
      tokenString - the encoded token string
      contextInfo - the context
      Returns:
      a preview token object
      Throws:
      PreviewTokenValidationException

    • getTypeFactory

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

    • getEncoder

      protected PreviewTokenEncoder getEncoder()

    • getDecoder

      protected com.broadleafcommerce.data.tracking.core.preview.PreviewTokenDecoder getDecoder()