View Javadoc
1   /**
2    * This file Copyright (c) 2012-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.message;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.api.event.AdmincentralEventBus;
38  import info.magnolia.ui.api.message.Message;
39  import info.magnolia.ui.framework.message.MessagesManager.MessageListener;
40  
41  import javax.inject.Inject;
42  import javax.inject.Named;
43  
44  import com.vaadin.server.VaadinSession;
45  import com.vaadin.ui.UI;
46  
47  /**
48   * Dispatches events on an {@link EventBus} for a certain user.
49   */
50  public class LocalMessageDispatcher implements MessageListener {
51  
52      private final UI ui;
53      private EventBus eventBus;
54  
55      @Inject
56      public LocalMessageDispatcher(@Named(AdmincentralEventBus.NAME) final EventBus eventBus, UI ui) {
57          this.eventBus = eventBus;
58          this.ui = ui;
59      }
60  
61      /**
62       * @deprecated since 5.5.5 - use {@link #LocalMessageDispatcher(EventBus, UI)} instead.
63       */
64      @Deprecated
65      public LocalMessageDispatcher(final EventBus eventBus, VaadinSession vaadinSession) {
66          this(eventBus, UI.getCurrent());
67      }
68  
69      @Override
70      public void messageSent(final Message message) {
71          if (ui.isAttached()) {
72              ui.access(() -> eventBus.fireEvent(new MessageEvent(message, false)));
73          }
74      }
75  
76      @Override
77      public void messageCleared(final Message message) {
78          if (ui.isAttached()) {
79              ui.access(() -> eventBus.fireEvent(new MessageEvent(message, true)));
80          }
81      }
82  
83      @Override
84      public void messageRemoved(final String id) {
85          if (ui.isAttached()) {
86              ui.access(() -> eventBus.fireEvent(new MessageEvent(id, true)));
87          }
88      }
89  }