org.nuxeo.drive.adapter.impl

Class CollectionSyncRootFolderItem

java.lang.Object

org.nuxeo.drive.adapter.impl.AbstractFileSystemItem

org.nuxeo.drive.adapter.impl.AbstractDocumentBackedFileSystemItem

org.nuxeo.drive.adapter.impl.DocumentBackedFolderItem

org.nuxeo.drive.adapter.impl.DefaultSyncRootFolderItem

org.nuxeo.drive.adapter.impl.CollectionSyncRootFolderItem

All Implemented Interfaces:

Comparable<FileSystemItem>, FileSystemItem, FolderItem

public class CollectionSyncRootFolderItem
extends DefaultSyncRootFolderItem

Default implementation of a collection synchronization root FolderItem.

Since:

6.0

Author:

Antoine Taillefer

Field Summary

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

canCreateChild, canScrollDescendants, DESCENDANTS_SCROLL_CACHE, MAX_DESCENDANTS_BATCH_SIZE_DEFAULT, MAX_DESCENDANTS_BATCH_SIZE_PROPERTY, VCS_CHUNK_SIZE

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

docId, docPath, docTitle, PERMISSION_CHECK_OPTIMIZED_PROPERTY, repositoryName

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionSyncRootFolderItem()
	CollectionSyncRootFolderItem(String factoryName, FolderItem parentItem, DocumentModel doc)
	CollectionSyncRootFolderItem(String factoryName, FolderItem parentItem, DocumentModel doc, boolean relaxSyncRootConstraint)
	CollectionSyncRootFolderItem(String factoryName, FolderItem parentItem, DocumentModel doc, boolean relaxSyncRootConstraint, boolean getLockInfo)

Method Summary

Modifier and Type	Method and Description
FileItem	createFile(Blob blob, boolean overwrite)
FolderItem	createFolder(String name, boolean overwrite)
List<FileSystemItem>	getChildren()
protected void	initialize(DocumentModel doc)
ScrollFileSystemItemList	scrollDescendants(String scrollId, int batchSize, long keepAlive) Retrieves at most batchSize FileSystemItem descendants for the given scrollId.

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

canMove, delete, move

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

adaptDocuments, checkBatchSize, doScrollDescendants, equals, fetchFromVCS, fetchFromVcsChunk, getBatch, getCanCreateChild, getCanScrollDescendants, getFileManager, getFolderItem, getScrollBatch, hashCode, populateAncestorCache, rename, setCanCreateChild, setCanScrollDescendants

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

computeId, getDocId, getDocPath, getDocument, getDocumentById, getRepositoryName, getTrashService, handleCollectionMember, parseFileSystemId, setId, updateLastModificationDate

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

compareTo, getCanDelete, getCanRename, getCreationDate, getCreator, getFileSystemItemAdapterService, getId, getLastContributor, getLastModificationDate, getLockInfo, getName, getParentId, getPath, getUserName, isFolder, setCanDelete, setCanRename, setCreationDate, setCreator, setFolder, 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

Constructor Detail

CollectionSyncRootFolderItem

public CollectionSyncRootFolderItem(String factoryName,
                                    FolderItem parentItem,
                                    DocumentModel doc)

CollectionSyncRootFolderItem

public CollectionSyncRootFolderItem(String factoryName,
                                    FolderItem parentItem,
                                    DocumentModel doc,
                                    boolean relaxSyncRootConstraint)

CollectionSyncRootFolderItem

public CollectionSyncRootFolderItem(String factoryName,
                                    FolderItem parentItem,
                                    DocumentModel doc,
                                    boolean relaxSyncRootConstraint,
                                    boolean getLockInfo)

CollectionSyncRootFolderItem

protected CollectionSyncRootFolderItem()

Method Detail

getChildren

public List<FileSystemItem> getChildren()

Specified by:

getChildren in interface FolderItem

Overrides:

getChildren in class DocumentBackedFolderItem

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

Overrides:

scrollDescendants in class DocumentBackedFolderItem

createFolder

public FolderItem createFolder(String name,
                               boolean overwrite)

Specified by:

createFolder in interface FolderItem

Overrides:

createFolder in class DocumentBackedFolderItem

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

Overrides:

createFile in class DocumentBackedFolderItem

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

initialize

protected final void initialize(DocumentModel doc)

Overrides:

initialize in class DocumentBackedFolderItem