001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.cmis;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032
033import org.apache.chemistry.opencmis.commons.data.RenditionData;
034
035/**
036 * Rendition provider interface used to generate alternative renditions for resources.<p>
037 */
038public interface I_CmsCmisRenditionProvider {
039
040    /**
041     * Gets the rendition content stream for the resource.<p>
042     *
043     * @param cms the CMS context
044     * @param resource the resource
045     *
046     * @return the content stream for the rendition of the resource
047     */
048    byte[] getContent(CmsObject cms, CmsResource resource);
049
050    /**
051     * Gets the rendition stream id.<p>
052     *
053     * @return the rendition stream id
054     */
055    String getId();
056
057    /**
058     * Gets the rendition kind.<p>
059     *
060     * @return the rendition kind
061     */
062    String getKind();
063
064    /**
065     * Gets the rendition mimetype.<p>
066     *
067     * @return the rendition mimetype
068     */
069    String getMimeType();
070
071    /**
072     * Gets the rendition data for a resource.<p>
073     *
074     * This method may return null to signal that a rendition can not be generated for the resource.<p>
075     *
076     * @param cms the current CMS context
077     * @param resource the resource
078     *
079     * @return the rendition data for the resource
080     */
081    RenditionData getRendition(CmsObject cms, CmsResource resource);
082
083}