org.nuxeo.drive.service.impl

Class DefaultFileSystemItemFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

org.nuxeo.drive.service.impl.DefaultFileSystemItemFactory

All Implemented Interfaces:

FileSystemItemFactory, VersioningFileSystemItemFactory

public class DefaultFileSystemItemFactory
extends AbstractFileSystemItemFactory
implements VersioningFileSystemItemFactory

Default implementation of a FileSystemItemFactory. It is DocumentModel backed and is the one used by Nuxeo Drive.

Author:

Antoine Taillefer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	VERSIONING_DELAY_PARAM
protected static String	VERSIONING_OPTION_PARAM
protected double	versioningDelay
protected VersioningOption	versioningOption

Fields inherited from class org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

name

Constructor Summary

Constructors

Constructor and Description
DefaultFileSystemItemFactory()

Method Summary

Modifier and Type	Method and Description
protected FileSystemItem	adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean relaxSyncRootConstraint, boolean getLockInfo) Adapts the given DocumentModel to a FileSystemItem.
double	getVersioningDelay() Gets the delay passed which a document needs to be versioned since its last modification.
VersioningOption	getVersioningOption() Gets the increment option used when versioning a document.
void	handleParameters(Map<String,String> parameters) Handles the factory parameters contributed through the fileSystemItemFactory contribution.
protected boolean	hasBlob(DocumentModel doc)
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) The default factory considers that a DocumentModel is adaptable as a FileSystemItem if: It is not a version AND it is not HiddenInNavigation AND it is not in the "deleted" life cycle state, unless includeDeleted is true AND it is Folderish or it can be adapted as a BlobHolder with a blob AND it is not a synchronization root registered for the current user, unless relaxSyncRootConstraint is true
boolean	needsVersioning(DocumentModel doc) Need to version the doc if the current contributor is different from the last contributor or if the last modification was done more than versioningDelay seconds ago.
void	setVersioningDelay(double versioningDelay) Sets the delay passed which a document needs to be versioned since its last modification.
void	setVersioningOption(VersioningOption versioningOption) Sets the increment option used when versioning a document.

Methods inherited from class org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

adaptDocument, canHandleFileSystemItemId, exists, getDocumentByFileSystemId, getDocumentById, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItemById, getFileSystemItemById, getName, isFileSystemItem, isFileSystemItem, parseFileSystemId, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.drive.service.FileSystemItemFactory

canHandleFileSystemItemId, exists, getDocumentByFileSystemId, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItemById, getFileSystemItemById, getName, isFileSystemItem, isFileSystemItem, setName

Field Detail

VERSIONING_DELAY_PARAM

protected static final String VERSIONING_DELAY_PARAM

See Also:

Constant Field Values

VERSIONING_OPTION_PARAM

protected static final String VERSIONING_OPTION_PARAM

See Also:

Constant Field Values

versioningDelay

protected double versioningDelay

versioningOption

protected VersioningOption versioningOption

Constructor Detail

DefaultFileSystemItemFactory

public DefaultFileSystemItemFactory()

Method Detail

handleParameters

public void handleParameters(Map<String,String> parameters)

Description copied from interface: FileSystemItemFactory

Handles the factory parameters contributed through the fileSystemItemFactory contribution.

Specified by:

handleParameters in interface FileSystemItemFactory

Specified by:

handleParameters in class AbstractFileSystemItemFactory

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc,
                                boolean includeDeleted,
                                boolean relaxSyncRootConstraint)

The default factory considers that a DocumentModel is adaptable as a FileSystemItem if:

• It is not a version
• AND it is not HiddenInNavigation
• AND it is not in the "deleted" life cycle state, unless includeDeleted is true
• AND it is Folderish or it can be adapted as a BlobHolder with a blob
• AND it is not a synchronization root registered for the current user, unless relaxSyncRootConstraint is true

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Specified by:

isFileSystemItem in class AbstractFileSystemItemFactory

adaptDocument

protected FileSystemItem adaptDocument(DocumentModel doc,
                                       boolean forceParentItem,
                                       FolderItem parentItem,
                                       boolean relaxSyncRootConstraint,
                                       boolean getLockInfo)

Description copied from class: AbstractFileSystemItemFactory

Adapts the given DocumentModel to a FileSystemItem.

Specified by:

adaptDocument in class AbstractFileSystemItemFactory

See Also:

AbstractFileSystemItemFactory.getFileSystemItem(DocumentModel, boolean, FolderItem, boolean, boolean, boolean)

needsVersioning

public boolean needsVersioning(DocumentModel doc)

Need to version the doc if the current contributor is different from the last contributor or if the last modification was done more than versioningDelay seconds ago.

Specified by:

needsVersioning in interface VersioningFileSystemItemFactory

See Also:

DocumentBackedFileItem#versionIfNeeded(DocumentModel doc, CoreSession session)

getVersioningDelay

public double getVersioningDelay()

Description copied from interface: VersioningFileSystemItemFactory

Gets the delay passed which a document needs to be versioned since its last modification.

Specified by:

getVersioningDelay in interface VersioningFileSystemItemFactory

See Also:

needsVersioning(DocumentModel)

setVersioningDelay

public void setVersioningDelay(double versioningDelay)

Description copied from interface: VersioningFileSystemItemFactory

Sets the delay passed which a document needs to be versioned since its last modification.

Specified by:

setVersioningDelay in interface VersioningFileSystemItemFactory

getVersioningOption

public VersioningOption getVersioningOption()

Description copied from interface: VersioningFileSystemItemFactory

Gets the increment option used when versioning a document.

Specified by:

getVersioningOption in interface VersioningFileSystemItemFactory

See Also:

DocumentBackedFileItem#versionIfNeeded(DocumentModel doc, CoreSession session)

setVersioningOption

public void setVersioningOption(VersioningOption versioningOption)

Description copied from interface: VersioningFileSystemItemFactory

Sets the increment option used when versioning a document.

Specified by:

setVersioningOption in interface VersioningFileSystemItemFactory

hasBlob

protected boolean hasBlob(DocumentModel doc)