org.exoplatform.clouddrive.dropbox

Class JCRLocalDropboxDrive

java.lang.Object

org.exoplatform.clouddrive.CloudDrive

org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

org.exoplatform.clouddrive.dropbox.JCRLocalDropboxDrive

All Implemented Interfaces:

org.exoplatform.clouddrive.CloudDriveSecurity, org.exoplatform.clouddrive.CloudDriveStorage, org.exoplatform.clouddrive.oauth2.UserTokenRefreshListener

public class JCRLocalDropboxDrive
extends org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive
implements org.exoplatform.clouddrive.oauth2.UserTokenRefreshListener

Local drive for Dropbox provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JCRLocalDropboxDrive.Connect Connect algorithm for Drobpox drive.
protected class	JCRLocalDropboxDrive.DbxFileInfo Dropbox file info (path as ID, name and parent path) extracted from its original path in Dropbox.
class	JCRLocalDropboxDrive.DropboxState
protected class	JCRLocalDropboxDrive.EventsSync An implementation of SyncCommand based on an abstract deltas queue proposed and maintained by the cloud service.
protected class	JCRLocalDropboxDrive.FileAPI CloudFileAPI implementation.
protected class	JCRLocalDropboxDrive.FullSync Deprecated.
protected class	JCRLocalDropboxDrive.MovedFile

Nested classes/interfaces inherited from class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.AbstractCommand, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.AbstractFileAPI, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.CommandCallable, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.ConnectCommand, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.DriveState, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.ExoJCREnvironment, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.ExoJCRSettings, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.FileChange, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.JCRListener, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.NoConnectCommand, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.NoSyncCommand, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.SyncCommand, org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.SyncFilesCommand

Nested classes/interfaces inherited from class org.exoplatform.clouddrive.CloudDrive

org.exoplatform.clouddrive.CloudDrive.Command, org.exoplatform.clouddrive.CloudDrive.CommandProgress, org.exoplatform.clouddrive.CloudDrive.FilesState, org.exoplatform.clouddrive.CloudDrive.ListenerSupport

Nested classes/interfaces inherited from interface org.exoplatform.clouddrive.CloudDriveStorage

org.exoplatform.clouddrive.CloudDriveStorage.Change<R>

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_LINK_EXPIRATION_PERIOD Time to expire for file links obtained from Dropbox without explicitly set expiration time.
static String	FOLDER_REV
static String	FOLDER_TYPE
protected Map<String,JCRLocalDropboxDrive.MovedFile>	moved Moved files with expiration on each sync run.
protected JCRLocalDropboxDrive.DropboxState	state Dropbox drive state.

Fields inherited from class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

accentsConverter, actionDrive, ALREADY_DONE, commandEnv, CURRENT_LOCALFORMAT, currentChangeId, currentConnect, currentSync, driveCommands, DUMMY_DATA, ECD_CLOUDDRIVE, ECD_CLOUDFILE, ECD_CLOUDFILERESOURCE, ECD_CLOUDFOLDER, ECD_IGNORED, ECD_LOCALFORMAT, EXO_DATETIME, EXO_MODIFY, EXO_THUMBNAIL, EXO_THUMBNAILS, EXO_TRASHFOLDER, fileAPI, fileChanges, fileChangeSequencer, fileCopies, fileHistory, fileRemovals, fileSynchronizers, fileTrash, finder, HISTORY_EXPIRATION, HISTORY_MAX_LENGTH, jcrListener, mimeTypes, MIX_REFERENCEABLE, noConnect, noSync, NT_FILE, NT_FOLDER, NT_RESOURCE, NT_UNSTRUCTURED, repository, rootNodeHolder, rootUUID, rootWorkspace, sessionProviders, syncFilesChanged, syncFilesMessages, syncLock, updating, user, USER_NODEPATH, USER_SESSIONPROVIDER, USER_WORKSPACE, workerExecutor

Fields inherited from class org.exoplatform.clouddrive.CloudDrive

