View Javadoc
1   /**
2    * This file Copyright (c) 2017 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.datasource.jcr;
35  
36  import info.magnolia.context.Context;
37  import info.magnolia.jcr.wrapper.DelegatePropertyWrapper;
38  
39  import java.util.Objects;
40  
41  import javax.inject.Provider;
42  import javax.jcr.Property;
43  import javax.jcr.RepositoryException;
44  import javax.jcr.Session;
45  
46  import lombok.SneakyThrows;
47  import lombok.experimental.Delegate;
48  
49  /**
50   * JCR property wrapper in the spirit of {@link SessionReattachingNodeWrapper}.
51   * The main purpose of such provider is to make property session re-attachment
52   * a transparent process to the user. Also this class implements {@link SupportsRenaming}
53   * interface in order to enable property renaming operations from UI.
54   */
55  @SuppressWarnings("unchecked")
56  public class SessionReattachingPropertyWrapper extends DelegatePropertyWrapper implements SupportsRenaming {
57  
58      @Delegate
59      private JcrItemRenameOperationHelper renameOperationHelper = new JcrItemRenameOperationHelper();
60  
61      private String workspace;
62      private String path;
63      private final Provider<Context> contextProvider;
64  
65      public SessionReattachingPropertyWrapper(Property property, Provider<Context> contextProvider) throws RepositoryException {
66          super(property);
67          this.workspace = property.getSession().getWorkspace().getName();
68          this.path = property.getPath();
69          this.contextProvider = contextProvider;
70      }
71      
72      @Override
73      @SneakyThrows(RepositoryException.class)
74      public Property getWrappedProperty() {
75          if (super.getWrappedProperty() == null || !super.getWrappedProperty().getSession().isLive()) {
76              Session session = getSessionForWrappedNode(this.workspace);
77              setWrappedProperty(session.getProperty(this.path));
78          }
79          return super.getWrappedProperty();
80      }
81  
82      @Override
83      public String getPath() {
84          return this.path;
85      }
86  
87      private Session getSessionForWrappedNode(String workspace) throws RepositoryException {
88          return contextProvider.get().getJCRSession(workspace);
89      }
90  
91      @Override
92      public boolean equals(Object o) {
93          if (this == o) return true;
94          if (!(o instanceof SessionReattachingPropertyWrapper)) return false;
95          SessionReattachingPropertyWrapper that = (SessionReattachingPropertyWrapper) o;
96          return Objects.equals(workspace, that.workspace) &&
97                  Objects.equals(getPath(), that.getPath());
98      }
99  
100     @Override
101     public int hashCode() {
102         return Objects.hash(workspace, getPath());
103     }
104 }
105