Class AbstractPageRedirectSupplier

java.lang.Object
de.hybris.platform.cmsocc.redirect.suppliers.impl.AbstractPageRedirectSupplier
All Implemented Interfaces:
PageRedirectSupplier
Direct Known Subclasses:
CategoryPageRedirectSupplier, ContentPageRedirectSupplier, EmailPageRedirectSupplier, ProductPageRedirectSupplier

public abstract class AbstractPageRedirectSupplier extends Object implements PageRedirectSupplier
Abstract implementation of PageRedirectSupplier providing common functionalities for other supplier implementations.
  • Constructor Details

    • AbstractPageRedirectSupplier

      public AbstractPageRedirectSupplier()
  • Method Details

    • populateParams

      protected abstract void populateParams(PreviewDataModel previewData, RequestParamData paramData)
      Populates the request parameters to make the request to redirect.
      Parameters:
      previewData - - the preview data
      paramData - - the request path and query parameters
    • getPreviewCode

      protected abstract String getPreviewCode(PreviewDataModel previewData)
      Retrieves the category or product code from preview data.
      Parameters:
      previewData - - the preview data
      Returns:
      the category code; can be NULL
    • getConstrainedBy

      public Predicate<ItemModel> getConstrainedBy()
      Description copied from interface: PageRedirectSupplier
      Predicate to test if a given page model matches the page type supplier.
      Specified by:
      getConstrainedBy in interface PageRedirectSupplier
      Returns:
      true if the supplier exists; false otherwise.
    • shouldNotRedirect

      protected boolean shouldNotRedirect(javax.servlet.http.HttpServletRequest request)
    • shouldRedirect

      public boolean shouldRedirect(javax.servlet.http.HttpServletRequest request, PreviewDataModel previewData)
      Description copied from interface: PageRedirectSupplier
      Determines whether to redirect the request depending upon the logic in supplier.
      Specified by:
      shouldRedirect in interface PageRedirectSupplier
      Parameters:
      request - - the http request
      previewData - - the preview data
      Returns:
      true if it needs to redirect the request; false otherwise.
    • buildRequestParamData

      protected RequestParamData buildRequestParamData(javax.servlet.http.HttpServletRequest request, PreviewDataModel previewData)
      Creates a RequestParamData object to store query and path parameters information which are used to build the redirect URL.
      Parameters:
      request - - the http request
      previewData - - the preview data
      Returns:
      a RequestParamData object
    • getRedirectUrl

      public String getRedirectUrl(javax.servlet.http.HttpServletRequest request, PreviewDataModel previewData)
      Description copied from interface: PageRedirectSupplier
      Constructs the redirect url given the http servlet request and the preview data.
      Specified by:
      getRedirectUrl in interface PageRedirectSupplier
      Parameters:
      request - - the http servlet request
      previewData - - the preview data
      Returns:
      the redirect url
    • getPagePredicate

      protected Predicate<ItemModel> getPagePredicate()
    • setPagePredicate

      public void setPagePredicate(Predicate<ItemModel> pagePredicate)
    • getTypeCodePredicate

      protected Predicate<String> getTypeCodePredicate()
    • setTypeCodePredicate

      public void setTypeCodePredicate(Predicate<String> typeCodePredicate)