1 /*
2 * Copyright (c) 2002-2017, 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.archive.service.archive;
35
36
37 /**
38 * service allowing the archive creation
39 * @author merlinfe
40 *
41 */
42 public interface IArchiveService
43 {
44 /**
45 * request for archiving an folder
46 * @param strFolderToArchive path to the folder to archive
47 * @param strArchiveDestination path to the destination folder which will store the archive
48 * @param strArchiveName the name of the archive
49 * @param strArchiveType the archive type(zip,..)
50 * @return the archive id
51 */
52 int generateArchive( String strFolderToArchive, String strArchiveDestination, String strArchiveName,
53 String strArchiveType );
54
55 /**
56 * return the state of the archive with the ID parameter is provided
57 * @param archiveItemKey the archive id
58 * @return the state of the archive
59 */
60 String informationArchive( int archiveItemKey );
61
62 /**
63 * remove the archive with the ID parameter is provided
64 * @param archiveItemKey the archive id
65 */
66 void removeArchive( int archiveItemKey );
67
68 /**
69 * method for running the archive process
70 * @param sbLogs the process log
71 */
72 void runGenerateArchive( StringBuilder sbLogs );
73 }