Package org.exoplatform.clouddrive.box

Class JCRLocalBoxDrive

java.lang.Object

org.exoplatform.services.cms.clouddrives.CloudDrive

org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

org.exoplatform.clouddrive.box.JCRLocalBoxDrive

All Implemented Interfaces:

org.exoplatform.services.cms.clouddrives.CloudDriveSecurity, org.exoplatform.services.cms.clouddrives.CloudDriveStorage, org.exoplatform.services.cms.clouddrives.oauth2.UserTokenRefreshListener

public class JCRLocalBoxDrive
extends org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive
implements org.exoplatform.services.cms.clouddrives.oauth2.UserTokenRefreshListener

Local drive for Box. Created by The eXo Platform SAS.

Version:

$Id: JCRLocalBoxDrive.java 00000 Aug 30, 2013 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JCRLocalBoxDrive.BoxState	The Class BoxState.
protected class	JCRLocalBoxDrive.Connect	Connect algorithm for Box drive.
protected class	JCRLocalBoxDrive.EventsSync	Sync algorithm for Box drive based on drive changes obtained from Events service http://developers.box.com/docs/#events.
protected class	JCRLocalBoxDrive.FileAPI	The Class FileAPI.
protected class	JCRLocalBoxDrive.FullSync	Sync algorithm for Box drive based on all remote files traversing: we do compare all remote files with locals by its Etag and fetch an item if the tags differ.

Nested classes/interfaces inherited from class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

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

Nested classes/interfaces inherited from class org.exoplatform.services.cms.clouddrives.CloudDrive

org.exoplatform.services.cms.clouddrives.CloudDrive.Command, org.exoplatform.services.cms.clouddrives.CloudDrive.CommandProgress, org.exoplatform.services.cms.clouddrives.CloudDrive.FilesState, org.exoplatform.services.cms.clouddrives.CloudDrive.ListenerSupport

Nested classes/interfaces inherited from interface org.exoplatform.services.cms.clouddrives.CloudDriveStorage

org.exoplatform.services.cms.clouddrives.CloudDriveStorage.Change<R extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static long	FULL_SYNC_PERIOD	Period to perform JCRLocalBoxDrive.FullSync as a next sync request.

Fields inherited from class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

accentsConverter, actionDrive, ALREADY_DONE, COMMAND_CHANGES_CHUNK, commandEnv, CURRENT_LOCALFORMAT, currentChangeId, currentConnect, currentSync, delayedSyncFiles, 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, MIX_VERSIONABLE, noConnect, noSync, NT_FILE, NT_FOLDER, NT_RESOURCE, NT_UNSTRUCTURED, repository, rootNodeHolder, rootSystemNodeHolder, rootUUID, rootWorkspace, sessionProviders, state, syncFilesMessages, syncLock, updating, user, USER_NODEPATH, USER_SESSIONPROVIDER, USER_WORKSPACE, workerExecutor

Fields inherited from class org.exoplatform.services.cms.clouddrives.CloudDrive

listeners, LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JCRLocalBoxDrive(org.exoplatform.clouddrive.box.BoxConnector.API apiBuilder, BoxProvider provider, javax.jcr.Node driveNode, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.cms.clouddrives.jcr.NodeFinder finder, org.exoplatform.services.cms.clouddrives.utils.ExtendedMimeTypeResolver mimeTypes)	Instantiates a new JCR local box drive.
protected	JCRLocalBoxDrive(BoxUser user, javax.jcr.Node driveNode, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.cms.clouddrives.jcr.NodeFinder finder, org.exoplatform.services.cms.clouddrives.utils.ExtendedMimeTypeResolver mimeTypes)	Instantiates a new JCR local box drive.

Method Summary

