View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 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.module.files;
35  
36  import info.magnolia.cms.core.HierarchyManager;
37  
38  import javax.jcr.Session;
39  
40  /**
41   * A {@link FileExtractor} which performs an MD5 check on the extracted files.
42   * @see info.magnolia.module.files.MD5CheckingFileExtractorOperation
43   */
44  public class MD5CheckingFileExtractor extends BasicFileExtractor {
45      private final FileExtractionLogger log;
46      private final Session session;
47  
48      /**
49       * @deprecated since 5.2.2 - use {@link MD5CheckingFileExtractor#MD5CheckingFileExtractor(FileExtractionLogger, Session)} instead.
50       */
51      @Deprecated
52      public MD5CheckingFileExtractor(FileExtractionLogger log, HierarchyManager hm) {
53          this(log, hm.getWorkspace().getSession());
54      }
55  
56      public MD5CheckingFileExtractor(FileExtractionLogger log, Session session) {
57          this.log = log;
58          this.session = session;
59      }
60  
61      @Override
62      protected FileExtractorOperation newOperation(String resourcePath, String absTargetPath) {
63          return new MD5CheckingFileExtractorOperation(log, session, resourcePath, absTargetPath);
64      }
65  }