org.dd4t.mvc.utils.ComponentUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dd4t-mvc-support Show documentation
Provides support for MVC frameworks.
There is a newer version: 2.1.12
/*
 * Copyright (c) 2015 SDL, Radagio & R. Oudshoorn
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.dd4t.mvc.utils;

import org.dd4t.contentmodel.ComponentPresentation;
import org.dd4t.core.databind.BaseViewModel;
import org.dd4t.core.util.HttpUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletRequest;
import java.util.Map;

/**
 * dd4t-2
 */
public class ComponentUtils {

    private static final String COMPONENT_PRESENTATION_NAME = "componentPresentation";
    private static final Logger LOG = LoggerFactory.getLogger(ComponentUtils.class);

    private ComponentUtils() {

    }

    /**
     * Get the component from the request that has been set using
     * {@link #setComponentPresentation}.
     */
    public static ComponentPresentation getComponentPresentation(final HttpServletRequest request) {
        return (ComponentPresentation) request.getAttribute(COMPONENT_PRESENTATION_NAME);
    }

    public static void setComponentPresentation(final HttpServletRequest request, ComponentPresentation
            componentPresentation) {
        request.setAttribute(COMPONENT_PRESENTATION_NAME, componentPresentation);
        LOG.debug("Added Component Presentation with Component id {} and rootElementName '{}' to the request.",
                componentPresentation.getComponent().getId(), componentPresentation.getComponent().getSchema()
                        .getRootElement());
    }

    /**
     * Remove the component and model from the request which have been set using
     * {@link #setComponentPresentation}.
     */
    public static void removeComponentPresentation(final HttpServletRequest request) {
        request.removeAttribute(COMPONENT_PRESENTATION_NAME);
    }

    public static Map getViewModels(final HttpServletRequest request) {
        final ComponentPresentation componentPresentation = (ComponentPresentation) request.getAttribute
                (COMPONENT_PRESENTATION_NAME);
        if (componentPresentation != null) {
            return componentPresentation.getAllViewModels();
        }
        return null;
    }

    public static BaseViewModel getViewModel(String modelName) {
        final Map viewModels = getViewModels(HttpUtils.getCurrentRequest());
        if (viewModels != null && !viewModels.isEmpty()) {
            return viewModels.get(modelName);
        }
        return null;
    }


    public static Object getViewModels() {
        return getViewModels(HttpUtils.getCurrentRequest());
    }
}