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;
35  
36  import info.magnolia.ui.framework.ioc.ViewComponentProvider;
37  import info.magnolia.ui.framework.ioc.ViewContextKeyRegistry;
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.ui.api.ioc.UiContextScoped;
40  import info.magnolia.ui.framework.ioc.BeanStore;
41  import info.magnolia.ui.framework.ioc.SessionStore;
42  import info.magnolia.ui.framework.ioc.UiContextBoundComponentProvider;
43  import info.magnolia.ui.framework.ioc.UiContextReference;
44  import info.magnolia.util.Util;
45  
46  import java.util.Objects;
47  import java.util.stream.Stream;
48  
49  import javax.inject.Inject;
50  
51  /**
52   * {@link ViewProvider} implementation.
53   */
54  @UiContextScoped
55  public class ViewProviderImpl implements ViewProvider {
56  
57      private final UiContextReference currentUiContextReference;
58  
59      @Inject
60      ViewProviderImpl(UiContextReference currentUiContextReference) {
61          this.currentUiContextReference = currentUiContextReference;
62      }
63  
64      @Override
65      public <V extends UiFrameworkView, D extends ViewDefinition<V>> V create(D definition, Object... args) {
66          final Class<? extends V> viewImpl = definition.getImplementationClass();
67          final ViewContextKeyRegistry viewContextRegistry = ViewContextKeyRegistry.access();
68  
69          final UiContextBoundComponentProvider componentProvider = createComponentProvider(definition, args);
70          final UiContextReference viewContextReference = componentProvider.getUiContextReference();
71          final BeanStore beanStore = SessionStore.access().getBeanStore(viewContextReference);
72          Stream.of(args).filter(Objects::nonNull).forEach(arg -> beanStore.put(arg.getClass(), arg));
73  
74          final V view = componentProvider.newInstance(viewImpl, args);
75          viewContextRegistry.register(view, viewContextReference);
76          beanStore.put(viewImpl, view);
77  
78          return view;
79      }
80  
81      private <D extends ViewDefinition> UiContextBoundComponentProvider createComponentProvider(D definition, Object... args) {
82          final UiContextReference viewContextReference = generateUniqueViewContextReference(definition, ViewContextKeyRegistry.access());
83  
84          final BeanStore beanStore = SessionStore.access().createBeanStore(viewContextReference);
85  
86          Stream.of(args).forEach(arg -> beanStore.put(arg.getClass(), arg));
87  
88          final ViewComponentProvider viewComponentProvider = new ViewComponentProvider(viewContextReference);
89          beanStore.put(ComponentProvider.class, viewComponentProvider);
90          beanStore.put(ViewComponentProvider.class, viewComponentProvider);
91          beanStore.put(ViewProvider.class, new ViewProviderImpl(viewContextReference));
92          beanStore.put(definition.getClass(), definition);
93  
94          return viewComponentProvider;
95      }
96  
97      private  <V extends UiFrameworkView, D extends ViewDefinition<V>> UiContextReference generateUniqueViewContextReference(D definition, ViewContextKeyRegistry registry) {
98          String name = definition.getName();
99          UiContextReference viewContextReference;
100         do {
101             viewContextReference = UiContextReference.ofView(name, currentUiContextReference);
102             name = Util.createUniqueName(name);
103         } while (registry.isRegistered(viewContextReference));
104 
105         return viewContextReference;
106     }
107 }