com.adobe.cq.gfx.Renderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18598.20241113T125352Z-241000

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2014 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 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.cq.gfx;

import java.io.InputStream;

import org.apache.sling.api.resource.ResourceResolver;

import aQute.bnd.annotation.ConsumerType;

/**
 * SPI interface for providing implementations for the {@link Gfx} API.
 */
@ConsumerType
public interface Renderer {

    /**
     * Renders the given plan and returns a binary file stream, typically an
     * image file format, depending on the plan.
     *
     * 
     * Validation and errors:
     * 

     *     
     *          If the plan cannot be rendered (e.g. unsupported operations or unsupported src references),
     *          return null. There should be a validation check at the beginning.
     *     
     *     
     *          If the plan can be rendered, but there is an exception, it should be thrown.
     *     
     * 
     *
     * @param plan describes the rendering operations
     * @param resolver a resource resolver to access files referenced in the plan
     * @return A binary file stream, typically an image file format.
     *         If the plan cannot be rendered, return null.
     * @throws java.lang.Exception if the rendering unexpectedly fails
     */
    InputStream render(Plan plan, ResourceResolver resolver) throws Exception;
}