com.mitre.storefront.web.view.UiExperienceViewResolver.java Source code

Introduction

Here is the source code for com.mitre.storefront.web.view.UiExperienceViewResolver.java

Source

/*
 * [y] hybris Platform
 *
 * Copyright (c) 2000-2015 hybris AG
 * All rights reserved.
 *
 * This software is the confidential and proprietary information of hybris
 * ("Confidential Information"). You shall not disclose such Confidential
 * Information and shall use it only in accordance with the terms of the
 * license agreement you entered into with hybris.
 *
 *  
 */
package com.mitre.storefront.web.view;

import de.hybris.platform.acceleratorservices.uiexperience.UiExperienceService;
import de.hybris.platform.commerceservices.enums.UiExperienceLevel;
import com.mitre.storefront.controllers.pages.AbstractPageController;

import java.util.Locale;
import java.util.Map;

import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.web.servlet.view.AbstractUrlBasedView;
import org.springframework.web.servlet.view.InternalResourceView;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

/**
 * A view resolver that detects the device a request is coming from and directs it to the appropriate view. This view
 * resolver extends Spring's org.springframework.web.servlet.view.InternalResourceViewResolver.
 */
public class UiExperienceViewResolver extends InternalResourceViewResolver {
    private static final Logger LOG = Logger.getLogger(UiExperienceViewResolver.class);

    private UiExperienceService uiExperienceService;
    private Map<UiExperienceLevel, String> uiExperienceViewPrefix;
    private String unknownUiExperiencePrefix;
    private String addOnPrefix;

    protected UiExperienceService getUiExperienceService() {
        return uiExperienceService;
    }

    @Required
    public void setUiExperienceService(final UiExperienceService uiExperienceService) {
        this.uiExperienceService = uiExperienceService;
    }

    protected Map<UiExperienceLevel, String> getUiExperienceViewPrefix() {
        return uiExperienceViewPrefix;
    }

    @Required
    public void setUiExperienceViewPrefix(final Map<UiExperienceLevel, String> uiExperienceViewPrefix) {
        this.uiExperienceViewPrefix = uiExperienceViewPrefix;
    }

    protected String getUnknownUiExperiencePrefix() {
        return unknownUiExperiencePrefix;
    }

    @Required
    public void setUnknownUiExperiencePrefix(final String unknownUiExperiencePrefix) {
        this.unknownUiExperiencePrefix = unknownUiExperiencePrefix;
    }

    protected String getAddOnPrefix() {
        return addOnPrefix;
    }

    @Required
    public void setAddOnPrefix(final String addOnPrefix) {
        this.addOnPrefix = addOnPrefix;
    }

    @Override
    protected Object getCacheKey(final String viewName, final Locale locale) {
        // Incorporate the UiExperienceLevel into the view cache
        return super.getCacheKey(viewName, locale) + "_"
                + getUiExperienceService().getUiExperienceLevel().getCode();
    }

    @Override
    protected AbstractUrlBasedView buildView(final String viewName) throws Exception {
        final UiExperienceLevel uiExperienceLevel = getUiExperienceService().getUiExperienceLevel();
        final String expandedViewName = getViewName(uiExperienceLevel, viewName);

        if (LOG.isDebugEnabled()) {
            LOG.debug("Expanded View Name [" + viewName + "] into [" + expandedViewName + "]");
        }

        final InternalResourceView view = (InternalResourceView) super.buildView(expandedViewName);
        view.setAlwaysInclude(false);
        return view;
    }

    public String getViewName(final UiExperienceLevel uiExperienceLevel, String viewName) {
        final String prefix = getUiExperienceViewPrefix().get(uiExperienceLevel);
        if (prefix != null) {
            if (viewName.startsWith(AbstractPageController.PAGE_ROOT + "addon:")) {
                viewName = viewName.replace(AbstractPageController.PAGE_ROOT + "addon:", "addon:"); // ...pages/addon:/<extension-name>/.../<component-view>....->....addon:/<extension-name>/.../<component-view>
            }

            if (viewName.startsWith("addon:")) {
                viewName = viewName.replace("addon:", ""); // ................................addon:/<extension-name>/cms/<component-view>....->..../<extension-name>/cms/<component-view>
                viewName = viewName.substring(1, viewName.length()); // ....................../<extension-name>/cms/<component-view>..........->....<extension-name>/cms/<component-view>
                final String extensionName = viewName.substring(0, viewName.indexOf('/')); // <extension-name>/cms/<component-view>...........->....<extension-name>
                viewName = viewName.substring(viewName.indexOf('/'), viewName.length()); // ..<extension-name>/cms/<component-view>...........->..../cms/<component-view>
                return getAddOnPrefix() + "/" + extensionName + "/" + prefix + viewName; // ..<addon-prefix>/<extension-name>/<ui-prefix>/cms/<component-view>
            }
            return prefix + viewName;
        }
        return getUnknownUiExperiencePrefix() + viewName;
    }
}