Package com.logicaldoc.gui.frontend.client.dropbox

Interface DropboxService

All Superinterfaces:

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

All Known Implementing Classes:

DropboxServiceImpl

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

The client side stub for the Dropbox Service.

Since:

7.0

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DropboxService.Instance

Method Summary

Modifier and Type	Method	Description
boolean	exportDocuments(String targetPath, List<Long> folderIds, List<Long> docIds)	Exports documents and folders into Dropbox
String	finishAuthorization(String authorizationCode)	Ends the authorization code and saves the access token in the database
int	importDocuments(long targetFolder, List<String> paths)
boolean	isConnected()	Checks if the user has connected the LogicalDOC application to his Dropbox account
List<String>	loadSettings()	Save the settings used by the Dropbox module
void	saveSettings(String apiKey, String apiSecret)	Save the settings used by the Dropbox API
String	startAuthorization()	Starts the authorization process and returns the Dropbox authorization page URL to be shown to the user

Method Details

isConnected

boolean isConnected()
             throws ServerException

Checks if the user has connected the LogicalDOC application to his Dropbox account

Returns:

if the account has been connected

Throws:

ServerException - an error happened in the server application

startAuthorization

String startAuthorization()
                   throws ServerException

Starts the authorization process and returns the Dropbox authorization page URL to be shown to the user

Returns:

the authorization token

Throws:

ServerException - an error happened in the server application

finishAuthorization

String finishAuthorization(String authorizationCode)
                    throws ServerException

Ends the authorization code and saves the access token in the database

Parameters:

authorizationCode - the authorization code

Returns:

returned value

Throws:

ServerException - an error happened in the server application

exportDocuments

boolean exportDocuments(String targetPath,
 List<Long> folderIds,
 List<Long> docIds)
                 throws ServerException

Exports documents and folders into Dropbox

Parameters:

targetPath - the target path in Dropbox (must be a folder)

folderIds - Ids of the folders to be imported (all subfolders and docs will be imported as well

docIds - Ids of the documents to be imported

Returns:

true, if the export has been successful

Throws:

ServerException - an error happened in the server application

importDocuments

int importDocuments(long targetFolder,
 List<String> paths)
             throws ServerException

Throws:

ServerException

saveSettings

void saveSettings(String apiKey,
 String apiSecret)
           throws ServerException

Save the settings used by the Dropbox API

Parameters:

apiKey - identifier of the client

apiSecret - the secret key specified by he user

Throws:

ServerException - an error happened in the server application

loadSettings

List<String> loadSettings()
                   throws ServerException

Save the settings used by the Dropbox module

Returns:

apiKey, apiSecret

Throws:

ServerException - an error happened in the server application