org.nuxeo.drive.hierarchy.permission.factory

Class UserSyncRootParentFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

org.nuxeo.drive.hierarchy.permission.factory.UserSyncRootParentFactory

All Implemented Interfaces:

FileSystemItemFactory, VirtualFolderItemFactory

public class UserSyncRootParentFactory
extends AbstractFileSystemItemFactory
implements VirtualFolderItemFactory

User workspace based implementation of FileSystemItemFactory for the parent FolderItem of the user's synchronization roots.

Author:

Antoine Taillefer

Constructor Summary

Constructors

Constructor and Description
UserSyncRootParentFactory()

Method Summary

Methods

Modifier and Type	Method and Description
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Force parent item using getTopLevelFolderItem(Principal).
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel.
String	getFolderName()
FolderItem	getVirtualFolderItem(Principal principal) Returns the (unique) virtual FolderItem.
void	handleParameters(Map<String,String> parameters) Handles the factory parameters contributed through the fileSystemItemFactory contribution.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
void	setFolderName(String folderName)

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

UserSyncRootParentFactory

public UserSyncRootParentFactory()

Method Detail

handleParameters

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

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

Throws:

ClientException

isFileSystemItem

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

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem.

If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns false.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Specified by:

isFileSystemItem in class AbstractFileSystemItemFactory

Throws:

ClientException

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted)
                                 throws ClientException

Force parent item using getTopLevelFolderItem(Principal).

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean))

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted,
                               boolean relaxSyncRootConstraint)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean, boolean))

getVirtualFolderItem

public FolderItem getVirtualFolderItem(Principal principal)
                                throws ClientException

Description copied from interface: VirtualFolderItemFactory

Returns the (unique) virtual FolderItem.

Specified by:

getVirtualFolderItem in interface VirtualFolderItemFactory

Throws:

ClientException

getFolderName

public String getFolderName()

Specified by:

getFolderName in interface VirtualFolderItemFactory

setFolderName

public void setFolderName(String folderName)

Specified by:

setFolderName in interface VirtualFolderItemFactory