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

Class ArchiveClientWsService

java.lang.Object

fr.paris.lutece.plugins.archiveclient.service.archive.AbstractArchiveClientService

fr.paris.lutece.plugins.archiveclient.service.archive.ArchiveClientWsService

All Implemented Interfaces:

IArchiveClientService

public class ArchiveClientWsService
extends AbstractArchiveClientService

ArchiveClientWsService

Author:

merlinfe

Constructor Summary

Constructors

Constructor and Description
ArchiveClientWsService()

Method Summary

Modifier and Type	Method and Description
int	generateArchive(String strFolderToArchive, String strArchiveDestination, String strArchiveName, String strArchiveType) request for archiving an folder
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
void	setRequestAuthenticatorForWS(fr.paris.lutece.util.signrequest.RequestAuthenticator requestAuthenticatorForWS) Setter method for requestAuthenticatorForWS

Methods inherited from class fr.paris.lutece.plugins.archiveclient.service.archive.AbstractArchiveClientService

getDownloadUrl, setRequestAuthenticatorForUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveClientWsService

public ArchiveClientWsService()

Method Detail

generateArchive

public int generateArchive(String strFolderToArchive,
                           String strArchiveDestination,
                           String strArchiveName,
                           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 - exception if there is a problem

informationArchive

public 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 - exception if there is a problem

removeArchive

public void removeArchive(int archiveItemKey)
                   throws ArchiveClientException

Remove the archive with the ID parameter is provided

Parameters:

archiveItemKey - the archive id

Throws:

ArchiveClientException - exception if there is a problem

setRequestAuthenticatorForWS

public void setRequestAuthenticatorForWS(fr.paris.lutece.util.signrequest.RequestAuthenticator requestAuthenticatorForWS)

Setter method for requestAuthenticatorForWS

Parameters:

requestAuthenticatorForWS - the request authenticator