listeners, LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JCRLocalDropboxDrive(org.exoplatform.clouddrive.dropbox.DropboxConnector.API apiBuilder, DropboxProvider provider, javax.jcr.Node driveNode, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.clouddrive.jcr.NodeFinder finder, org.exoplatform.clouddrive.utils.ExtendedMimeTypeResolver mimeTypes)
protected	JCRLocalDropboxDrive(DropboxUser user, javax.jcr.Node driveNode, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.clouddrive.jcr.NodeFinder finder, org.exoplatform.clouddrive.utils.ExtendedMimeTypeResolver mimeTypes)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanExpiredMoved()
protected org.exoplatform.clouddrive.CloudFileAPI	createFileAPI()
protected String	createSharedLink(javax.jcr.Node fileNode)
protected com.dropbox.core.DbxEntry	fetchSubtree(DropboxAPI api, String idPath, javax.jcr.Node node, boolean useHash, Collection<org.exoplatform.clouddrive.utils.ChunkIterator<?>> iterators, Collection<org.exoplatform.clouddrive.CloudFile> fetched)
protected String	findMimetype(String fileName)
protected String	folderHash(javax.jcr.Node node)
protected org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.ConnectCommand	getConnectCommand()
org.exoplatform.clouddrive.viewer.ContentReader	getFileContent(String idPath)
org.exoplatform.clouddrive.CloudDrive.FilesState	getState()
protected org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.SyncCommand	getSyncCommand()
DropboxUser	getUser()
protected String	idPath(String dbxPath) Return Dropbox path in guaranteed lower case.
protected void	initCloudItem(javax.jcr.Node localNode, Object item) Deprecated.
protected void	initDrive(javax.jcr.Node driveNode)
protected void	initDropboxCommon(javax.jcr.Node localNode, Boolean mightHaveThumbnail, String iconName) Initialize Dropbox entry (commons for file and folder).
protected void	initDropboxFile(javax.jcr.Node localNode, Boolean mightHaveThumbnail, String iconName, String rev, Long size) Initialize Dropbox file.
protected void	initDropboxFolder(javax.jcr.Node localNode, Boolean mightHaveThumbnail, String iconName, String deltaHash) Initialize Dropbox folder.
boolean	isSharingSupported()
protected String	link(javax.jcr.Node fileNode)
protected static DropboxUser	loadUser(org.exoplatform.clouddrive.dropbox.DropboxConnector.API apiBuilder, DropboxProvider provider, javax.jcr.Node driveNode) Load user from the drive Node.
protected String	nodeName(String title)
protected javax.jcr.Node	normalizeName(javax.jcr.Node fileNode) Ensure the cloud file node has name in lower-case.
protected boolean	notInRange(String path, Collection<String> range)
void	onUserTokenRefresh(org.exoplatform.clouddrive.oauth2.UserToken token)
protected String	previewLink(javax.jcr.Node fileNode)
protected Long	readChangeId()
protected void	refreshAccess()
protected com.dropbox.core.DbxEntry	restoreSubtree(DropboxAPI api, String idPath, javax.jcr.Node node)
protected void	saveChangeId(Long id)
void	shareFile(javax.jcr.Node fileNode, String... users)
protected void	updateAccess(org.exoplatform.clouddrive.CloudUser newUser)
protected org.exoplatform.clouddrive.jcr.JCRLocalCloudFile	updateItem(DropboxAPI api, JCRLocalDropboxDrive.DbxFileInfo file, com.dropbox.core.DbxEntry metadata, javax.jcr.Node parent, javax.jcr.Node node) Update or create a local node of Cloud File.
protected void	updateState(String cursor)

Methods inherited from class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

addJCRListener, addUpdating, await, checkNotTrashed, cleanName, cleanRemoved, cleanup, cleanUpdated, commitChanges, configure, connect, copyNode, create, currentUserName, disconnect, editLink, ensureSame, fileNode, findNode, findNodes, getChangeId, getConnectDate, getCurentCommand, getFile, getFilePreview, getId, getInitDate, getLink, getLocalUser, getOrCleanFileNode, getPath, getTitle, hasFile, hasRemoved, hasUpdated, ignore, initCommon, initCopy, initFile, initFolder, initRemove, initUpdating, isConnected, isDrive, isDrive, isIgnored, isInDrive, isInTrash, isLocal, isNew, isNewOrUpdating, isSameDrive, isUpdating, listFiles, listFiles, listFiles, loadHistory, localChange, migrateName, moveFile, nextChangeId, openFile, openFolder, readFile, readNode, readNodes, removeJCRListener, removeUpdating, rollback, rollbackAllChanges, rollbackChanges, rootNode, rootNode, saveChanges, savedChanges, session, setChangeId, size, synchronize, systemSession, thumbnailLink, title, unignore

