org.dd4t.providers.impl.BrokerComponentPresentationProvider Maven / Gradle / Ivy

Go to download
/*
 * 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.providers.impl;

import com.sdl.web.api.broker.WebComponentPresentationFactoryImpl;
import com.sdl.web.api.dynamic.WebComponentPresentationFactory;
import com.tridion.dcp.ComponentPresentation;
import org.apache.commons.lang3.StringUtils;
import org.dd4t.core.exceptions.ItemNotFoundException;
import org.dd4t.core.exceptions.SerializationException;
import org.dd4t.providers.AbstractComponentPresentationProvider;
import org.dd4t.providers.ComponentPresentationProvider;
import org.dd4t.providers.ComponentPresentationResultItem;
import org.dd4t.providers.ComponentPresentationResultItemImpl;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Provides access to Dynamic Component Presentations stored in the Content Delivery database. It uses CD API to
 * retrieve
 * raw DCP content from the database. Access to these objects is not cached, and as such must be cached externally.
 */
public class BrokerComponentPresentationProvider extends AbstractComponentPresentationProvider implements
        ComponentPresentationProvider {

    private static final Map FACTORY_CACHE = new ConcurrentHashMap<>();

    /**
     * Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId.
     * A templateId is not provided, so the DCP with the highest linking priority is retrieved.
     * 
     * Note: This method performs significantly slower than getDynamicComponentPresentation(int, int, int)!
     * Do provide a templateId!
     *
     * @param componentId   int representing the Component item id
     * @param publicationId int representing the Publication id of the DCP
     * @return String representing the content of the DCP
     * @throws ItemNotFoundException if the requested DCP cannot be found
     */
    @Override
    public String getDynamicComponentPresentation(int componentId, int publicationId) throws ItemNotFoundException,
            SerializationException {
        return getDynamicComponentPresentation(componentId, 0, publicationId);
    }

    /**
     * Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and
     * publicationId.
     *
     * @param componentId   int representing the Component item id
     * @param templateId    int representing the Component Template item id
     * @param publicationId int representing the Publication id of the DCP
     * @return String representing the content of the DCP
     * @throws ItemNotFoundException if the requested DCP cannot be found
     */
    @Override
    public String getDynamicComponentPresentation(int componentId, int templateId, int publicationId) throws
            ItemNotFoundException, SerializationException {

        ComponentPresentation result;
        result = getComponentPresentation(componentId, templateId, publicationId);
        final String resultString;
        resultString = result.getContent();

        if (!StringUtils.isEmpty(resultString)) {
            return decodeAndDecompressContent(resultString);
        }
        return null;
    }

    @Override
    public ComponentPresentationResultItem getDynamicComponentPresentationItem(int componentId, int
            publicationId) throws ItemNotFoundException, SerializationException {
        return getDynamicComponentPresentationItem(componentId, 0, publicationId);
    }

    @Override
    public ComponentPresentationResultItem getDynamicComponentPresentationItem(int componentId, int
            templateId, int publicationId) throws ItemNotFoundException, SerializationException {

        ComponentPresentation result = getComponentPresentation(componentId, templateId, publicationId);
        String resultString;
        ComponentPresentationResultItemImpl resultModel;

        if (result != null) {
            resultModel = new ComponentPresentationResultItemImpl(result.getPublicationId(), result.getComponentId(),
                    result.getComponentTemplateId());

            assertQueryResultNotNull(result, componentId, templateId, publicationId);
            resultString = result.getContent();

            if (!StringUtils.isEmpty(resultString)) {
                resultModel.setContentSource(decodeAndDecompressContent(resultString));
            } else {
                resultModel.setContentSource(resultString);
            }
        } else {
            resultModel = new ComponentPresentationResultItemImpl(0, 0, 0);
        }

        return resultModel;

    }

    protected ComponentPresentation getComponentPresentation(final int componentId, final int templateId, final int
            publicationId) throws ItemNotFoundException {

        WebComponentPresentationFactory factory = FACTORY_CACHE.get(publicationId);

        if (factory == null) {
            factory = new WebComponentPresentationFactoryImpl(publicationId);
            FACTORY_CACHE.put(publicationId, factory);
        }

        final ComponentPresentation result;
        if (templateId != 0) {
            result = factory.getComponentPresentation(componentId, templateId);
        } else {
            result = factory.getComponentPresentationWithHighestPriority(componentId);
        }

        assertQueryResultNotNull(result, componentId, templateId, publicationId);
        return result;
    }
}