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.databinding.converter;
35  
36  import info.magnolia.cms.util.PathUtil;
37  import info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition;
38  import info.magnolia.ui.datasource.jcr.JcrSessionManager;
39  
40  import java.util.Optional;
41  
42  import javax.jcr.Node;
43  import javax.jcr.RepositoryException;
44  import javax.jcr.Session;
45  
46  import com.vaadin.data.Converter;
47  import com.vaadin.data.Result;
48  import com.vaadin.data.ValueContext;
49  
50  import lombok.SneakyThrows;
51  
52  /**
53   * JCR-specific implementation of {@link Converter}. Turns a Node (presentation type) into its identifier (model type or a String) and vice versa.
54   * Converting to presentation will attempt to resolve a node either from its identifier or its path.
55   */
56  public class JcrItemToLinkConverter implements Converter<Node, String> {
57  
58      private final JcrDatasourceDefinition definition;
59      private final JcrSessionManager contentDecorator;
60  
61      public JcrItemToLinkConverter(JcrDatasourceDefinition definition, JcrSessionManager contentDecorator) {
62          this.definition = definition;
63          this.contentDecorator = contentDecorator;
64      }
65  
66      @SneakyThrows(RepositoryException.class)
67      @Override
68      public Result<String> convertToModel(Node value, ValueContext context) {
69          if (value == null) {
70              return Result.ok(null);
71          }
72          return Result.ok(value.getIdentifier());
73      }
74  
75      @Override
76      public Node convertToPresentation(String value, ValueContext context) {
77          if (value == null) {
78              return null;
79          }
80          return resolveNodeByIdOrPath(value);
81      }
82  
83      private Node resolveNodeByIdOrPath(String value) {
84              // if value isn't an id, it may be a node name used for setting a default value
85              return Optional.ofNullable(getNodeByIdSafely(value))
86                      .orElseGet(() -> getNodeByPath(value));
87      }
88      
89      private Session getSession() throws RepositoryException {
90          return contentDecorator.getJCRSession();
91      }
92  
93      private Node getNodeByIdSafely(String value) {
94          try {
95              return getSession().getNodeByIdentifier(value);
96          } catch (RepositoryException e) {
97              // here we ignore the exception as value may be a path
98              return null;
99          }
100     }
101 
102     @SneakyThrows(RepositoryException.class)
103     private Node getNodeByPath(String value) {
104         return getSession().getNode(PathUtil.createPath(definition.getRootPath(), value));
105     }
106 }