org.nuxeo.drive.adapter.impl

Class AbstractVirtualFolderItem

java.lang.Object

org.nuxeo.drive.adapter.impl.AbstractFileSystemItem

org.nuxeo.drive.adapter.impl.AbstractVirtualFolderItem

All Implemented Interfaces:

Serializable, Comparable<FileSystemItem>, FileSystemItem, FolderItem

Direct Known Subclasses:

DefaultTopLevelFolderItem, PermissionTopLevelFolderItem, SharedSyncRootParentFolderItem, UserWorkspaceSyncRootParentFolderItem

public abstract class AbstractVirtualFolderItem
extends AbstractFileSystemItem
implements FolderItem

Base implementation of a virtual FolderItem.

Author:

Antoine Taillefer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canCreateChild
protected boolean	canScrollDescendants

Fields inherited from class org.nuxeo.drive.adapter.impl.AbstractFileSystemItem

canDelete, canRename, creationDate, creator, factoryName, FILE_SYSTEM_ITEM_ID_SEPARATOR, folder, id, lastContributor, lastModificationDate, lockInfo, name, parentId, path, principal, userName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVirtualFolderItem()
	AbstractVirtualFolderItem(String factoryName, Principal principal, String parentId, String parentPath, String folderName)

Method Summary

Modifier and Type	Method and Description
boolean	canMove(FolderItem dest)
FileItem	createFile(Blob blob, boolean overwrite)
FolderItem	createFolder(String name, boolean overwrite)
void	delete()
boolean	getCanCreateChild()
boolean	getCanScrollDescendants() Returns true if the FolderItem.scrollDescendants(String, int, long) API can be used.
abstract List<FileSystemItem>	getChildren()
FileSystemItem	move(FolderItem dest)
void	rename(String name)
ScrollFileSystemItemList	scrollDescendants(String scrollId, int batchSize, long keepAlive) Retrieves at most batchSize FileSystemItem descendants for the given scrollId.
protected void	setCanCreateChild(boolean canCreateChild)
protected void	setCanScrollDescendants(boolean canScrollDescendants)

Methods inherited from class org.nuxeo.drive.adapter.impl.AbstractFileSystemItem

compareTo, equals, getCanDelete, getCanRename, getCreationDate, getCreator, getFileSystemItemAdapterService, getId, getLastContributor, getLastModificationDate, getLockInfo, getName, getParentId, getPath, getUserName, hashCode, isFolder, setCanDelete, setCanRename, setCreationDate, setCreator, setFolder, setId, setLastContributor, setLastModificationDate, setLockInfo, setName, setParentId, setPath, setUserName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.drive.adapter.FolderItem

createFile, createFolder

Methods inherited from interface org.nuxeo.drive.adapter.FileSystemItem

getCanDelete, getCanRename, getCreationDate, getCreator, getId, getLastContributor, getLastModificationDate, getLockInfo, getName, getParentId, getPath, isFolder

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

canCreateChild

protected boolean canCreateChild

canScrollDescendants

protected boolean canScrollDescendants

Constructor Detail

AbstractVirtualFolderItem

public AbstractVirtualFolderItem(String factoryName,
                                 Principal principal,
                                 String parentId,
                                 String parentPath,
                                 String folderName)

AbstractVirtualFolderItem

protected AbstractVirtualFolderItem()

Method Detail

getChildren

public abstract List<FileSystemItem> getChildren()

Specified by:

getChildren in interface FolderItem

rename

public void rename(String name)

Specified by:

rename in interface FileSystemItem

Specified by:

rename in class AbstractFileSystemItem

delete

public void delete()

Specified by:

delete in interface FileSystemItem

Specified by:

delete in class AbstractFileSystemItem

canMove

public boolean canMove(FolderItem dest)

Specified by:

canMove in interface FileSystemItem

Specified by:

canMove in class AbstractFileSystemItem

move

public FileSystemItem move(FolderItem dest)

Specified by:

move in interface FileSystemItem

Specified by:

move in class AbstractFileSystemItem

getCanScrollDescendants

public boolean getCanScrollDescendants()

Description copied from interface: FolderItem

Returns true if the FolderItem.scrollDescendants(String, int, long) API can be used.

Specified by:

getCanScrollDescendants in interface FolderItem

scrollDescendants

public ScrollFileSystemItemList scrollDescendants(String scrollId,
                                                  int batchSize,
                                                  long keepAlive)

Description copied from interface: FolderItem

Retrieves at most batchSize FileSystemItem descendants for the given scrollId.

When passing a null scrollId the initial search request is executed and the first batch of results is returned along with a scrollId which should be passed to the next call in order to retrieve the next batch of results.

Ideally, the search context made available by the initial search request is kept alive during keepAlive milliseconds if keepAlive is positive.

Results are not necessarily sorted.

This method is protected by a Semaphore, made available by FileSystemItemAdapterService.getScrollBatchSemaphore(), to limit the number of concurrent executions and avoid too much memory pressure.

Specified by:

scrollDescendants in interface FolderItem

getCanCreateChild

public boolean getCanCreateChild()

Specified by:

getCanCreateChild in interface FolderItem

createFolder

public FolderItem createFolder(String name,
                               boolean overwrite)

Specified by:

createFolder in interface FolderItem

overwrite - allows to overwrite an existing folder with the same title

createFile

public FileItem createFile(Blob blob,
                           boolean overwrite)

Specified by:

createFile in interface FolderItem

overwrite - allows to overwrite an existing file with the same title

setCanCreateChild

protected void setCanCreateChild(boolean canCreateChild)

setCanScrollDescendants

protected void setCanScrollDescendants(boolean canScrollDescendants)