View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.field;
35  
36  import info.magnolia.icons.MagnoliaIcons;
37  import info.magnolia.jcr.RuntimeRepositoryException;
38  import info.magnolia.ui.contentapp.JcrDataProvider;
39  import info.magnolia.ui.contentapp.JcrItemDescriber;
40  import info.magnolia.ui.contentapp.observation.JcrDataSourceObservation;
41  import info.magnolia.ui.contentapp.observation.JcrObservation;
42  import info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition;
43  import info.magnolia.ui.datasource.jcr.JcrSessionManager;
44  
45  import java.util.Collections;
46  
47  import javax.inject.Inject;
48  import javax.jcr.ItemNotFoundException;
49  import javax.jcr.Node;
50  import javax.jcr.RepositoryException;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  import com.vaadin.data.Converter;
56  import com.vaadin.data.Result;
57  import com.vaadin.data.ValueContext;
58  import com.vaadin.data.provider.DataProvider;
59  import com.vaadin.ui.IconGenerator;
60  import com.vaadin.ui.ItemCaptionGenerator;
61  
62  /**
63   * {@link SelectFieldSupport} implementation for the JCR node based datasources.
64   */
65  public class JcrSelectFieldSupport implements SelectFieldSupport<Node> {
66      private static final Logger log = LoggerFactory.getLogger(JcrSelectFieldSupport.class);
67  
68      private final JcrDatasourceDefinition datasourceDefinition;
69      private final JcrSessionManager sessionManager;
70      private final JcrObservation jcrObservation;
71      private JcrItemDescriber jcrItemDescriber;
72  
73      @Inject
74      public JcrSelectFieldSupport(JcrDatasourceDefinition datasourceDefinition, JcrSessionManager sessionManager, JcrObservation jcrObservation) {
75          this.datasourceDefinition = datasourceDefinition;
76          this.sessionManager = sessionManager;
77          this.jcrObservation = jcrObservation;
78          this.jcrItemDescriber = new JcrItemDescriber(datasourceDefinition);
79      }
80  
81      @Override
82      public DataProvider<Node, ?> getDataProvider() {
83          return new JcrDataProvider(datasourceDefinition, new JcrDataSourceObservation(jcrObservation), sessionManager);
84      }
85  
86      @Override
87      public ItemCaptionGenerator<Node> getItemCaptionGenerator() {
88          return node -> jcrItemDescriber.describe(Collections.singleton(node));
89      }
90  
91      @Override
92      public IconGenerator<Node> getIconGenerator() {
93          return node -> MagnoliaIcons.NODE_CONTENT;
94      }
95  
96      @Override
97      public Converter<Node, String> itemToLinkConverter() {
98          return new Converter<Node, String>() {
99              @Override
100             public Result<String> convertToModel(Node value, ValueContext context) {
101                 return Result.of(() -> {
102                     if (value == null) {
103                         return null;
104                     }
105 
106                     try {
107                         return value.getIdentifier();
108                     } catch (RepositoryException e) {
109                         throw new RuntimeRepositoryException(e);
110                     }
111 
112                 }, Throwable::getMessage);
113             }
114 
115             @Override
116             public Node convertToPresentation(String uuid, ValueContext context) {
117                 try {
118                     if (uuid == null) {
119                         return null;
120                     }
121 
122                     return sessionManager.getJCRSession().getNodeByUUID(uuid);
123                 } catch (ItemNotFoundException e) {
124                     log.debug("Failed to resolve JCR node with id [{}], returning null", uuid);
125                     return null;
126                 } catch (RepositoryException e) {
127                     throw new RuntimeRepositoryException(e);
128                 }
129             }
130         };
131     }
132 }