A trait defining typical operations on files and folders that are stored on a server.
This trait defines the API of a file system. This project provides different implementations supporting different server-based protocols, such as OneDrive or WebDAV.
The protocol defined by this trait is agnostic to the concrete types representing files and folders in the file systems. The single operations are asynchronous; they expect an actor reference of type HttpRequestSender to be passed in and yield a ''Future'' with the result. This is indicated by the Operation result type. Operation is a monad, so multiple operations can be composed.
This trait extends ''AutoClosable'' to support a mechanism to clean up resources in a safe way. It is, however, expected that most concrete implementations are stateless and thus do not require such a mechanism. Therefore, there is an empty default implementation of the ''close()'' method.
Type parameters
- FILE
-
the type representing a file
- FOLDER
-
the type representing a folder
- FOLDER_CONTENT
-
the type representing the content of a folder
- ID
-
the type representing the ID of a file or folder
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait AutoCloseableclass Objecttrait Matchableclass Any
- Known subtypes
-
Members list
Value members
Abstract methods
Creates a file as a child of the given parent folder by uploading the file's content and setting some metadata attributes. The attributes to set are provided in form of a file object; typically some properties are mandatory, such as the file name and the file size. If the operation is successful, the ID of the new file is returned.
Creates a file as a child of the given parent folder by uploading the file's content and setting some metadata attributes. The attributes to set are provided in form of a file object; typically some properties are mandatory, such as the file name and the file size. If the operation is successful, the ID of the new file is returned.
Value parameters
- content
-
a ''Source'' with the content of the file
- file
-
an object with the attributes of the new file
- parent
-
the ID of the parent folder
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to create a new file
Creates a folder as a child of the given parent folder. The attributes of the new folder are defined by the folder object provided. If the operation is successful, the ID of the new folder is returned.
Creates a folder as a child of the given parent folder. The attributes of the new folder are defined by the folder object provided. If the operation is successful, the ID of the new folder is returned.
Value parameters
- folder
-
an object with the attributes of the new folder
- parent
-
the ID of the parent folder
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to create a new folder
Deletes the file with the given ID.
Deletes the file with the given ID.
Value parameters
- fileID
-
the ID of the file to delete
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to delete the file
Deletes the folder with the given ID. Note that depending on the concrete implementation, it may be required that a folder is empty before it can be deleted. The root folder can typically not be deleted.
Deletes the folder with the given ID. Note that depending on the concrete implementation, it may be required that a folder is empty before it can be deleted. The root folder can typically not be deleted.
Value parameters
- folderID
-
the ID of the folder to delete
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to delete a folder
Returns an entity for downloading the content of a file. The download can be performed by creating a stream with the data bytes of the resulting entity. Note that the entity must be consumed in all cases, either by running the stream with the data bytes or by discarding the bytes.
Returns an entity for downloading the content of a file. The download can be performed by creating a stream with the data bytes of the resulting entity. Note that the entity must be consumed in all cases, either by running the stream with the data bytes or by discarding the bytes.
Value parameters
- fileID
-
the ID of the file affected
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to obtain an entity for downloading a file
Returns an object describing the content of the folder with the given ID. This can be used to find the files and the folders that are the children of the folder with the ID specified.
Returns an object describing the content of the folder with the given ID. This can be used to find the files and the folders that are the children of the folder with the ID specified.
Value parameters
- id
-
the ID of the folder in question
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' returning the content of this folder
Returns the file identified by the given ID.
Returns the file identified by the given ID.
Value parameters
- id
-
the ID of the file in question
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' returning the file with this ID
Returns the folder identified by the given ID.
Returns the folder identified by the given ID.
Value parameters
- id
-
the ID of the folder in question
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' returning the folder with this ID
Resolves the ID of an element (file or folder) that is specified by its path. This function is analogous to ''resolvePathComponents()'', but the target element of the operation is identified by a URI-like path. It is assumed that the single components in this path are encoded as necessary to yield a valid URI.
Resolves the ID of an element (file or folder) that is specified by its path. This function is analogous to ''resolvePathComponents()'', but the target element of the operation is identified by a URI-like path. It is assumed that the single components in this path are encoded as necessary to yield a valid URI.
Value parameters
- path
-
the path to be resolved
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to resolve the path
Returns the ID of the root folder of this file system. This can be used as starting point to iterate over the content stored in the file system.
Returns the ID of the root folder of this file system. This can be used as starting point to iterate over the content stored in the file system.
Value parameters
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' returning the ID of the file system root
Updates the metadata of a file. The passed in file object must contain the ID of the file affected and the attributes to set.
Updates the metadata of a file. The passed in file object must contain the ID of the file affected and the attributes to set.
Value parameters
- file
-
the object representing the file
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to update file metadata
Updates the content of a file by uploading new data to the server.
Updates the content of a file by uploading new data to the server.
Value parameters
- content
-
a ''Source'' with the content of the file
- fileID
-
the ID of the file affected
- size
-
the size of the new content
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to upload new file content
Updates the metadata of a folder. The passed in folder object must contain the ID of the folder affected and the attributes to update.
Updates the metadata of a folder. The passed in folder object must contain the ID of the folder affected and the attributes to update.
Value parameters
- folder
-
the object representing the folder
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to update folder metadata
Concrete methods
Frees up resources used by this object when it is no longer needed. This base implementation does nothing.
Frees up resources used by this object when it is no longer needed. This base implementation does nothing.
Attributes
- Definition Classes
-
AutoCloseable
Returns the file object that is referenced by the path specified. This is a combination of resolving the path and obtaining the file with the resulting ID.
Returns the file object that is referenced by the path specified. This is a combination of resolving the path and obtaining the file with the resulting ID.
Value parameters
- path
-
the path of the desired file
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to resolve the file with this path
Returns the folder object that is referenced by the path specified. This is a combination of resolving the path and obtaining the folder with the resulting ID.
Returns the folder object that is referenced by the path specified. This is a combination of resolving the path and obtaining the folder with the resulting ID.
Value parameters
- path
-
the path to the desired folder
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to resolve the folder with this path
Resolves the ID of an element (file or folder) that is specified by a sequence of path components. The components define the names of folders to traverse from the root in order to come to the target element. In a hierarchical file system, there is typically a direct relation between a path and a URI that uniquely identifies an element. But not all file systems are hierarchical; e.g. in Google Drive a single file can be contained in multiple folders, so a resolve operation can be actually complex. The single components passed to this function should be plain file or folder names; no encoding is expected. This implementation encodes the components and concatenates them to a path URI and invokes ''resolvePath()'' with this path.
Resolves the ID of an element (file or folder) that is specified by a sequence of path components. The components define the names of folders to traverse from the root in order to come to the target element. In a hierarchical file system, there is typically a direct relation between a path and a URI that uniquely identifies an element. But not all file systems are hierarchical; e.g. in Google Drive a single file can be contained in multiple folders, so a resolve operation can be actually complex. The single components passed to this function should be plain file or folder names; no encoding is expected. This implementation encodes the components and concatenates them to a path URI and invokes ''resolvePath()'' with this path.
Value parameters
- components
-
the sequence of path components
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to resolve these path components
Returns an object with the content of the root folder. This is a combination of requesting the root folder ID and requesting the content of this folder.
Returns an object with the content of the root folder. This is a combination of requesting the root folder ID and requesting the content of this folder.
Value parameters
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' to obtain the content of the root folder
Combines an operation to update the content of a file with an operation to update its metadata properties. This base implementation delegates to the corresponding functions (''updateFileContent()'' and ''updateFile()'') in series. Implementations that can combine these updates in a single operation should override this function. Depending on the concrete underlying file system, it may be necessary to specify the new file size in the passed in file object.
Combines an operation to update the content of a file with an operation to update its metadata properties. This base implementation delegates to the corresponding functions (''updateFileContent()'' and ''updateFile()'') in series. Implementations that can combine these updates in a single operation should override this function. Depending on the concrete underlying file system, it may be necessary to specify the new file size in the passed in file object.
Value parameters
- content
-
a source with the new content of the file
- file
-
a data object with the properties of the file to update
- system
-
the actor system
Attributes
- Returns
-
the ''Operation'' that does the combined update