Methods inherited from class org.exoplatform.clouddrive.CloudDrive

addListener, removeListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LINK_EXPIRATION_PERIOD

public static final long DEFAULT_LINK_EXPIRATION_PERIOD

Time to expire for file links obtained from Dropbox without explicitly set expiration time.

See Also:

Constant Field Values

FOLDER_REV

public static final String FOLDER_REV

FOLDER_TYPE

public static final String FOLDER_TYPE

state

protected JCRLocalDropboxDrive.DropboxState state

Dropbox drive state. See getState().

moved

protected Map<String,JCRLocalDropboxDrive.MovedFile> moved

Moved files with expiration on each sync run.

Constructor Detail

JCRLocalDropboxDrive

protected JCRLocalDropboxDrive(DropboxUser user,
                    javax.jcr.Node driveNode,
                    org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                    org.exoplatform.clouddrive.jcr.NodeFinder finder,
                    org.exoplatform.clouddrive.utils.ExtendedMimeTypeResolver mimeTypes)
                        throws org.exoplatform.clouddrive.CloudDriveException,
                               javax.jcr.RepositoryException

Parameters:

user -

driveNode -

sessionProviders -

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

JCRLocalDropboxDrive

protected JCRLocalDropboxDrive(org.exoplatform.clouddrive.dropbox.DropboxConnector.API apiBuilder,
                    DropboxProvider provider,
                    javax.jcr.Node driveNode,
                    org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                    org.exoplatform.clouddrive.jcr.NodeFinder finder,
                    org.exoplatform.clouddrive.utils.ExtendedMimeTypeResolver mimeTypes)
                        throws javax.jcr.RepositoryException,
                               org.exoplatform.clouddrive.CloudDriveException

Throws:

javax.jcr.RepositoryException

org.exoplatform.clouddrive.CloudDriveException

Method Detail

initDrive

protected void initDrive(javax.jcr.Node driveNode)
                  throws org.exoplatform.clouddrive.CloudDriveException,
                         javax.jcr.RepositoryException

Overrides:

initDrive in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

updateState

protected void updateState(String cursor)

loadUser

protected static DropboxUser loadUser(org.exoplatform.clouddrive.dropbox.DropboxConnector.API apiBuilder,
                   DropboxProvider provider,
                   javax.jcr.Node driveNode)
                               throws javax.jcr.RepositoryException,
                                      DropboxException,
                                      org.exoplatform.clouddrive.CloudDriveException

Load user from the drive Node.

Parameters:

apiBuilder - DropboxConnector.API API builder

provider - DropboxProvider

driveNode - Node root of the drive

Returns:

DropboxUser

Throws:

javax.jcr.RepositoryException

DropboxException

org.exoplatform.clouddrive.CloudDriveException

onUserTokenRefresh

public void onUserTokenRefresh(org.exoplatform.clouddrive.oauth2.UserToken token)
                        throws org.exoplatform.clouddrive.CloudDriveException

Specified by:

onUserTokenRefresh in interface org.exoplatform.clouddrive.oauth2.UserTokenRefreshListener

Throws:

DropboxException

org.exoplatform.clouddrive.CloudDriveException

getFileContent

public org.exoplatform.clouddrive.viewer.ContentReader getFileContent(String idPath)
                                                               throws javax.jcr.RepositoryException,
                                                                      org.exoplatform.clouddrive.CloudDriveException

Specified by:

getFileContent in interface org.exoplatform.clouddrive.CloudDriveStorage

Overrides:

getFileContent in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

org.exoplatform.clouddrive.CloudDriveException

getState

public org.exoplatform.clouddrive.CloudDrive.FilesState getState()
                                                          throws org.exoplatform.clouddrive.DriveRemovedException,
                                                                 org.exoplatform.clouddrive.RefreshAccessException,
                                                                 org.exoplatform.clouddrive.CloudProviderException,
                                                                 javax.jcr.RepositoryException

