org.nuxeo.drive.service

Interface FileSystemItemManager

All Known Implementing Classes:

FileSystemItemManagerImpl

public interface FileSystemItemManager

Provides an API to manage usual file system operations on a FileSystemItem given its id. Allows the following actions:

• Read
• Read children
• Read descendants
• Create
• Update
• Delete
• Rename
• Move

Author:

Antoine Taillefer

See Also:

FileSystemItemManagerImpl

Method Summary

Modifier and Type	Method and Description
boolean	canMove(String srcId, String destId, NuxeoPrincipal principal) Return true if the FileSystemItem with the given source id can be moved to the FileSystemItem with the given destination id for the given principal.
default FileItem	createFile(String parentId, Blob blob, NuxeoPrincipal principal) Deprecated. since 9.1, use createFile(String, Blob, NuxeoPrincipal, boolean) instead
FileItem	createFile(String parentId, Blob blob, NuxeoPrincipal principal, boolean overwrite) Creates a file with the given blob in the FileSystemItem with the given id for the given principal.
default FolderItem	createFolder(String parentId, String name, NuxeoPrincipal principal) Deprecated. since 9.1, use createFolder(String, String, NuxeoPrincipal, boolean) instead
FolderItem	createFolder(String parentId, String name, NuxeoPrincipal principal, boolean overwrite) Creates a folder with the given name in the FileSystemItem with the given id for the given principal.
void	delete(String id, NuxeoPrincipal principal) Deletes the FileSystemItem with the given id for the given principal.
void	delete(String id, String parentId, NuxeoPrincipal principal) Deletes the FileSystemItem with the given id and parent id for the given principal.
boolean	exists(String id, NuxeoPrincipal principal) Returns true if a FileSystemItem with the given id exists for the given principal.
List<FileSystemItem>	getChildren(String id, NuxeoPrincipal principal) Gets the children of the FileSystemItem with the given id for the given principal.
FileSystemItem	getFileSystemItemById(String id, NuxeoPrincipal principal) Gets the FileSystemItem with the given id for the given principal.
FileSystemItem	getFileSystemItemById(String id, String parentId, NuxeoPrincipal principal) Gets the FileSystemItem with the given id and parent id for the given principal.
FolderItem	getTopLevelFolder(NuxeoPrincipal principal) Gets the top level FolderItem for the given principal.
FileSystemItem	move(String srcId, String destId, NuxeoPrincipal principal) Moves the FileSystemItem with the given source id to the FileSystemItem with the given destination id for the given principal.
FileSystemItem	rename(String id, String name, NuxeoPrincipal principal) Renames the FileSystemItem with the given id with the given name for the given principal.
ScrollFileSystemItemList	scrollDescendants(String id, NuxeoPrincipal principal, String scrollId, int batchSize, long keepAlive) Retrieves at most batchSize descendants of the FolderItem with the given id for the given principal and the given scrollId.
FileItem	updateFile(String id, Blob blob, NuxeoPrincipal principal) Updates the FileSystemItem with the given id with the given blob for the given principal.
FileItem	updateFile(String id, String parentId, Blob blob, NuxeoPrincipal principal) Updates the FileSystemItem with the given id and parent id with the given blob for the given principal.

Method Detail

getTopLevelFolder

FolderItem getTopLevelFolder(NuxeoPrincipal principal)

Gets the top level FolderItem for the given principal.

exists

boolean exists(String id,
               NuxeoPrincipal principal)

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

See Also:

FileSystemItemFactory.exists(String, NuxeoPrincipal)

getFileSystemItemById

FileSystemItem getFileSystemItemById(String id,
                                     NuxeoPrincipal principal)

Gets the FileSystemItem with the given id for the given principal.

Returns:

the FileSystemItem or null if none matches the given id

See Also:

FileSystemItemFactory.getFileSystemItemById(String, NuxeoPrincipal)

getFileSystemItemById

FileSystemItem getFileSystemItemById(String id,
                                     String parentId,
                                     NuxeoPrincipal principal)

Gets the FileSystemItem with the given id and parent id for the given principal.

Returns:

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

Since:

6.0

See Also:

getFileSystemItemById(String, NuxeoPrincipal)

getChildren

List<FileSystemItem> getChildren(String id,
                                 NuxeoPrincipal principal)

Gets the children of the FileSystemItem with the given id for the given principal.

See Also:

FolderItem.getChildren()

scrollDescendants

ScrollFileSystemItemList scrollDescendants(String id,
                                           NuxeoPrincipal principal,
                                           String scrollId,
                                           int batchSize,
                                           long keepAlive)

Retrieves at most batchSize descendants of the FolderItem with the given id for the given principal and 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.

Since:

8.3

See Also:

FolderItem.scrollDescendants(String, int, long)

canMove

boolean canMove(String srcId,
                String destId,
                NuxeoPrincipal principal)

Return true if the FileSystemItem with the given source id can be moved to the FileSystemItem with the given destination id for the given principal.

See Also:

FileSystemItem#getCanMove(String)

createFolder

@Deprecated
default FolderItem createFolder(String parentId,
                                            String name,
                                            NuxeoPrincipal principal)

Deprecated. since 9.1, use createFolder(String, String, NuxeoPrincipal, boolean) instead

Creates a folder with the given name in the FileSystemItem with the given id for the given principal.

See Also:

FolderItem.createFolder(String)

createFolder

FolderItem createFolder(String parentId,
                        String name,
                        NuxeoPrincipal principal,
                        boolean overwrite)

Creates a folder with the given name in the FileSystemItem with the given id for the given principal.

Parameters:

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

Since:

9.1

See Also:

FolderItem.createFolder(String, boolean)

createFile

@Deprecated
default FileItem createFile(String parentId,
                                        Blob blob,
                                        NuxeoPrincipal principal)

Deprecated. since 9.1, use createFile(String, Blob, NuxeoPrincipal, boolean) instead

Creates a file with the given blob in the FileSystemItem with the given id for the given principal.

See Also:

FolderItem.createFile(Blob)

createFile

FileItem createFile(String parentId,
                    Blob blob,
                    NuxeoPrincipal principal,
                    boolean overwrite)

Creates a file with the given blob in the FileSystemItem with the given id for the given principal.

Parameters:

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

Since:

9.1

See Also:

FolderItem.createFile(Blob, boolean)

updateFile

FileItem updateFile(String id,
                    Blob blob,
                    NuxeoPrincipal principal)

Updates the FileSystemItem with the given id with the given blob for the given principal.

See Also:

FileItem.setBlob(Blob)

updateFile

FileItem updateFile(String id,
                    String parentId,
                    Blob blob,
                    NuxeoPrincipal principal)

Updates the FileSystemItem with the given id and parent id with the given blob for the given principal.

Since:

6.0

See Also:

updateFile(String, Blob, NuxeoPrincipal)

delete

void delete(String id,
            NuxeoPrincipal principal)

Deletes the FileSystemItem with the given id for the given principal.

See Also:

FileSystemItem.delete()

delete

void delete(String id,
            String parentId,
            NuxeoPrincipal principal)

Deletes the FileSystemItem with the given id and parent id for the given principal.

Since:

6.0

See Also:

delete(String, NuxeoPrincipal)

rename

FileSystemItem rename(String id,
                      String name,
                      NuxeoPrincipal principal)

Renames the FileSystemItem with the given id with the given name for the given principal.

See Also:

FileSystemItem.rename(String)

move

FileSystemItem move(String srcId,
                    String destId,
                    NuxeoPrincipal principal)

Moves the FileSystemItem with the given source id to the FileSystemItem with the given destination id for the given principal.

See Also:

FileSystemItem#move(String)