001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     dragos
018 *
019 * $Id$
020 */
021package org.nuxeo.ecm.platform.rendering;
022
023/**
024 * A RenderingEngine will be instantiated by the RenderingService according with the descriptor specified for it. The
025 * specific implementation of a RenderingEngine must be in classpath for it to be instantiated and used.
026 *
027 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
028 */
029public interface RenderingEngine {
030
031    String getFormatName();
032
033    /**
034     * Processes the given context and return a rendering result.
035     * <p>
036     * The processing must never return null. If some error occurs it must throw an exception.
037     *
038     * @param ctx the context to process
039     */
040    RenderingResult process(RenderingContext ctx) throws RenderingException;
041}