View Javadoc
1   /**
2    * This file Copyright (c) 2015-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.jcrbrowser.app.contentconnector;
35  
36  import info.magnolia.cms.core.version.VersionManager;
37  import info.magnolia.ui.vaadin.integration.contentconnector.JcrContentConnector;
38  import info.magnolia.ui.vaadin.integration.contentconnector.JcrContentConnectorDefinition;
39  import info.magnolia.ui.vaadin.integration.contentconnector.JcrContentConnectorDefinitionWrapper;
40  
41  import javax.inject.Inject;
42  
43  /**
44   * Simple extension of {@link JcrContentConnector}. The main differences from the parent class include:
45   * <ul>
46   * <li>{@link JcrContentConnectorDefinition} is substituted with a {@link JcrBrowserContentConnectorDefinition} in order to be able to modify the definition
47   * on the fly without affecting an original singleton definition</li>
48   * <li>{@link JcrBrowserContentConnectorDefinition#getDefaultItemId()} doesn't cache the value like the parent class - it is always re-resolved.
49   * </ul>
50   */
51  public class JcrBrowserContentConnector extends JcrContentConnector {
52  
53      /**
54       * @deprecated since 5.5.3 without replacement.
55       */
56      @Deprecated
57      public static final String SYSTEM_PROPERTY_URL_FRAGMENT_TEMPLATE = ".+@(mgnl|jcr)%s.+$";
58  
59      @Inject
60      public JcrBrowserContentConnector(VersionManager versionManager, JcrContentConnectorDefinition definition) {
61          super(versionManager, new JcrBrowserContentConnectorDefinition(definition));
62      }
63  
64      @Override
65      public JcrBrowserContentConnectorDefinition getContentConnectorDefinition() {
66          return (JcrBrowserContentConnectorDefinition) super.getContentConnectorDefinition();
67      }
68  
69      /**
70       * Simple wrapper around a {@link JcrBrowserContentConnectorDefinition}, allows for overriding the {@code workspace} property.
71       */
72      public static class JcrBrowserContentConnectorDefinition extends JcrContentConnectorDefinitionWrapper {
73  
74          private String workspace = null;
75  
76          public JcrBrowserContentConnectorDefinition(JcrContentConnectorDefinition delegate) {
77              super(delegate);
78          }
79  
80          @Override
81          public String getWorkspace() {
82              return workspace == null ? super.getWorkspace() : workspace;
83          }
84  
85          public void setWorkspace(String workspace) {
86              this.workspace = workspace;
87          }
88  
89      }
90  }