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
• Create
• Update
• Delete
• Rename
• Move

Author:

Antoine Taillefer

See Also:

FileSystemItemManagerImpl

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canMove(String srcId, String destId, Principal 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.
FileItem	createFile(String parentId, Blob blob, Principal principal) Creates a file with the given blob in the FileSystemItem with the given id for the given principal.
FolderItem	createFolder(String parentId, String name, Principal principal) Creates a folder with the given name in the FileSystemItem with the given id for the given principal.
void	delete(String id, Principal principal) Deletes the FileSystemItem with the given id for the given principal.
void	delete(String id, String parentId, Principal principal) Deletes the FileSystemItem with the given id and parent id for the given principal.
boolean	exists(String id, Principal principal) Returns true if a FileSystemItem with the given id exists for the given principal.
List<FileSystemItem>	getChildren(String id, Principal principal) Gets the children of the FileSystemItem with the given id for the given principal.
FileSystemItem	getFileSystemItemById(String id, Principal principal) Gets the FileSystemItem with the given id for the given principal.
FileSystemItem	getFileSystemItemById(String id, String parentId, Principal principal) Gets the FileSystemItem with the given id and parent id for the given principal.
CoreSession	getSession(String repositoryName, Principal principal) Deprecated. since 7.2, use CoreInstance.openCoreSession(String, Principal) instead.
List<FileSystemItem>	getTopLevelChildren(Principal principal) Deprecated. use getTopLevelFolder#getChildren instead
FolderItem	getTopLevelFolder(Principal principal) Gets the top level FolderItem for the given principal.
FileSystemItem	move(String srcId, String destId, Principal 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, Principal principal) Renames the FileSystemItem with the given id with the given name for the given principal.
FileItem	updateFile(String id, Blob blob, Principal principal) Updates the FileSystemItem with the given id with the given blob for the given principal.
FileItem	updateFile(String id, String parentId, Blob blob, Principal principal) Updates the FileSystemItem with the given id and parent id with the given blob for the given principal.

Method Detail

getSession

@Deprecated
CoreSession getSession(String repositoryName,
                                Principal principal)
                       throws ClientException

Deprecated. since 7.2, use CoreInstance.openCoreSession(String, Principal) instead.

Gets a session bound to the given repository for the given principal.

Throws:

ClientException

getTopLevelChildren

@Deprecated
List<FileSystemItem> getTopLevelChildren(Principal principal)
                                         throws ClientException

Deprecated. use getTopLevelFolder#getChildren instead

Gets the children of the top level FolderItem for the given principal.

Throws:

ClientException - if the top level FolderItem or its children cannot be retrieved

getTopLevelFolder

FolderItem getTopLevelFolder(Principal principal)
                             throws ClientException

Gets the top level FolderItem for the given principal.

Throws:

ClientException - if the top level FolderItem cannot be retrieved

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 - if no FileSystemItemFactory can handle the given FileSystemItem id or if an error occurs while checking the existence

See Also:

FileSystemItemFactory.exists(String, Principal)

getFileSystemItemById

FileSystemItem getFileSystemItemById(String id,
                                   Principal principal)
                                     throws ClientException

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

Returns:

the FileSystemItem or null if none matches the given id

Throws:

ClientException - if no FileSystemItemFactory can handle the given FileSystemItem id or if an error occurs while retrieving the item

See Also:

FileSystemItemFactory.getFileSystemItemById(String, Principal)

getFileSystemItemById

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

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

Throws:

ClientException - if no FileSystemItemFactory can handle the given FileSystemItem ids or if an error occurs while retrieving the item

Since:

6.0

See Also:

getFileSystemItemById(String, Principal)

getChildren

List<FileSystemItem> getChildren(String id,
                               Principal principal)
                                 throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved, or if it is not a FolderItem or if an error occurs while retrieving the children

See Also:

FolderItem.getChildren()

canMove

boolean canMove(String srcId,
              String destId,
              Principal principal)
                throws ClientException

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.

Throws:

ClientException - if the FileSystemItem with the given source or destination id cannot be retrieved

See Also:

FileSystemItem#getCanMove(String)

createFolder

FolderItem createFolder(String parentId,
                      String name,
                      Principal principal)
                        throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved, or if it is not a FolderItem or if an error occurs while creating the folder

See Also:

FolderItem.createFolder(String)

createFile

FileItem createFile(String parentId,
                  Blob blob,
                  Principal principal)
                    throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved, or if it is not a FolderItem or if an error occurs while creating the file

See Also:

FolderItem.createFile(Blob)

updateFile

FileItem updateFile(String id,
                  Blob blob,
                  Principal principal)
                    throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved, or if it is not a FileItem or if an error occurs while updating the file

See Also:

FileItem.setBlob(Blob)

updateFile

FileItem updateFile(String id,
                  String parentId,
                  Blob blob,
                  Principal principal)
                    throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id and parent id cannot be retrieved, or if it is not a FileItem or if an error occurs while updating the file

Since:

6.0

See Also:

updateFile(String, Blob, Principal)

delete

void delete(String id,
          Principal principal)
            throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved or if an error occurs while deleting the item

See Also:

FileSystemItem.delete()

delete

void delete(String id,
          String parentId,
          Principal principal)
            throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id and parent id cannot be retrieved or if an error occurs while deleting the item

Since:

6.0

See Also:

delete(String, Principal)

rename

FileSystemItem rename(String id,
                    String name,
                    Principal principal)
                      throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given id cannot be retrieved or if an error occurs while renaming the item

See Also:

FileSystemItem.rename(String)

move

FileSystemItem move(String srcId,
                  String destId,
                  Principal principal)
                    throws ClientException

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

Throws:

ClientException - if the FileSystemItem with the given source or destination id cannot be retrieved, if the FileSystemItem with the given destination id is not a folder or if an error occurs while moving the item

See Also:

FileSystemItem#move(String)