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.contentapp.observation;
35  
36  import info.magnolia.ui.api.ioc.UiContextScoped;
37  import info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition;
38  import info.magnolia.ui.framework.ioc.Destructible;
39  import info.magnolia.ui.observation.DatasourceObservation;
40  
41  import java.util.Set;
42  import java.util.function.Consumer;
43  import java.util.stream.Stream;
44  
45  import javax.inject.Inject;
46  import javax.jcr.observation.Event;
47  
48  import org.apache.commons.lang3.StringUtils;
49  
50  import com.google.common.collect.Sets;
51  import com.machinezoo.noexception.Exceptions;
52  import com.vaadin.shared.Registration;
53  import com.vaadin.ui.UI;
54  
55  /**
56   * JCR Observation utility wrapper to be used within UI framework.
57   */
58  @UiContextScoped
59  public class JcrDataSourceObservation implements DatasourceObservation, Destructible {
60  
61      private final JcrDatasourceDefinition datasourceDefinition;
62      private final JcrObservation jcrObservation;
63      private final Set<Registration> registrations = Sets.newConcurrentHashSet();
64      private final UI ui;
65  
66      @Inject
67      JcrDataSourceObservation(JcrDatasourceDefinition datasourceDefinition, JcrObservation jcrObservation, UI ui) {
68          this.datasourceDefinition = datasourceDefinition;
69          this.jcrObservation = jcrObservation;
70          this.ui = ui;
71      }
72  
73      @Override
74      public Registration register(Runnable action) {
75          Consumer<Stream<Event>> consumer = events -> {
76              if (!ui.isAttached()) {
77                  destroy();
78                  return;
79              }
80  
81              boolean applicableEventPresent = events
82                      .map(Exceptions.wrap().function(Event::getPath))
83                      .map(path -> StringUtils.substringBeforeLast(path, "/") + "/")
84                      .anyMatch(path -> StringUtils.startsWith(path, this.datasourceDefinition.getRootPath()));
85  
86              if (applicableEventPresent) {
87                  if (ui.isAttached()) {
88                      ui.access(() -> {
89                          action.run();
90                          ui.push();
91                      });
92                  }
93              }
94          };
95  
96          this.jcrObservation.register(consumer, datasourceDefinition.getWorkspace());
97  
98          Registration observationRegistration = new Registration() {
99              @Override
100             public void remove() {
101                 jcrObservation.unregister(consumer, datasourceDefinition.getWorkspace());
102                 registrations.remove(this);
103             }
104         };
105         registrations.add(observationRegistration);
106 
107         return observationRegistration;
108     }
109 
110     @Override
111     public void destroy() {
112         registrations.forEach(Registration::remove);
113     }
114 }