View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.cms.core.version;
35  
36  import info.magnolia.jcr.decoration.ContentDecoratorNodeWrapper;
37  import info.magnolia.objectfactory.Components;
38  import info.magnolia.repository.RepositoryManager;
39  
40  import javax.jcr.Node;
41  import javax.jcr.RepositoryException;
42  import javax.jcr.version.Version;
43  
44  /**
45   * Wrapper providing support for Magnolia specific versioning ops (by copy).
46   */
47  public class MgnlVersioningNodeWrapper extends ContentDecoratorNodeWrapper<MgnlVersioningContentDecorator> {
48  
49      private final VersionManager versionManager;
50  
51      public MgnlVersioningNodeWrapper(Node node, MgnlVersioningContentDecorator mgnlVersioningContentDecorator, VersionManager versionManager) {
52          super(node, mgnlVersioningContentDecorator);
53          this.versionManager = versionManager;
54      }
55  
56      /**
57       * @deprecated since 5.4, use {@link #MgnlVersioningNodeWrapper(Node, MgnlVersioningContentDecorator, VersionManager)}.
58       */
59      @Deprecated
60      public MgnlVersioningNodeWrapper(Node node) {
61          this(node, new MgnlVersioningContentDecorator(), Components.getComponent(VersionManager.class));
62      }
63  
64      /**
65       * @deprecated since 5.4, use {@link #MgnlVersioningNodeWrapper(Node, MgnlVersioningContentDecorator, VersionManager)}.
66       */
67      @Deprecated
68      public MgnlVersioningNodeWrapper(Node node, MgnlVersioningContentDecorator mgnlVersioningContentDecorator) {
69          this(node, mgnlVersioningContentDecorator, Components.getComponent(VersionManager.class));
70      }
71  
72      /**
73       * @deprecated since 5.5, use {@link #MgnlVersioningNodeWrapper(Node, MgnlVersioningContentDecorator, VersionManager)}.
74       */
75      @Deprecated
76      public MgnlVersioningNodeWrapper(Node node, MgnlVersioningContentDecorator mgnlVersioningContentDecorator, RepositoryManager repositoryManager) {
77          this(node, mgnlVersioningContentDecorator, Components.getComponent(VersionManager.class));
78      }
79  
80      @Override
81      public void restore(String versionName, boolean removeExisting) throws RepositoryException {
82          Node raw = deepUnwrap(getClass());
83          Version version = versionManager.getVersion(raw, versionName);
84          versionManager.restore(raw, version, removeExisting);
85      }
86  
87      @Override
88      public void restore(Version version, boolean removeExisting) throws RepositoryException {
89          versionManager.restore(deepUnwrap(getClass()), version, removeExisting);
90      }
91  
92      @Override
93      public void restore(Version version, String relPath, boolean removeExisting) throws RepositoryException {
94          throw new UnsupportedOperationException("Magnolia doesn't support restore into specified path at the moment");
95      }
96  
97      @Override
98      public void restoreByLabel(String versionLabel, boolean removeExisting) throws RepositoryException {
99          throw new UnsupportedOperationException("Magnolia doesn't support locating versions by label at the moment");
100     }
101 
102     /**
103      * Remove version history while removing the content.
104      *
105      * TODO what about {@link javax.jcr.Session#removeItem(String)}? This was introduced before JCR 2.0. So just got forgotten during upgrade..
106      * How can we ever keep this in sync?
107      */
108     @Override
109     public void remove() throws RepositoryException {
110         wrapped = getWrappedNode();
111         versionManager.removeVersionHistory(wrapped);
112         wrapped.remove();
113     }
114 }