View Javadoc
1   /**
2    * This file Copyright (c) 2016-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.tools;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.api.app.SubAppContext;
38  import info.magnolia.ui.api.app.SubAppDescriptor;
39  import info.magnolia.ui.framework.app.BaseSubApp;
40  
41  import java.util.Map;
42  
43  import javax.inject.Inject;
44  
45  import org.apache.commons.collections4.MapUtils;
46  
47  /**
48   * Implementation of a subApp with several tools.
49   *
50   * @see ToolsSubAppView
51   * @see ToolsSubAppDescriptor
52   * @see info.magnolia.ui.api.app.SubApp
53   */
54  public class ToolsSubApp extends BaseSubApp<ToolsSubAppView> {
55  
56      private final SubAppContext subAppContext;
57      private final ToolsSubAppView subAppView;
58      private final ComponentProvider componentProvider;
59  
60      @Inject
61      public ToolsSubApp(SubAppContext subAppContext, ToolsSubAppView subAppView, ComponentProvider componentProvider) {
62          super(subAppContext, subAppView);
63  
64          this.subAppContext = subAppContext;
65          this.subAppView = subAppView;
66          this.componentProvider = componentProvider;
67      }
68  
69      @Override
70      protected void onSubAppStart() {
71          SubAppDescriptor subAppDescriptor = subAppContext.getSubAppDescriptor();
72  
73          if (!(subAppDescriptor instanceof ToolsSubAppDescriptor)) {
74              throw new IllegalArgumentException(String.format("Cannot start ToolsSubApp '%s', expected ToolsSubAppDescriptor but got %s.", subAppDescriptor.getName(), subAppDescriptor.getClass().getSimpleName()));
75          }
76  
77          ToolsSubAppDescriptor toolsSubAppDescriptor = (ToolsSubAppDescriptor) subAppDescriptor;
78  
79          subAppView.setDescription(toolsSubAppDescriptor.getDescription());
80  
81          Map<String, ToolDefinition> toolDefinitions = toolsSubAppDescriptor.getTools();
82          if (MapUtils.isEmpty(toolDefinitions) || toolDefinitions.containsKey(null)) {
83              throw new IllegalArgumentException(String.format("Cannot start ToolsSubApp '%s', 'tools' (ToolDefinitions) are not configured.", subAppDescriptor.getName()));
84          }
85  
86          for (ToolDefinition toolDefinition : toolDefinitions.values()) {
87              if (toolDefinition.getPresenterClass() == null) {
88                  throw new IllegalArgumentException(String.format("Cannot start ToolPresenter '%s', 'presenterClass' is not configured.", toolDefinition.getName()));
89              }
90  
91              ToolPresenter toolPresenter = componentProvider.newInstance(toolDefinition.getPresenterClass());
92              subAppView.addToolView(toolDefinition.getLabel(), toolPresenter.start(toolDefinition));
93          }
94      }
95  }