Package com.logicaldoc.gui.frontend.client.services

Interface UpdateService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath("update")
public interface UpdateService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Document Service. This service allows r/w operations on documents.

Since:

7.3.1

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UpdateService.Instance

Method Summary

Modifier and Type	Method	Description
int[]	checkDownloadStatus()	Checks the status of the current download process
GUIPatch[]	checkPatch()	Check if the current installation has patches available
GUIParameter[]	checkUpdate()	Check if the current installation has an update package available
String	confirmPatch(String patchFileName)	Confirms a patch
String	confirmUpdate(String updateFileName)	Confirms an update package
void	downloadPatch(String id, String fileName, long fileSize)
void	downloadUpdate(String id, String fileName, long fileSize)
String[]	getPatchNotes(String patchFileName)	Retrieves more informations from the patch
String[]	getStatus(String fileName)	Retrieves the processing status for the specified update/patch file
String[]	getUpdateNotes(String updateFileName)	Retrieves more informations from the update
String	loadPatch()	Loads a new patch
String	loadUpdate()	Loads a new update package

Method Detail

checkUpdate

GUIParameter[] checkUpdate()

Check if the current installation has an update package available

Returns:

List of informations about the available update package or null

checkPatch

GUIPatch[] checkPatch()

Check if the current installation has patches available

Returns:

List of available patches

downloadUpdate

void downloadUpdate(String id,
                    String fileName,
                    long fileSize)

downloadPatch

void downloadPatch(String id,
                   String fileName,
                   long fileSize)

confirmUpdate

String confirmUpdate(String updateFileName)
              throws ServerException

Confirms an update package

Parameters:

updateFileName - The update file to confirm

Returns:

The path of the update folder

Throws:

ServerException - an error happened in the server application

confirmPatch

String confirmPatch(String patchFileName)
             throws ServerException

Confirms a patch

Parameters:

patchFileName - The patch file to confirm

Returns:

The path of the patch folder

Throws:

ServerException - an error happened in the server application

getUpdateNotes

String[] getUpdateNotes(String updateFileName)
                 throws ServerException

Retrieves more informations from the update

Parameters:

updateFileName - File name of the downloaded update package

Returns:

ChangeLog and Install file contents

Throws:

ServerException - an error happened in the server application

getPatchNotes

String[] getPatchNotes(String patchFileName)
                throws ServerException

Retrieves more informations from the patch

Parameters:

patchFileName - File name of the downloaded patch package

Returns:

ChangeLog and Install file contents

Throws:

ServerException - an error happened in the server application

checkDownloadStatus

int[] checkDownloadStatus()

Checks the status of the current download process

Returns:

download status code and download progress

loadUpdate

String loadUpdate()
           throws ServerException

Loads a new update package

Returns:

a result code

Throws:

ServerException - an error happened in the server application

loadPatch

String loadPatch()
          throws ServerException

Loads a new patch

Returns:

a result code

Throws:

ServerException - an error happened in the server application

getStatus

String[] getStatus(String fileName)

Retrieves the processing status for the specified update/patch file

Parameters:

fileName - the file to check

Returns:

first string is the processing status: null, running, processed; the second string is the log, the third string is the relevant command that should be executed