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.archiveclient.service.archive; 35 36 import fr.paris.lutece.plugins.archiveclient.service.util.ArchiveClientException; 37 38 39 /** 40 * class for calling archive service 41 * @author merlinfe 42 * 43 */ 44 public interface IArchiveClientService 45 { 46 /** 47 * request for archiving an folder 48 * @param strFolderToArchive path to the folder to archive 49 * @param strArchiveDestination path to the destination folder which will store the archive 50 * @param strArchiveName the name of the archive 51 * @param strArchiveType the archive type(zip,..) 52 * @return the archive id 53 * @throws ArchiveClientException exception if there is a problem 54 */ 55 int generateArchive( String strFolderToArchive, String strArchiveDestination, String strArchiveName, 56 String strArchiveType ) throws ArchiveClientException; 57 58 /** 59 * return the state of the archive with the ID parameter is provided 60 * @param archiveItemKey the archive id 61 * @return the state of the archive 62 * @throws ArchiveClientException exception if there is a problem 63 */ 64 String informationArchive( int archiveItemKey ) throws ArchiveClientException; 65 66 /** 67 * Remove the archive with the ID parameter is provided 68 * @param archiveItemKey the archive id 69 * @throws ArchiveClientException exception if there is a problem 70 */ 71 void removeArchive( int archiveItemKey ) throws ArchiveClientException; 72 73 /** 74 * get the url of the archive with the ID parameter is provided 75 * @param archiveItemKey the archive id 76 * @return the url of the archive 77 */ 78 String getDownloadUrl( int archiveItemKey ); 79 }