1 /**
2 * This file Copyright (c) 2014-2015 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 info.magnolia.dam.api.metadata.AssetMetadata;
37 import java.io.InputStream;
38 import java.util.Calendar;
39
40 /**
41 * An asset is a digital resource with associated metadata.
42 */
43 public interface Asset extends Item {
44
45 /**
46 * Returns a link to the binary of this asset; that is, a (partial) URL usable by client code to download the asset.
47 * Depending on the provider, this could return a URL that is relative to the current server (i.e no protocol,
48 * no hostname, but starts with a / and the context path), or an external URL including the protocol and host name.
49 * For some, this may mean generating a link to the DownloadServlet, for some it might mean something else entirely.
50 * Note: some provider may decide (based on configuration, perhaps), to *not* include the context path.
51 */
52 String getLink();
53
54 // ======================== Basic (Meta)data =======================================================================
55 String getTitle();
56
57 String getSubject();
58
59 String getDescription();
60
61 String getCaption();
62
63 String getLanguage();
64
65 String getCopyright();
66
67 String getComment();
68
69 Calendar getCreated();
70
71 Calendar getLastModified();
72
73 <M extends AssetMetadata> boolean supports(Class<M> metaDataType);
74
75 <M extends AssetMetadata> M getMetadata(Class<M> metaDataType);
76
77 // ======================== File/binary properties =================================================================
78 String getMimeType();
79
80 long getFileSize();
81
82 /**
83 * Returns the "preferred" file name for this asset's binary. The returned name should include the file's extension
84 * (if any), but not its path.
85 */
86 String getFileName();
87
88 /**
89 * Opens an {@link InputStream} to the binary data of this Asset. Client code is responsible for closing it.
90 * TODO: throw IOException ?
91 */
92 InputStream getContentStream();
93
94 }