View Javadoc
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.ioc;
35  
36  
37  import info.magnolia.ui.framework.datasource.DatasourceComponent;
38  import info.magnolia.ui.framework.datasource.DatasourceSupport;
39  import info.magnolia.objectfactory.MgnlInstantiationException;
40  import info.magnolia.objectfactory.ParameterInfo;
41  import info.magnolia.objectfactory.ParameterResolver;
42  
43  import java.util.stream.Stream;
44  
45  /**
46   * Resolves c-tor dependencies annotated with {@link DatasourceComponent}. Uses {@link DatasourceSupport} and
47   * a DS definition to determine the corresponding {@link info.magnolia.ui.framework.datasource.DatasourceBundle DatasourceBundle}
48   * and delegates the actual look-up to it.
49   *
50   * In case no suitable bundle is found or it does not provide a required component - an {@link MgnlInstantiationException} is thrown.
51   */
52  public class DatasourceComponentParameterResolver implements ParameterResolver {
53  
54      private final DatasourceSupport datasourceSupport;
55      private final Object datasourceDefinition;
56  
57      DatasourceComponentParameterResolver(DatasourceSupport datasourceSupport, Object datasourceDefinition) {
58          this.datasourceSupport = datasourceSupport;
59          this.datasourceDefinition = datasourceDefinition;
60      }
61  
62      @Override
63      public Object resolveParameter(ParameterInfo parameter) {
64          boolean isDatasourceComponent = Stream.of(parameter.getParameterAnnotations()).anyMatch(DatasourceComponent.class::isInstance);
65  
66          if (!isDatasourceComponent) {
67              return UNRESOLVED;
68          }
69  
70          return datasourceSupport
71                  .getDatasourceBundle(datasourceDefinition)
72                  .lookup(parameter.getParameterType(), datasourceDefinition)
73                  .orElseThrow(() -> new MgnlInstantiationException(String.format("Failed to resolve a datasource component of type [%s] based on the data source definition of type [%s]",
74                          parameter.getParameterType(),
75                          datasourceDefinition == null ? "<not specified>" : datasourceDefinition.getClass().getName())));
76      }
77  }