Overrides:

getState in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.DriveRemovedException

org.exoplatform.clouddrive.RefreshAccessException

org.exoplatform.clouddrive.CloudProviderException

javax.jcr.RepositoryException

isSharingSupported

public boolean isSharingSupported()

Specified by:

isSharingSupported in interface org.exoplatform.clouddrive.CloudDriveSecurity

Overrides:

isSharingSupported in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

shareFile

public void shareFile(javax.jcr.Node fileNode,
             String... users)
               throws javax.jcr.RepositoryException,
                      org.exoplatform.clouddrive.CloudDriveException

Specified by:

shareFile in interface org.exoplatform.clouddrive.CloudDriveSecurity

Overrides:

shareFile in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

org.exoplatform.clouddrive.CloudDriveException

getConnectCommand

protected org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.ConnectCommand getConnectCommand()
                                                                                      throws org.exoplatform.clouddrive.DriveRemovedException,
                                                                                             javax.jcr.RepositoryException

Specified by:

getConnectCommand in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.DriveRemovedException

javax.jcr.RepositoryException

getSyncCommand

protected org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive.SyncCommand getSyncCommand()
                                                                                throws org.exoplatform.clouddrive.DriveRemovedException,
                                                                                       org.exoplatform.clouddrive.SyncNotSupportedException,
                                                                                       javax.jcr.RepositoryException

Specified by:

getSyncCommand in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.DriveRemovedException

org.exoplatform.clouddrive.SyncNotSupportedException

javax.jcr.RepositoryException

createFileAPI

protected org.exoplatform.clouddrive.CloudFileAPI createFileAPI()
                                                         throws org.exoplatform.clouddrive.DriveRemovedException,
                                                                org.exoplatform.clouddrive.SyncNotSupportedException,
                                                                javax.jcr.RepositoryException

Specified by:

createFileAPI in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.DriveRemovedException

org.exoplatform.clouddrive.SyncNotSupportedException

javax.jcr.RepositoryException

readChangeId

protected Long readChangeId()
                     throws javax.jcr.RepositoryException,
                            org.exoplatform.clouddrive.CloudDriveException

Specified by:

readChangeId in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

org.exoplatform.clouddrive.CloudDriveException

saveChangeId

protected void saveChangeId(Long id)
                     throws org.exoplatform.clouddrive.CloudDriveException,
                            javax.jcr.RepositoryException

Specified by:

saveChangeId in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

getUser

public DropboxUser getUser()

Specified by:

getUser in class org.exoplatform.clouddrive.CloudDrive

refreshAccess

protected void refreshAccess()
                      throws org.exoplatform.clouddrive.CloudDriveException

Specified by:

refreshAccess in class org.exoplatform.clouddrive.CloudDrive

Throws:

org.exoplatform.clouddrive.CloudDriveException

updateAccess

protected void updateAccess(org.exoplatform.clouddrive.CloudUser newUser)
                     throws org.exoplatform.clouddrive.CloudDriveException,
                            javax.jcr.RepositoryException

Specified by:

updateAccess in class org.exoplatform.clouddrive.CloudDrive

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

initCloudItem

@Deprecated
protected void initCloudItem(javax.jcr.Node localNode,
                            Object item)
                      throws javax.jcr.RepositoryException,
                             DropboxException

Deprecated.

Initialize cloud's common specifics of files and folders.

Parameters:

localNode - Node

item - Object

Throws:

javax.jcr.RepositoryException

DropboxException

initDropboxFile

protected void initDropboxFile(javax.jcr.Node localNode,
                   Boolean mightHaveThumbnail,
                   String iconName,
                   String rev,
                   Long size)
                        throws javax.jcr.RepositoryException,
                               DropboxException

Initialize Dropbox file.

Parameters:

localNode - Node

file - DbxEntry.File

Throws:

javax.jcr.RepositoryException

DropboxException

initDropboxFolder

protected void initDropboxFolder(javax.jcr.Node localNode,
                     Boolean mightHaveThumbnail,
                     String iconName,
                     String deltaHash)
                          throws javax.jcr.RepositoryException,
                                 DropboxException