Modifier and Type	Method	Description
protected org.exoplatform.services.cms.clouddrives.CloudFileAPI	createFileAPI()
protected String	findMimetype(String fileName)	Find mimetype.
protected org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive.ConnectCommand	getConnectCommand()
protected Long	getSequenceId(com.box.sdk.BoxItem.Info item)	Gets the sequence id.
JCRLocalBoxDrive.BoxState	getState()
protected org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive.SyncCommand	getSyncCommand()
BoxUser	getUser()
protected boolean	initBoxItem(javax.jcr.Node localNode, com.box.sdk.BoxItem.Info item)	Initialize Box's common specifics of files and folders.
protected void	initDrive(javax.jcr.Node driveNode)
protected static BoxUser	loadUser(org.exoplatform.clouddrive.box.BoxConnector.API apiBuilder, BoxProvider provider, javax.jcr.Node driveNode)	Load user from the drive Node.
protected boolean	notInRange(String path, Collection<String> range)	Not in range.
void	onUserTokenRefresh(org.exoplatform.services.cms.clouddrives.oauth2.UserToken token)
void	onUserTokenRemove()
protected String	previewLink(String type, javax.jcr.Node fileNode)
protected Long	readChangeId()
protected void	refreshAccess()
protected void	saveChangeId(Long id)
protected void	updateAccess(org.exoplatform.services.cms.clouddrives.CloudUser newUser)
protected org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudFile	updateItem(BoxAPI api, com.box.sdk.BoxItem.Info item, javax.jcr.Node parent, javax.jcr.Node node)	Update or create a local node of Cloud File.

Methods inherited from class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

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

Methods inherited from class org.exoplatform.services.cms.clouddrives.CloudDrive

addListener, initCreated, removeListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

FULL_SYNC_PERIOD

public static final long FULL_SYNC_PERIOD

Period to perform JCRLocalBoxDrive.FullSync as a next sync request. See implementation of getSyncCommand().

See Also:

Constant Field Values

Constructor Detail

JCRLocalBoxDrive

protected JCRLocalBoxDrive(BoxUser user,
                           javax.jcr.Node driveNode,
                           org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                           org.exoplatform.services.cms.clouddrives.jcr.NodeFinder finder,
                           org.exoplatform.services.cms.clouddrives.utils.ExtendedMimeTypeResolver mimeTypes)
                    throws org.exoplatform.services.cms.clouddrives.CloudDriveException,
                           javax.jcr.RepositoryException

Instantiates a new JCR local box drive.

Parameters:

user - the user

driveNode - the drive node

sessionProviders - the session providers

finder - the finder

mimeTypes - the mime types

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException - the cloud drive exception

javax.jcr.RepositoryException - the repository exception

JCRLocalBoxDrive

protected JCRLocalBoxDrive(org.exoplatform.clouddrive.box.BoxConnector.API apiBuilder,
                           BoxProvider provider,
                           javax.jcr.Node driveNode,
                           org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                           org.exoplatform.services.cms.clouddrives.jcr.NodeFinder finder,
                           org.exoplatform.services.cms.clouddrives.utils.ExtendedMimeTypeResolver mimeTypes)
                    throws javax.jcr.RepositoryException,
                           org.exoplatform.services.cms.clouddrives.CloudDriveException

Instantiates a new JCR local box drive.

Parameters:

apiBuilder - the api builder

provider - the provider

driveNode - the drive node

sessionProviders - the session providers

finder - the finder

mimeTypes - the mime types

Throws:

javax.jcr.RepositoryException - the repository exception

org.exoplatform.services.cms.clouddrives.CloudDriveException - the cloud drive exception

Method Detail

initDrive

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

Overrides:

initDrive in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

javax.jcr.RepositoryException

loadUser

protected static BoxUser loadUser(org.exoplatform.clouddrive.box.BoxConnector.API apiBuilder,
                                  BoxProvider provider,
                                  javax.jcr.Node driveNode)
                           throws javax.jcr.RepositoryException,
                                  BoxException,
                                  org.exoplatform.services.cms.clouddrives.CloudDriveException

Load user from the drive Node.

Parameters:

apiBuilder - BoxConnector.API API builder

provider - BoxProvider

driveNode - Node root of the drive

Returns:

BoxUser

Throws:

javax.jcr.RepositoryException - the repository exception

BoxException - the box exception

org.exoplatform.services.cms.clouddrives.CloudDriveException - the cloud drive exception

onUserTokenRefresh

public void onUserTokenRefresh(org.exoplatform.services.cms.clouddrives.oauth2.UserToken token)
                        throws org.exoplatform.services.cms.clouddrives.CloudDriveException

Specified by:

onUserTokenRefresh in interface org.exoplatform.services.cms.clouddrives.oauth2.UserTokenRefreshListener

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

onUserTokenRemove

public void onUserTokenRemove()
                       throws org.exoplatform.services.cms.clouddrives.CloudDriveException

Specified by:

onUserTokenRemove in interface org.exoplatform.services.cms.clouddrives.oauth2.UserTokenRefreshListener

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

