com.adobe.aemds.guide.dor.BrandingService Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2016 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/

package com.adobe.aemds.guide.dor;

import com.day.cq.i18n.I18n;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.commons.json.JSONObject;

/**
 * Service to get branding components from meta-template.
 */
public interface BrandingService {
    /**
     * Get branding components from given meta-template.
     * Branding components are XFA objects within first master page or AF_MASTERPAGE.
     *
     * @param resourceResolver ResourceResolver to be used while resolving resources
     * @param metaTemplateRef path of meta-template from which branding components to be extracted
     * @return JSONObject representing branding components
     */
    JSONObject getBrandingComponents(ResourceResolver resourceResolver, String metaTemplateRef, I18n i18n);
}