Initialize Dropbox folder.

Parameters:

localNode - Node

mightHaveThumbnail - Boolean

iconName - String

deltaHash - String a hash of last Delta synchronization, if null it will be ignored

Throws:

javax.jcr.RepositoryException

DropboxException

initDropboxCommon

protected void initDropboxCommon(javax.jcr.Node localNode,
                     Boolean mightHaveThumbnail,
                     String iconName)
                          throws javax.jcr.RepositoryException,
                                 DropboxException

Initialize Dropbox entry (commons for file and folder).

Parameters:

localNode - Node

mightHaveThumbnail - Boolean

iconName - String

Throws:

javax.jcr.RepositoryException

DropboxException

updateItem

protected org.exoplatform.clouddrive.jcr.JCRLocalCloudFile updateItem(DropboxAPI api,
                                                          JCRLocalDropboxDrive.DbxFileInfo file,
                                                          com.dropbox.core.DbxEntry metadata,
                                                          javax.jcr.Node parent,
                                                          javax.jcr.Node node)
                                                               throws javax.jcr.RepositoryException,
                                                                      org.exoplatform.clouddrive.CloudDriveException

Update or create a local node of Cloud File. If the node is null then it will be open on the given parent and created if not already exists.

Parameters:

api - DropboxAPI

file - JCRLocalDropboxDrive.DbxFileInfo

metadata - DbxEntry

parent - Node

node - Node, can be null

Returns:

JCRLocalCloudFile

Throws:

javax.jcr.RepositoryException - for storage errors

org.exoplatform.clouddrive.CloudDriveException - for drive or format errors

createSharedLink

protected String createSharedLink(javax.jcr.Node fileNode)
                           throws javax.jcr.RepositoryException,
                                  org.exoplatform.clouddrive.CloudDriveException

Throws:

javax.jcr.RepositoryException

org.exoplatform.clouddrive.CloudDriveException

link

protected String link(javax.jcr.Node fileNode)
               throws javax.jcr.RepositoryException

Overrides:

link in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

previewLink

protected String previewLink(javax.jcr.Node fileNode)
                      throws javax.jcr.RepositoryException

Overrides:

previewLink in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

notInRange

protected boolean notInRange(String path,
                 Collection<String> range)

idPath

protected String idPath(String dbxPath)

Return Dropbox path in guaranteed lower case.

Parameters:

dbxPath - String Dropbox file path

Returns:

String path in lower-case

findMimetype

protected String findMimetype(String fileName)

restoreSubtree

protected com.dropbox.core.DbxEntry restoreSubtree(DropboxAPI api,
                                       String idPath,
                                       javax.jcr.Node node)
                                            throws org.exoplatform.clouddrive.CloudDriveException,
                                                   javax.jcr.RepositoryException

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

fetchSubtree

protected com.dropbox.core.DbxEntry fetchSubtree(DropboxAPI api,
                                     String idPath,
                                     javax.jcr.Node node,
                                     boolean useHash,
                                     Collection<org.exoplatform.clouddrive.utils.ChunkIterator<?>> iterators,
                                     Collection<org.exoplatform.clouddrive.CloudFile> fetched)
                                          throws org.exoplatform.clouddrive.CloudDriveException,
                                                 javax.jcr.RepositoryException

Throws:

org.exoplatform.clouddrive.CloudDriveException

javax.jcr.RepositoryException

folderHash

protected String folderHash(javax.jcr.Node node)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

cleanExpiredMoved

protected void cleanExpiredMoved()

nodeName

protected String nodeName(String title)

Overrides:

nodeName in class org.exoplatform.clouddrive.jcr.JCRLocalCloudDrive

normalizeName

protected javax.jcr.Node normalizeName(javax.jcr.Node fileNode)
                                throws javax.jcr.RepositoryException

Ensure the cloud file node has name in lower-case. If name requires change it will be renamed immediately and don't need saving it.
NOTE: this method doesn't check if it is a cloud file and doesn't respect JCR namespaces and will check against the whole name of the file.

Parameters:

fileNode - Node

Returns:

Node the same as given or renamed to lower-case name.

Throws:

javax.jcr.RepositoryException