getConnectCommand

protected org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive.ConnectCommand getConnectCommand()
                                                                                                    throws org.exoplatform.services.cms.clouddrives.DriveRemovedException,
                                                                                                           javax.jcr.RepositoryException

Specified by:

getConnectCommand in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.DriveRemovedException

javax.jcr.RepositoryException

getSyncCommand

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

Specified by:

getSyncCommand in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.DriveRemovedException

org.exoplatform.services.cms.clouddrives.SyncNotSupportedException

javax.jcr.RepositoryException

createFileAPI

protected org.exoplatform.services.cms.clouddrives.CloudFileAPI createFileAPI()
                                                                       throws org.exoplatform.services.cms.clouddrives.DriveRemovedException,
                                                                              org.exoplatform.services.cms.clouddrives.SyncNotSupportedException,
                                                                              javax.jcr.RepositoryException

Specified by:

createFileAPI in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.DriveRemovedException

org.exoplatform.services.cms.clouddrives.SyncNotSupportedException

javax.jcr.RepositoryException

readChangeId

protected Long readChangeId()
                     throws javax.jcr.RepositoryException,
                            org.exoplatform.services.cms.clouddrives.CloudDriveException

Specified by:

readChangeId in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException

org.exoplatform.services.cms.clouddrives.CloudDriveException

saveChangeId

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

Specified by:

saveChangeId in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

javax.jcr.RepositoryException

getUser

public BoxUser getUser()

Specified by:

getUser in class org.exoplatform.services.cms.clouddrives.CloudDrive

getState

public JCRLocalBoxDrive.BoxState getState()
                                   throws org.exoplatform.services.cms.clouddrives.DriveRemovedException,
                                          org.exoplatform.services.cms.clouddrives.CloudProviderException,
                                          javax.jcr.RepositoryException,
                                          org.exoplatform.services.cms.clouddrives.RefreshAccessException

Overrides:

getState in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.DriveRemovedException

org.exoplatform.services.cms.clouddrives.CloudProviderException

javax.jcr.RepositoryException

org.exoplatform.services.cms.clouddrives.RefreshAccessException

refreshAccess

protected void refreshAccess()
                      throws org.exoplatform.services.cms.clouddrives.CloudDriveException

Specified by:

refreshAccess in class org.exoplatform.services.cms.clouddrives.CloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

updateAccess

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

Specified by:

updateAccess in class org.exoplatform.services.cms.clouddrives.CloudDrive

Throws:

org.exoplatform.services.cms.clouddrives.CloudDriveException

javax.jcr.RepositoryException

initBoxItem

protected boolean initBoxItem(javax.jcr.Node localNode,
                              com.box.sdk.BoxItem.Info item)
                       throws javax.jcr.RepositoryException,
                              BoxException

Initialize Box's common specifics of files and folders.

Parameters:

localNode - Node

item - BoxItem.Info

Returns:

boolean true if Box file was changed comparing to previous state, false

Throws:

javax.jcr.RepositoryException - the repository exception

BoxException - the box exception

findMimetype

protected String findMimetype(String fileName)

Find mimetype.

Parameters:

fileName - the file name

Returns:

the string

updateItem

protected org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudFile updateItem(BoxAPI api,
                                                                                    com.box.sdk.BoxItem.Info item,
                                                                                    javax.jcr.Node parent,
                                                                                    javax.jcr.Node node)
                                                                             throws javax.jcr.RepositoryException,
                                                                                    org.exoplatform.services.cms.clouddrives.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 - BoxAPI

item - BoxItem.Info

parent - Node

node - Node, can be null

Returns:

JCRLocalCloudFile

Throws:

javax.jcr.RepositoryException - for storage errors

org.exoplatform.services.cms.clouddrives.CloudDriveException - for drive or format errors

notInRange

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

Not in range.

Parameters:

path - the path

range - the range

Returns:

true, if successful

getSequenceId

protected Long getSequenceId(com.box.sdk.BoxItem.Info item)
                      throws BoxFormatException

Gets the sequence id.

Parameters:

item - the item

Returns:

the sequence id

Throws:

BoxFormatException - the box format exception

previewLink

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

Overrides:

previewLink in class org.exoplatform.services.cms.clouddrives.jcr.JCRLocalCloudDrive

Throws:

javax.jcr.RepositoryException