View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.app.stub;
35  
36  import info.magnolia.i18nsystem.SimpleTranslator;
37  import info.magnolia.ui.api.app.SubAppContext;
38  import info.magnolia.ui.api.location.DefaultLocation;
39  import info.magnolia.ui.api.location.Location;
40  import info.magnolia.ui.framework.app.BaseSubApp;
41  
42  import javax.inject.Inject;
43  
44  /**
45   * Stub {@link info.magnolia.ui.framework.app.BaseSubApp} extension showed in case an exception
46   * was thrown during original sub-app start-up phase. Displays a minimal view and sends the
47   * exception details to the Pulse in a form of a message.
48   */
49  public class FailedSubAppStub extends BaseSubApp<StubView> {
50  
51      public static final String MSG_KEY = "ui-framework.sub-app.start.failed";
52  
53      private Throwable relatedException;
54  
55      private SimpleTranslator i18n;
56  
57      @Inject
58      public FailedSubAppStub(SubAppContext subAppContext, Throwable relatedException, SimpleTranslator i18n) {
59          super(subAppContext, new StubView("icon-warning"));
60          this.relatedException = relatedException;
61          this.i18n = i18n;
62      }
63  
64      @Override
65      public StubView start(Location location) {
66          SubAppContext context = getSubAppContext();
67  
68          String subAppName = context.getSubAppDescriptor().getName();
69          String message = i18n.translate(MSG_KEY, subAppName);
70  
71          context.getAppContext().sendLocalMessage(new ExceptionMessage(relatedException, message, i18n));
72  
73          return super.start(location);
74      }
75  
76      @Override
77      protected Location getCurrentLocation() {
78          return new DefaultLocation();
79      }
80  }