Package org.nuxeo.drive.hierarchy.permission.factory

Class PermissionSyncRootFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

org.nuxeo.drive.service.impl.AbstractSyncRootFolderItemFactory

org.nuxeo.drive.hierarchy.permission.factory.PermissionSyncRootFactory

All Implemented Interfaces:

FileSystemItemFactory

public class PermissionSyncRootFactory
extends AbstractSyncRootFolderItemFactory

Permission based implementation of FileSystemItemFactory for a synchronization root FolderItem.

Author:

Antoine Taillefer

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	REQUIRED_PERMISSION_PARAM
protected String	requiredPermission
protected static final String	SHARED_SYNC_ROOT_PARENT_FACTORY_PARAM
protected String	sharedSyncRootParentFactoryName
protected static final String	USER_SYNC_ROOT_PARENT_FACTORY_PARAM
protected String	userSyncRootParentFactoryName

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

name

Constructor Summary

Constructors

Constructor	Description
PermissionSyncRootFactory()

Method Summary

Modifier and Type	Method	Description
protected FileSystemItem	adaptDocument(DocumentModel doc, boolean forceParentId, FolderItem parentItem, boolean relaxSyncRootConstraint, boolean getLockInfo)	Adapts the given DocumentModel to a FileSystemItem.
protected FileSystemItemAdapterService	getFileSystemAdapterService()
protected FolderItem	getParentItem(DocumentModel doc)	Returns the parent FileSystemItem.
void	handleParameters(Map<String,String> parameters)	No parameters by default.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint)	Checks if the given DocumentModel is adaptable as a FileSystemItem.

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

getFileSystemItem, getFileSystemItem, getFileSystemItem

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

adaptDocument, canHandleFileSystemItemId, exists, getDocumentById, 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

Field Details

REQUIRED_PERMISSION_PARAM

protected static final String REQUIRED_PERMISSION_PARAM

See Also:

• Constant Field Values

USER_SYNC_ROOT_PARENT_FACTORY_PARAM

protected static final String USER_SYNC_ROOT_PARENT_FACTORY_PARAM

See Also:

• Constant Field Values

SHARED_SYNC_ROOT_PARENT_FACTORY_PARAM

protected static final String SHARED_SYNC_ROOT_PARENT_FACTORY_PARAM

See Also:

• Constant Field Values

requiredPermission

protected String requiredPermission

userSyncRootParentFactoryName

protected String userSyncRootParentFactoryName

sharedSyncRootParentFactoryName

protected String sharedSyncRootParentFactoryName

Constructor Details

PermissionSyncRootFactory

public PermissionSyncRootFactory()

Method Details

handleParameters

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

Description copied from class: AbstractSyncRootFolderItemFactory

No parameters by default.

Specified by:

handleParameters in interface FileSystemItemFactory

Overrides:

handleParameters in class AbstractSyncRootFolderItemFactory

isFileSystemItem

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

Checks if the given DocumentModel is adaptable as a FileSystemItem. The permission synchronization root factory considers that a DocumentModel is adaptable as a FileSystemItem if:

• It is Folderish
• AND it is not a version nor a proxy
• AND it is not HiddenInNavigation
• AND it is not in the trash, unless includeDeleted is true
• AND it is a synchronization root registered for the current user, unless relaxSyncRootConstraint is true
• AND the current user has the requiredPermission permission on the document

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Overrides:

isFileSystemItem in class AbstractSyncRootFolderItemFactory

adaptDocument

protected FileSystemItem adaptDocument(DocumentModel doc,
 boolean forceParentId,
 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)

getParentItem

protected FolderItem getParentItem(DocumentModel doc)

Description copied from class: AbstractSyncRootFolderItemFactory

Returns the parent FileSystemItem.

Specified by:

getParentItem in class AbstractSyncRootFolderItemFactory

getFileSystemAdapterService

protected FileSystemItemAdapterService getFileSystemAdapterService()