1 /** 2 * This file Copyright (c) 2014-2017 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.dam.api; 35 36 import java.io.InputStream; 37 38 /** 39 * An AssetRendition is a "view" on a asset, for a specific MimeType. It can be a simple resize of an image, 40 * or a document conversion. 41 * 42 * @see AssetRenderer#render(Asset, com.google.common.net.MediaType, String) 43 * @see AssetProvider#getRendererFor(Asset, com.google.common.net.MediaType) 44 * @see AssetProviderRegistry#getRendererFor(Asset, com.google.common.net.MediaType) 45 */ 46 public interface AssetRendition { 47 48 /** 49 * Returns a link to the binary of this rendition; that is, a (partial) URL usable by client code to download the rendition. 50 * Depending on the renderer, this could return a URL that is relative to the webapp (i.e no protocol, 51 * no hostname, but starts with a / and the context path), or an external URL including the protocol and host name. 52 * For some, this may mean generating a link to the imaging module, the DownloadServlet, or for some it might mean 53 * something else entirely. 54 * Note: some provider may decide (based on configuration, perhaps), to *not* include the context path. 55 */ 56 String getLink(); 57 58 /** 59 * The name of this specific rendition, if any, as passed to {@link AssetRenderer#render(Asset, com.google.common.net.MediaType, String)}. 60 */ 61 String getRenditionName(); 62 63 /** 64 * The specific mime type of this rendition. 65 */ 66 String getMimeType(); 67 68 InputStream getStream(); 69 70 /** 71 * The Asset this rendition was created from. 72 */ 73 Asset getAsset(); 74 }