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.task;
35  
36  import info.magnolia.cms.security.User;
37  import info.magnolia.context.Context;
38  import info.magnolia.context.MgnlContext;
39  import info.magnolia.context.SimpleContext;
40  import info.magnolia.context.SystemContext;
41  import info.magnolia.event.EventBus;
42  import info.magnolia.objectfactory.ComponentProvider;
43  import info.magnolia.task.event.TaskEvent;
44  import info.magnolia.ui.api.event.AdmincentralEventBus;
45  
46  import java.util.Locale;
47  
48  import javax.inject.Inject;
49  import javax.inject.Named;
50  
51  import com.vaadin.server.VaadinSession;
52  import com.vaadin.ui.UI;
53  
54  /**
55   * Dispatches Task events on an {@link EventBus} for a certain user.
56   */
57  public class LocalTaskDispatcher implements TaskEventDispatcher {
58  
59      private final User user;
60      private final Locale locale;
61      private final UI ui;
62      private EventBus eventBus;
63      private ComponentProvider componentProvider;
64  
65      @Inject
66      public LocalTaskDispatcher(@Named(AdmincentralEventBus.NAME) final EventBus eventBus, UI ui, Context context, ComponentProvider componentProvider) {
67          this.eventBus = eventBus;
68          this.componentProvider = componentProvider;
69          this.user = context.getUser();
70          this.locale = context.getLocale();
71          this.ui = ui;
72      }
73  
74      /**
75       * @deprecated since 5.5.5 - use {@link #LocalTaskDispatcher(EventBus, UI, Context, ComponentProvider)} instead.
76       */
77      @Deprecated
78      public LocalTaskDispatcher(final EventBus eventBus, VaadinSession vaadinSession, Context context, ComponentProvider componentProvider) {
79          this(eventBus, UI.getCurrent(), context, componentProvider);
80      }
81  
82      @Override
83      public void onTaskEvent(final TaskEvent taskEvent) {
84          if (!ui.isAttached()) {
85              return;
86          }
87  
88          ui.access(() -> {
89              boolean hasContext = MgnlContext.hasInstance();
90              if (!hasContext) {
91                  MgnlContext.setInstance(new SimpleContext(componentProvider.getComponent(SystemContext.class)) {
92                      @Override
93                      public User getUser() {
94                          return LocalTaskDispatcher.this.user;
95                      }
96  
97                      @Override
98                      public Locale getLocale() {
99                          return LocalTaskDispatcher.this.locale;
100                     }
101                 });
102             }
103             try {
104                 eventBus.fireEvent(taskEvent);
105             } catch (Exception ignore) {
106             } finally {
107                 if (!hasContext) {
108                     MgnlContext.setInstance(null);
109                 }
110             }
111         });
112     }
113 }