cloud-files-crypt
API
Generated with
cloud-files-crypt/com.github.cloudfiles.crypt/com.github.cloudfiles.crypt.fs/CryptContentFileSystem

CryptContentFileSystem

com.github.cloudfiles.crypt.fs.CryptContentFileSystem
class CryptContentFileSystem[ID, FILE <: File[ID], FOLDER](val delegate: ExtensibleFileSystem[ID, FILE, FOLDER, FolderContent[ID, FILE, FOLDER]], val config: CryptConfig) extends DelegateFileSystem[ID, FILE, FOLDER]

A file system extension that adds support for encrypting the content of files to another file system.

When uploading a file to this file system, the content source for the file is transformed to encrypt the data using the configured CryptAlgorithm and key; so only encrypted data is stored in the underlying file system. Analogously, on download of a file, the source returned by this file system performs decryption transparently.

Type parameters

FILE

the type to represent a file

FOLDER

the type to represent a folder

ID

the type of element IDs

Value parameters

config

the cryptography-related configuration

delegate

the underlying file system

Attributes

Graph
Supertypes
trait DelegateFileSystem[ID, FILE, FOLDER]
trait ExtensibleFileSystem[ID, FILE, FOLDER, FolderContent[ID, FILE, FOLDER]]
trait FileSystem[ID, FILE, FOLDER, FolderContent[ID, FILE, FOLDER]]
trait AutoCloseable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def createFile(parent: ID, file: File[ID], content: Source[ByteString, Any])(implicit system: ActorSystem[_]): Operation[ID]

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.

This implementation transforms the content source to automatically encrypt the data of the file. The file size is adjusted as well.

Attributes

Definition Classes
DelegateFileSystem -> FileSystem
override def downloadFile(fileID: ID)(implicit system: ActorSystem[_]): Operation[HttpEntity]

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.

This implementation transforms the data source of the entity from the underlying file system to decrypt the data.

Attributes

Definition Classes
DelegateFileSystem -> FileSystem
override def folderContent(id: ID)(implicit system: ActorSystem[_]): Operation[FolderContent[ID, FILE, FOLDER]]

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.

This implementation patches the size of the files in the content returned by the underlying file system.

Attributes

Definition Classes
DelegateFileSystem -> FileSystem
override def resolveFile(id: ID)(implicit system: ActorSystem[_]): Operation[FILE]

Returns the file identified by the given ID.

Returns the file identified by the given ID.

This implementation makes sure that the correct size of the encrypted file is returned.

Attributes

Definition Classes
DelegateFileSystem -> FileSystem
override def updateFileContent(fileID: ID, size: Long, content: Source[ByteString, Any])(implicit system: ActorSystem[_]): Operation[Unit]

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.

This implementation transforms the content source to automatically encrypt the data of the file. The file size is adjusted as well.

Attributes

Definition Classes
DelegateFileSystem -> FileSystem

Inherited methods

override def close(): Unit

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
DelegateFileSystem -> FileSystem -> AutoCloseable
Inherited from:
DelegateFileSystem
override def createFolder(parent: ID, folder: Folder[ID])(implicit system: ActorSystem[_]): Operation[ID]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
override def deleteFile(fileID: ID)(implicit system: ActorSystem[_]): Operation[Unit]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
override def deleteFolder(folderID: ID)(implicit system: ActorSystem[_]): Operation[Unit]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
override def patchFile(source: File[ID], spec: ElementPatchSpec): FILE

Constructs an implementation specific file object based on the properties of the given source file with the given patch specification applied. This allows components that extend the functionality of a ''FileSystem'' to manipulate the attributes of a file without having to know the concrete implementation class.

Constructs an implementation specific file object based on the properties of the given source file with the given patch specification applied. This allows components that extend the functionality of a ''FileSystem'' to manipulate the attributes of a file without having to know the concrete implementation class.

Value parameters

source

the source file

spec

the ''ElementPatchSpec'' to manipulate properties

Attributes

Returns

the resulting file object

Definition Classes
DelegateFileSystem -> ExtensibleFileSystem
Inherited from:
DelegateFileSystem
override def patchFolder(source: Folder[ID], spec: ElementPatchSpec): FOLDER

Constructs an implementation-specific folder object based on the properties of the given source folder with the given patch specification applied. This allows components that extend the functionality of a ''FileSystem'' to manipulate the attributes of a folder without having to know the concrete implementation class.

Constructs an implementation-specific folder object based on the properties of the given source folder with the given patch specification applied. This allows components that extend the functionality of a ''FileSystem'' to manipulate the attributes of a folder without having to know the concrete implementation class.

Value parameters

source

the source folder

spec

the ''ElementPatchSpec'' to manipulate properties

Attributes

Returns

the resulting folder object

Definition Classes
DelegateFileSystem -> ExtensibleFileSystem
Inherited from:
DelegateFileSystem
def resolveFileByPath(path: String)(implicit system: ActorSystem[_]): Operation[FILE]

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

Inherited from:
FileSystem
override def resolveFolder(id: ID)(implicit system: ActorSystem[_]): Operation[FOLDER]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
def resolveFolderByPath(path: String)(implicit system: ActorSystem[_]): Operation[FOLDER]

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

Inherited from:
FileSystem
override def resolvePath(path: String)(implicit system: ActorSystem[_]): Operation[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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
override def resolvePathComponents(components: Seq[String])(implicit system: ActorSystem[_]): Operation[ID]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
def rootFolderContent(implicit system: ActorSystem[_]): Operation[FOLDER_CONTENT]

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

Inherited from:
FileSystem
override def rootID(implicit system: ActorSystem[_]): Operation[ID]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
override def updateFile(file: File[ID])(implicit system: ActorSystem[_]): Operation[Unit]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem
def updateFileAndContent(file: File[ID], content: Source[ByteString, Any])(implicit system: ActorSystem[_]): Operation[Unit]

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

Inherited from:
FileSystem
override def updateFolder(folder: Folder[ID])(implicit system: ActorSystem[_]): Operation[Unit]

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

Definition Classes
DelegateFileSystem -> FileSystem
Inherited from:
DelegateFileSystem

Concrete fields

override val delegate: ExtensibleFileSystem[ID, FILE, FOLDER, FolderContent[ID, FILE, FOLDER]]

Returns the ''FileSystem'' to which operations are delegated by default.

Returns the ''FileSystem'' to which operations are delegated by default.

Attributes

Returns

the ''FileSystem'' to delegate to

Generated with