B C D E F G H I J M O P R S U
All Classes All Packages

B

BatchPathRequest - Class in org.xwiki.filemanager.job

A generic request that targets multiple paths in the file system.

BatchPathRequest() - Constructor for class org.xwiki.filemanager.job.BatchPathRequest

C

canDelete(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

canEdit(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

canView(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

copy(Collection<String>, String) - Method in class org.xwiki.filemanager.script.DriveScriptService

Schedules a job to copy the specified files and folders to the given destination.

copy(Collection<Path>, Path) - Method in interface org.xwiki.filemanager.job.FileManager

Schedules a job to copy the specified files and folders to the given destination.

copy(DocumentReference, DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

Copy a file or a folder.

D

delete(Collection<String>) - Method in class org.xwiki.filemanager.script.DriveScriptService

Schedules a job to delete the specified files and folders.

delete(Collection<Path>) - Method in interface org.xwiki.filemanager.job.FileManager

Schedules a job to delete the specified files and folders.

delete(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

Delete a file or a folder.

Document - Interface in org.xwiki.filemanager

A document in the file system.

DriveScriptService - Class in org.xwiki.filemanager.script

Exposes simplified APIs to execute batch jobs on a file system drive.

DriveScriptService() - Constructor for class org.xwiki.filemanager.script.DriveScriptService

E

equals(Object) - Method in class org.xwiki.filemanager.Path

exists(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

F

File - Interface in org.xwiki.filemanager

Represents a file.

FileManager - Interface in org.xwiki.filemanager.job

Exposes APIs to run file system jobs.

FileSystem - Interface in org.xwiki.filemanager

Represents the file system.

Folder - Interface in org.xwiki.filemanager

Represents a folder.

G

generate(SpaceReference, Iterator<String>) - Method in interface org.xwiki.filemanager.reference.UniqueDocumentReferenceGenerator

Iterates the given sequence of document names until it finds one that doesn't exist already in the specified space or that isn't already reserved.

getActiveJobs() - Method in interface org.xwiki.filemanager.job.FileManager

getActiveJobs() - Method in class org.xwiki.filemanager.script.DriveScriptService

getBytesWritten() - Method in class org.xwiki.filemanager.job.PackJobStatus

getChildFileReferences() - Method in interface org.xwiki.filemanager.Folder

getChildFolderReferences() - Method in interface org.xwiki.filemanager.Folder

getContent() - Method in interface org.xwiki.filemanager.File

getDestination() - Method in class org.xwiki.filemanager.job.MoveRequest

getDestination() - Method in class org.xwiki.filemanager.job.OverwriteQuestion

getDownloadURL() - Method in class org.xwiki.filemanager.job.PackJobStatus

getFile(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

getFileReference() - Method in class org.xwiki.filemanager.Path

getFolder(DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

getFolderReference() - Method in class org.xwiki.filemanager.Path

getJobStatus(String) - Method in interface org.xwiki.filemanager.job.FileManager

getJobStatus(String) - Method in class org.xwiki.filemanager.script.DriveScriptService

getLastError() - Method in class org.xwiki.filemanager.script.DriveScriptService

Get the error generated while performing the previously called action.

getName() - Method in interface org.xwiki.filemanager.Document

getOutputFileReference() - Method in class org.xwiki.filemanager.job.PackRequest

getOutputFileSize() - Method in class org.xwiki.filemanager.job.PackJobStatus

getParentReference() - Method in interface org.xwiki.filemanager.Folder

getParentReferences() - Method in interface org.xwiki.filemanager.File

getPaths() - Method in class org.xwiki.filemanager.job.BatchPathRequest

getReference() - Method in interface org.xwiki.filemanager.Document

getSource() - Method in class org.xwiki.filemanager.job.OverwriteQuestion

getUniqueReference(String) - Method in class org.xwiki.filemanager.script.DriveScriptService

Generates a unique reference for a file or folder with the specified name.

H

hashCode() - Method in class org.xwiki.filemanager.Path

I

isAskAgain() - Method in class org.xwiki.filemanager.job.OverwriteQuestion

isOverwrite() - Method in class org.xwiki.filemanager.job.OverwriteQuestion

J

JOB_ID_PREFIX - Static variable in interface org.xwiki.filemanager.job.FileManager

The string used as a prefix for all file system jobs.

M

move(Collection<String>, String) - Method in class org.xwiki.filemanager.script.DriveScriptService

Schedules a job to move the specified files and folders to the given destination.

move(Collection<Path>, Path) - Method in interface org.xwiki.filemanager.job.FileManager

Schedules a job to move the specified files and folders to the given destination.

MoveRequest - Class in org.xwiki.filemanager.job

Request used by MoveJob to move files and folders to a different path, possibly renaming the target file or folder in case there is only one item to move.

MoveRequest() - Constructor for class org.xwiki.filemanager.job.MoveRequest

O

org.xwiki.filemanager - package org.xwiki.filemanager

org.xwiki.filemanager.job - package org.xwiki.filemanager.job

org.xwiki.filemanager.reference - package org.xwiki.filemanager.reference

org.xwiki.filemanager.script - package org.xwiki.filemanager.script

OverwriteQuestion - Class in org.xwiki.filemanager.job

Question asked when a file with the same name is found during a copy or move operation and we don't know whether to overwrite or keep the existing file.

OverwriteQuestion(DocumentReference, DocumentReference) - Constructor for class org.xwiki.filemanager.job.OverwriteQuestion

Ask whether to overwrite or not the destination file with the source file.

P

pack(Collection<String>, AttachmentReference) - Method in class org.xwiki.filemanager.script.DriveScriptService

Schedules a job to pack the specified files and folders into a single ZIP archive.

pack(Collection<Path>, AttachmentReference) - Method in interface org.xwiki.filemanager.job.FileManager

Packs the specified files and folders in a single ZIP archive that is written in the specified output file.

PackJobStatus - Class in org.xwiki.filemanager.job

The status of a job that executes a PackRequest.

PackJobStatus(String, PackRequest, JobStatus, ObservationManager, LoggerManager) - Constructor for class org.xwiki.filemanager.job.PackJobStatus

PackRequest - Class in org.xwiki.filemanager.job

Request used by PackJob to pack multiple files and folders (including the child files and sub-folders) in a single ZIP archive.

PackRequest() - Constructor for class org.xwiki.filemanager.job.PackRequest

Path - Class in org.xwiki.filemanager

Represents a path in the file system.

Path(DocumentReference) - Constructor for class org.xwiki.filemanager.Path

Creates a new path that is determined by the specified folder.

Path(DocumentReference, DocumentReference) - Constructor for class org.xwiki.filemanager.Path

Creates a new path that is determined by the given (folder, file) pair.

PROPERTY_DESTINATION - Static variable in class org.xwiki.filemanager.job.MoveRequest

PROPERTY_OUTPUT_FILE_REFERENCE - Static variable in class org.xwiki.filemanager.job.PackRequest

PROPERTY_PATHS - Static variable in class org.xwiki.filemanager.job.BatchPathRequest

R

rename(DocumentReference, DocumentReference) - Method in interface org.xwiki.filemanager.FileSystem

Renames the specified file or folder.

S

save(Document) - Method in interface org.xwiki.filemanager.FileSystem

Save a file or a folder.

setAskAgain(boolean) - Method in class org.xwiki.filemanager.job.OverwriteQuestion

Sets whether this question will be asked again or not if another file with the same name is found.

setBytesWritten(long) - Method in class org.xwiki.filemanager.job.PackJobStatus

Sets the number of bytes written so far in the output ZIP file.

setDestination(Path) - Method in class org.xwiki.filemanager.job.MoveRequest

Sets the destination path where to move the files and folders.

setDownloadURL(String) - Method in class org.xwiki.filemanager.job.PackJobStatus

Sets the URL used to download the output ZIP file.

setName(String) - Method in interface org.xwiki.filemanager.Document

Sets the name.

setOutputFileReference(AttachmentReference) - Method in class org.xwiki.filemanager.job.PackRequest

Sets the reference to the output ZIP file that will pack the files and folders specified by BatchPathRequest.getPaths().

setOutputFileSize(long) - Method in class org.xwiki.filemanager.job.PackJobStatus

Sets the actual size (in bytes) of the output file, after the ZIP compression.

setOverwrite(boolean) - Method in class org.xwiki.filemanager.job.OverwriteQuestion

Sets whether to overwrite or not the file that exists in the destination folder with the one being copied or moved.

setParentReference(DocumentReference) - Method in interface org.xwiki.filemanager.Folder

Sets the parent folder reference.

setPaths(Collection<Path>) - Method in class org.xwiki.filemanager.job.BatchPathRequest

Sets the paths that are targeted by this request.

U

UniqueDocumentReferenceGenerator - Interface in org.xwiki.filemanager.reference

Interface used to generate a unique DocumentReference, i.e.

B C D E F G H I J M O P R S U
All Classes All Packages