fr.paris.lutece.plugins.archiveclient.service.archive
Interface IArchiveClientService

All Known Implementing Classes:
AbstractArchiveClientService, ArchiveClientLocalService, ArchiveClientWsService

public interface IArchiveClientService

class for calling archive service

Author:
merlinfe

Method Summary
 int generateArchive(java.lang.String strFolderToArchive, java.lang.String strArchiveDestination, java.lang.String strArchiveName, java.lang.String strArchiveType)
          request for archiving an folder
 java.lang.String getDownloadUrl(int archiveItemKey)
          get the url of the archive with the ID parameter is provided
 java.lang.String informationArchive(int archiveItemKey)
          return the state of the archive with the ID parameter is provided
 void removeArchive(int archiveItemKey)
          remove the archive with the ID parameter is provided
 

Method Detail

generateArchive

int generateArchive(java.lang.String strFolderToArchive,
                    java.lang.String strArchiveDestination,
                    java.lang.String strArchiveName,
                    java.lang.String strArchiveType)
                    throws ArchiveClientException
request for archiving an folder

Parameters:
strFolderToArchive - path to the folder to archive
strArchiveDestination - path to the destination folder which will store the archive
strArchiveName - the name of the archive
strArchiveType - the archive type(zip,..)
Returns:
the archive id
Throws:
ArchiveClientException

informationArchive

java.lang.String informationArchive(int archiveItemKey)
                                    throws ArchiveClientException
return the state of the archive with the ID parameter is provided

Parameters:
archiveItemKey - the archive id
Returns:
the state of the archive
Throws:
ArchiveClientException

removeArchive

void removeArchive(int archiveItemKey)
                   throws ArchiveClientException
remove the archive with the ID parameter is provided

Parameters:
archiveItemKey - the archive id
Throws:
ArchiveClientException

getDownloadUrl

java.lang.String getDownloadUrl(int archiveItemKey)
get the url of the archive with the ID parameter is provided

Parameters:
archiveItemKey - the archive id
Returns:
the url of the archive


Copyright © 2011 Mairie de Paris. All Rights Reserved.