|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.PluginApi
com.xpn.xwiki.plugin.fileupload.FileUploadPluginApi
public class FileUploadPluginApi
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
FileUploadPluginApi(FileUploadPlugin plugin,
XWikiContext context)
|
Method Summary | |
---|---|
void |
cleanFileList()
Deletes all temporary files of the upload |
java.lang.String |
getFileItem(java.lang.String name)
Allows to retrieve the data of FileItem named name loadFileList needs to be called beforehand |
byte[] |
getFileItemData(java.lang.String name)
Allows to retrieve the data of FileItem named name loadFileList needs to be called beforehand |
java.util.List |
getFileItemNames()
Allows to retrieve the list of FileItem names loadFileList needs to be called beforehand |
java.util.List |
getFileItems()
Allows to retrieve the current FileItem list loadFileList needs to be called beforehand |
java.lang.String |
getFileName(java.lang.String name)
Get file name from FileItem |
FileUploadPlugin |
getFileUploadPlugin()
|
void |
loadFileList()
Allows to load the file list in the context if there is a file upload Default uploadMaxSize, uploadSizeThreashold and temporary directory are used |
void |
loadFileList(long uploadMaxSize,
int uploadSizeThreashold,
java.lang.String tempdir)
Allows to load the file list in the context if there is a file upload |
Methods inherited from class com.xpn.xwiki.plugin.PluginApi |
---|
getPlugin, setPlugin |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
checkProgrammingRights, hasAccessLevel, hasAdminRights, hasProgrammingRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileUploadPluginApi(FileUploadPlugin plugin, XWikiContext context)
Method Detail |
---|
public FileUploadPlugin getFileUploadPlugin()
public void cleanFileList()
public void loadFileList() throws XWikiException
XWikiException
- An XWikiException is thrown if the request could not be parserpublic void loadFileList(long uploadMaxSize, int uploadSizeThreashold, java.lang.String tempdir) throws XWikiException
uploadMaxSize
- Maximum size of the requestuploadSizeThreashold
- Threashold over which the data should be on disk and not in memorytempdir
- Temporary Directory to store temp data
XWikiException
- An XWikiException is thrown if the request could not be parserpublic java.util.List getFileItems()
public byte[] getFileItemData(java.lang.String name) throws XWikiException
name
- Name of the item
XWikiException
- Exception is thrown if the data could not be readpublic java.lang.String getFileItem(java.lang.String name) throws XWikiException
name
- Name of the item
XWikiException
- Exception is thrown if the data could not be readpublic java.util.List getFileItemNames()
public java.lang.String getFileName(java.lang.String name)
name
- of the field
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |