|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Role public interface FilesystemStoreTools
Tools for getting files to store data in the filesystem. These APIs are in flux and may change at any time without warning. This should be replaced by a module which provides a secure extension of java.io.File.
Method Summary | |
---|---|
Map<String,Map<Date,DeletedAttachmentFileProvider>> |
deletedAttachmentsForDocument(DocumentReference docRef)
Get a map of dates of deletion by the document where the attachment was attached. |
AttachmentFileProvider |
getAttachmentFileProvider(XWikiAttachment attachment)
Get an instance of AttachmentFileProvider which will save everything to do with an attachment in a separate location which is repeatable only with the same attachment name, and containing document. |
File |
getBackupFile(File storageFile)
Get a backup file which for a given storage file. |
DeletedAttachmentFileProvider |
getDeletedAttachmentFileProvider(String pathToDirectory)
Get a deleted attachment file provider from a path to the deleted attachment directory. |
DeletedAttachmentFileProvider |
getDeletedAttachmentFileProvider(XWikiAttachment attachment,
Date deleteDate)
Get an instance of AttachmentFileProvider which will save everything to do with an attachment in a separate location which is repeatable only with the same attachment name, containing document, and date of deletion. |
File |
getGlobalFile(String name)
Get a file which is global for the entire installation. |
ReadWriteLock |
getLockForFile(File toLock)
Get a ReadWriteLock which is unique to the given file. |
String |
getStorageLocationPath()
|
File |
getTempFile(File storageFile)
Get a temporary file which for a given storage file. |
Method Detail |
---|
File getBackupFile(File storageFile)
storageFile
- the file to get a backup file for.
File getTempFile(File storageFile)
storageFile
- the file to get a temporary file for.
AttachmentFileProvider getAttachmentFileProvider(XWikiAttachment attachment)
attachment
- the attachment to get a tools for.
DeletedAttachmentFileProvider getDeletedAttachmentFileProvider(XWikiAttachment attachment, Date deleteDate)
attachment
- the attachment to get a tools for.deleteDate
- the date the attachment was deleted.
Map<String,Map<Date,DeletedAttachmentFileProvider>> deletedAttachmentsForDocument(DocumentReference docRef)
docRef
- a reference to the document to get deleted attachments for.
String getStorageLocationPath()
File getGlobalFile(String name)
name
- a unique identifier for the file.
DeletedAttachmentFileProvider getDeletedAttachmentFileProvider(String pathToDirectory)
pathToDirectory
- a relitive path to the directory where the deleted attachment is.
ReadWriteLock getLockForFile(File toLock)
ReadWriteLock
which is unique to the given file.
This method will always return the same lock for the path on the filesystem even if the
File
object is different.
toLock
- the file to get a lock for.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |