View Javadoc
1   /**
2    * This file Copyright (c) 2011-2015 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.wrapper.NodeWrappingDelegateSessionWrapper;
37  
38  import java.io.IOException;
39  import java.io.OutputStream;
40  
41  import javax.jcr.Item;
42  import javax.jcr.Node;
43  import javax.jcr.PathNotFoundException;
44  import javax.jcr.RepositoryException;
45  import javax.jcr.Session;
46  
47  import org.apache.jackrabbit.commons.xml.DocumentViewExporter;
48  import org.apache.jackrabbit.commons.xml.Exporter;
49  import org.apache.jackrabbit.commons.xml.SystemViewExporter;
50  import org.apache.jackrabbit.commons.xml.ToXmlContentHandler;
51  import org.xml.sax.ContentHandler;
52  import org.xml.sax.SAXException;
53  
54  /**
55   * Session wrapper enabling Magnolia specific way of handling versioning on all child nodes. Wrapper will also ensure that version information are not exposed via export.
56   */
57  public class MgnlVersioningSession extends NodeWrappingDelegateSessionWrapper {
58  
59      public MgnlVersioningSession(Session wrapped) {
60          super(wrapped);
61      }
62  
63      @Override
64      protected Node wrapNode(Node node) {
65          return new MgnlVersioningNodeWrapper(node);
66      }
67  
68      @Override
69      public void exportSystemView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse) throws PathNotFoundException, SAXException, RepositoryException {
70          // customize exporter for root path to skip jcr:system
71          if ("/".equals(absPath)) {
72              export(absPath, new SystemViewExporter(getWrappedSession(), contentHandler, !noRecurse, !skipBinary) {
73  
74                  @Override
75                  protected void exportNode(String uri, String local, Node node) throws RepositoryException, SAXException {
76                      if ("jcr:system".equals(node.getName())) {
77                          // skip version history
78                          return;
79                      }
80                      super.exportNode(uri, local, node);
81                  }
82              });
83          } else {
84              getWrappedSession().exportSystemView(absPath, contentHandler, skipBinary, noRecurse);
85          }
86      }
87  
88      @Override
89      public void exportSystemView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse) throws IOException, PathNotFoundException, RepositoryException {
90          // for root path, create xml content handler and call other export method
91          if ("/".equals(absPath)) {
92              try {
93                  this.exportSystemView(absPath, new ToXmlContentHandler(out), skipBinary, noRecurse);
94              } catch (SAXException e) {
95                  Exception root = e.getException();
96                  if (root instanceof RepositoryException) {
97                      throw (RepositoryException) root;
98                  } else if (root instanceof IOException) {
99                      throw (IOException) root;
100                 } else {
101                     throw new RepositoryException("Error serializing system view XML", e);
102                 }
103             }
104         } else {
105             getWrappedSession().exportSystemView(absPath, out, skipBinary, noRecurse);
106         }
107     }
108 
109     @Override
110     public void exportDocumentView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse) throws PathNotFoundException, SAXException, RepositoryException {
111         // customize exporter for root path to skip jcr:system
112         if ("/".equals(absPath)) {
113             export(absPath, new DocumentViewExporter(getWrappedSession(), contentHandler, !noRecurse, !skipBinary) {
114 
115                 @Override
116                 protected void exportNode(String uri, String local, Node node) throws RepositoryException, SAXException {
117                     if ("jcr:system".equals(node.getName())) {
118                         // skip version history
119                         return;
120                     }
121                     super.exportNode(uri, local, node);
122                 }
123             });
124         } else {
125             getWrappedSession().exportDocumentView(absPath, contentHandler, skipBinary, noRecurse);
126         }
127     }
128 
129     @Override
130     public void exportDocumentView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse) throws IOException, PathNotFoundException, RepositoryException {
131         // for root path, create xml content handler and call other export method
132         if ("/".equals(absPath)) {
133             try {
134                 this.exportDocumentView(absPath, new ToXmlContentHandler(out), skipBinary, noRecurse);
135             } catch (SAXException e) {
136                 Exception root = e.getException();
137                 if (root instanceof RepositoryException) {
138                     throw (RepositoryException) root;
139                 } else if (root instanceof IOException) {
140                     throw (IOException) root;
141                 } else {
142                     throw new RepositoryException("Error serializing system view XML", e);
143                 }
144             }
145         } else {
146             getWrappedSession().exportDocumentView(absPath, out, skipBinary, noRecurse);
147         }
148     }
149 
150     private void export(String path, Exporter exporter) throws PathNotFoundException, SAXException, RepositoryException {
151         Item item = getItem(path);
152         if (item.isNode()) {
153             exporter.export((Node) item);
154         } else {
155             throw new PathNotFoundException("XML export is not defined for properties: " + path);
156         }
157     }
158 
159 }