1 /**
2 * This file Copyright (c) 2018 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.ui.framework.datasource;
35
36 import info.magnolia.objectfactory.annotation.Multibinding;
37 import info.magnolia.ui.framework.ioc.DatasourceComponentParameterResolver;
38
39 import java.util.LinkedHashMap;
40 import java.util.Map;
41 import java.util.Optional;
42
43 /**
44 * Capable of producing utilities/interfaces to interact with the data sources programmatically.
45 * Depending on the data source such set of capabilities may vary.
46 *
47 * <p>
48 * In a generic app that interacts with some arbitrary data source, one can inject
49 * the instances that are provided by the related bundle. For instance, if an app is
50 * bound to a JCR datasource (via {@link info.magnolia.ui.contentapp.configuration.BrowserDescriptor#getDatasource() BrowserDescriptor#getDatasource()})
51 * and the system provides the reference implementation of a datasource bundle related to the JCR,
52 * then the developer can inject instances of e.g. {@link com.vaadin.data.provider.DataProvider Vaadin's DataProvider}
53 * by merely marking the c-tor argument with {@link DatasourceComponent} annotation.
54 * </p>
55 *
56 * @param <DEF> datasource definition type.
57 *
58 * @see DatasourceSupport
59 * @see DatasourceComponent
60 * @see DatasourceComponentParameterResolver
61 */
62 @Multibinding
63 public abstract class DatasourceBundle<DEF> {
64
65 private final Map<Class, DatasourceComponentFactory> providers = new LinkedHashMap<>();
66
67 private final Class<DEF> type;
68
69 public DatasourceBundle(Class<DEF> type) {
70 this.type = type;
71 }
72
73 public Class<DEF> supportedDataSourceType() {
74 return this.type;
75 }
76
77 public <T> Optional<T> lookup(Class<T> type, DEF definition) {
78 final Optional<Class> matchingFactoryMapping = providers.keySet().stream().filter(type::isAssignableFrom).findFirst();
79
80 //noinspection unchecked
81 return matchingFactoryMapping.map(providers::get).map(f -> (T) f.create(definition));
82 }
83
84 protected <T> void register(Class<? super T> type, DatasourceComponentFactory<DEF, T> factory) {
85 providers.put(type, factory);
86 }
87 }