org.nuxeo.drive.service

Interface FileSystemItemFactory

All Known Subinterfaces:

TopLevelFolderItemFactory, VersioningFileSystemItemFactory, VirtualFolderItemFactory

All Known Implementing Classes:

AbstractFileSystemItemFactory, AbstractSyncRootFolderItemFactory, AbstractVirtualFolderItemFactory, CollectionSyncRootFolderItemFactory, DefaultFileSystemItemFactory, DefaultSyncRootFolderItemFactory, DefaultTopLevelFolderItemFactory, PermissionSyncRootFactory, PermissionTopLevelFactory, SharedSyncRootParentFactory, UserSyncRootParentFactory, UserWorkspaceSyncRootFactory, UserWorkspaceSyncRootParentFactory, UserWorkspaceTopLevelFactory

public interface FileSystemItemFactory

Interface for the classes contributed to the fileSystemItemFactory extension point of the FileSystemItemAdapterService.

Allows to get a FileSystemItem for a given DocumentModel or a given FileSystemItem id.

Author:

Antoine Taillefer

See Also:

AbstractFileSystemItemFactory, DefaultFileSystemItemFactory, VersioningFileSystemItemFactory, TopLevelFolderItemFactory

Method Summary

Modifier and Type	Method and Description
boolean	canHandleFileSystemItemId(String id) Returns true if the given FileSystemItem id can be handled by this factory.
boolean	exists(String id, Principal principal) Returns true if a FileSystemItem with the given id exists for the given principal.
DocumentModel	getDocumentByFileSystemId(String id, Principal principal) Deprecated. since 7.2
FileSystemItem	getFileSystemItem(DocumentModel doc) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItemById(String id, Principal principal) Gets the FileSystemItem with the given id using a core session fetched with the given principal.
FileSystemItem	getFileSystemItemById(String id, String parentId, Principal principal) Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.
String	getName() Gets the factory unique name.
void	handleParameters(Map<String,String> parameters) Handles the factory parameters contributed through the fileSystemItemFactory contribution.
boolean	isFileSystemItem(DocumentModel doc) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
void	setName(String name) Sets the factory unique name.

Method Detail

getName

String getName()

Gets the factory unique name.

setName

void setName(String name)

Sets the factory unique name.

handleParameters

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

Handles the factory parameters contributed through the fileSystemItemFactory contribution.

Throws:

ClientException

isFileSystemItem

boolean isFileSystemItem(DocumentModel doc)
                  throws ClientException

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

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel, boolean)

isFileSystemItem

boolean isFileSystemItem(DocumentModel doc,
                         boolean includeDeleted)
                  throws ClientException

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.

Throws:

ClientException

isFileSystemItem

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

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.

Throws:

ClientException

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc)
                          throws ClientException

Gets the FileSystemItem for the given DocumentModel.

Returns:

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

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel), getFileSystemItem(DocumentModel, boolean)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 boolean includeDeleted)
                          throws ClientException

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.

Returns:

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

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean))

getFileSystemItem

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

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.

Returns:

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

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean, boolean))

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 FolderItem parentItem)
                          throws ClientException

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.

Returns:

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

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel), #getFileSystemItem(DocumentModel, String, boolean)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 FolderItem parentItem,
                                 boolean includeDeleted)
                          throws ClientException

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id. 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.

Returns:

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

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel, boolean)

getFileSystemItem

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

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.

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.

Returns:

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

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel, boolean, boolean)

canHandleFileSystemItemId

boolean canHandleFileSystemItemId(String id)

Returns true if the given FileSystemItem id can be handled by this factory. It is typically the case when the factory has been responsible for generating the FileSystemItem.

exists

boolean exists(String id,
               Principal principal)
        throws ClientException

Returns true if a FileSystemItem with the given id exists for the given principal.

Throws:

ClientException

getFileSystemItemById

FileSystemItem getFileSystemItemById(String id,
                                     Principal principal)
                              throws ClientException

Gets the FileSystemItem with the given id using a core session fetched with the given principal.

Returns:

the FileSystemItem or null if none matches the given id

Throws:

ClientException

getFileSystemItemById

FileSystemItem getFileSystemItemById(String id,
                                     String parentId,
                                     Principal principal)
                              throws ClientException

Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.

Returns:

the FileSystemItem or null if none matches the given id and parent id

Throws:

ClientException

Since:

6.0

getDocumentByFileSystemId

@Deprecated
DocumentModel getDocumentByFileSystemId(String id,
                                                    Principal principal)
                                             throws ClientException

Deprecated. since 7.2

Gets the DocumentModel bound to the given FileSystemItem id using a core session fetched with the given principal.

Returns:

the DocumentModel

Throws:

ClientException

Since:

6.0