View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.dila.service;
35  
36  import fr.paris.lutece.plugins.dila.exception.DilaException;
37  
38  import java.io.File;
39  
40  
41  /**
42   * Interface for archive extract
43   */
44  public interface IDilaExtractService
45  {
46      /**
47       * Extract all files
48       * @throws DilaException Daemon exception
49       */
50      void extractAll(  ) throws DilaException;
51  
52      /**
53       * Check if parameter are valid
54       * @param strArchivesDirPath the dir to check
55       * @return <code>true</code> if parameters are valid; else
56       *         <code>false</code>
57       */
58      boolean isValidParameters( String strArchivesDirPath );
59  
60      /**
61       * Extract file
62       * @param file file to extract
63       * @param strArchiveName the archive name
64       * @param strDirPathExtract the dir path
65       * @param strDirPathCopy the dir copy path
66       * @throws Exception occurs during treatment
67       */
68      void extract( File file, String strArchiveName, String strDirPathExtract, String strDirPathCopy )
69          throws Exception;
70  }