Package de.hybris.platform.acceleratorstorefrontcommons.controllers.pages

Class AbstractPageController

java.lang.Object
de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController
de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController
Direct Known Subclasses:
AbstractCartPageController, AbstractCheckoutController, AbstractProductConfigController, AbstractRegisterPageController, AbstractSearchPageController, AnonymousConsentController, ChineseBusinessUnitManagementPageController, ChineseMobileBindingController, ConfigureController, CustomerReviewController, DefaultPageController, DefaultPunchOutController, EmailPageController, GuestOrderController, HomePageController, ImportCSVPageController, MyCartPageController, NotificationPreferencePageController, PasswordResetPageController, PreviewContentPageController, ProductPageController, ProductQrPageController, ProductTextfieldConfiguratorController, QuickOrderPageController, StockNotificationPageController, StorePageController, VerificationCodeController, WeChatPayController
public abstract class AbstractPageController extends AbstractController
Base controller for all page controllers. Provides common functionality for all page controllers.

  • Field Details

  • Constructor Details

    • AbstractPageController

      public AbstractPageController()

  • Method Details

    • getSiteConfigService

      protected SiteConfigService getSiteConfigService()

    • getCmsSiteService

      protected CMSSiteService getCmsSiteService()

    • getCmsPageService

      protected CMSPageService getCmsPageService()

    • getStoreSessionFacade

      protected StoreSessionFacade getStoreSessionFacade()

    • getCustomerFacade

      protected CustomerFacade getCustomerFacade()

    • getSessionService

      protected SessionService getSessionService()

    • getHostConfigService

      protected HostConfigService getHostConfigService()

    • getMessageSource

      protected org.springframework.context.MessageSource getMessageSource()

    • getI18nService

      protected I18NService getI18nService()

    • getUserFacade

      protected UserFacade getUserFacade()

    • getConfigurationService

      protected ConfigurationService getConfigurationService()

    • getBaseSiteService

      protected BaseSiteService getBaseSiteService()

    • getConsentFacade

      protected ConsentFacade getConsentFacade()

    • getCmsPreviewService

      protected CMSPreviewService getCmsPreviewService()

    • getLanguages

      @ModelAttribute("languages") public Collection<LanguageData> getLanguages()

    • getCurrencies

      @ModelAttribute("currencies") public Collection<CurrencyData> getCurrencies()

    • getCurrentLanguage

      @ModelAttribute("currentLanguage") public LanguageData getCurrentLanguage()

    • getCurrentCurrency

      @ModelAttribute("currentCurrency") public CurrencyData getCurrentCurrency()

    • getSiteName

      @ModelAttribute("siteName") public String getSiteName()

    • getSiteUid

      @ModelAttribute("siteUid") public String getSiteUid()

    • getUser

      @ModelAttribute("user") public CustomerData getUser()

    • storeCmsPageInModel

      protected void storeCmsPageInModel(org.springframework.ui.Model model, AbstractPageModel cmsPage)

    • storeContentPageTitleInModel

      protected void storeContentPageTitleInModel(org.springframework.ui.Model model, String title)

    • getViewForPage

      protected String getViewForPage(org.springframework.ui.Model model)

    • getViewForPage

      protected String getViewForPage(AbstractPageModel page)

    • checkRequestUrl

      protected String checkRequestUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String resolvedUrlPath) throws UnsupportedEncodingException
      Checks request URL against properly resolved URL and returns null if url is proper or redirection string if not.
      Parameters:
      request - - request that contains current URL
      response - - response to write "301 Moved Permanently" status to if redirected
      resolvedUrlPath - - properly resolved URL
      Returns:
      null if url is properly resolved or redirection string if not
      Throws:
      UnsupportedEncodingException

    • getContentPageForLabelOrId

      protected ContentPageModel getContentPageForLabelOrId(String labelOrId) throws CMSItemNotFoundException
      Finds a content page by label or id and evaluates the cms restrictions associated to the page and components on the page.
      Parameters:
      labelOrId - the label or id used for the look-up
      Returns:
      a content page
      Throws:
      CMSItemNotFoundException - when no page is found for the provided label or id

    • getPageTitleResolver

      protected PageTitleResolver getPageTitleResolver()

    • storeContinueUrl

      protected void storeContinueUrl(javax.servlet.http.HttpServletRequest request)

    • setUpMetaData

      protected void setUpMetaData(org.springframework.ui.Model model, String metaKeywords, String metaDescription)

    • createMetaElement

      protected MetaElementData createMetaElement(String name, String content)

    • setUpMetaDataForContentPage

      protected void setUpMetaDataForContentPage(org.springframework.ui.Model model, ContentPageModel contentPage)

    • getRequestContextData

      protected RequestContextData getRequestContextData(javax.servlet.http.HttpServletRequest request)

    • urlEncode

      protected String urlEncode(String url)
      Url encode.
      Parameters:
      url - the url
      Returns:
      the encoded string
      Throws:
      IllegalArgumentException - if url is null

    • prepareNotFoundPage

      protected void prepareNotFoundPage(org.springframework.ui.Model model, javax.servlet.http.HttpServletResponse response) throws CMSItemNotFoundException
      Prepares Not Found (404) Page
      Parameters:
      model - The model to pass with the page
      response - object represents http response needed for setting not found status.
      Throws:
      CMSItemNotFoundException - when cannot find ContentPage with "notFound" id

    • getCheckoutRedirectUrl

      protected String getCheckoutRedirectUrl()
      Method used to determine the checkout redirect URL that will handle the checkout process.
      Returns:
      A String object of the URL to redirect to.

    • addRegistrationConsentDataToModel

      protected void addRegistrationConsentDataToModel(org.springframework.ui.Model model)

    • decodeWithScheme

      protected String decodeWithScheme(String source, String enc)
      Decodes a string with encoding using a specific encoding scheme.
      Parameters:
      source - A string to decode
      enc - The name of a supported character encoding. Default value is UTF-8 if no value is provided.
      Returns:
      A decoded string