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 java.util.Iterator;
37
38 import com.google.common.net.MediaType;
39
40 /**
41 * Entry point to retrieve {@link AssetProvider}s.
42 */
43 public interface AssetProviderRegistry {
44
45 Iterator<AssetProvider> getAllProviders();
46
47 /**
48 * Returns a Iterator of {@link AssetProvider} that support the requested mediaTypes; returns an empty Iterator
49 * if none.
50 * TODO - getProviders(Predicate) instead ? (might have a predicate for metadata...)
51 */
52 Iterator<AssetProvider> getProvidersFor(MediaType... mediaTypes);
53
54 /**
55 * TODO The below is currently not implemented/implementable, we'd need a canHandle(ItemKey) method on providers
56 * Returns the first provider that declares it can handle this key.
57 */
58 AssetProvider getProviderFor(ItemKey itemKey) throws NoSuchAssetProviderException;
59
60 AssetProvider getProviderById(String providerId) throws NoSuchAssetProviderException;
61
62 /**
63 * Returns an appropriate {@link AssetRenderer}, or null if there is none. First checks if the asset's provider
64 * has a specific AssetRenderer, and if not checks in a "global" registry.
65 */
66 AssetRenderer getRendererFor(Asset asset, MediaType to) throws NoSuchAssetRendererException;
67
68 /**
69 * Thrown when no {@link AssetProvider} can be found for the given {@link ItemKey} or String id.
70 */
71 static class NoSuchAssetProviderException extends DamException {
72 public NoSuchAssetProviderException(ItemKey itemKey) {
73 super("No AssetProvider can handle ItemKey <" + itemKey + ">");
74 }
75
76 public NoSuchAssetProviderException(String providerId) {
77 super("No AssetProvider with id <" + providerId + ">");
78 }
79 }
80
81 /**
82 * Thrown when no {@link AssetRenderer} can be found for the given {@link Asset} to be converted to the given {@link MediaType}.
83 */
84 static class NoSuchAssetRendererException extends DamException {
85 public NoSuchAssetRendererException(String mediaTypeFrom, MediaType to) {
86 super("No AssetRenderer can render " + mediaTypeFrom + " to " + to);
87 }
88 }
89
90 }