|
Liferay 6.2.0-ce-b3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.documentlibrary.store.BaseStore
com.liferay.portlet.documentlibrary.store.FileSystemStore
public class FileSystemStore
| Field Summary |
|---|
| Fields inherited from interface com.liferay.portlet.documentlibrary.store.Store |
|---|
VERSION_DEFAULT |
| Constructor Summary | |
|---|---|
FileSystemStore()
|
|
| Method Summary | |
|---|---|
void |
addDirectory(long companyId,
long repositoryId,
String dirName)
Adds a directory. |
void |
addFile(long companyId,
long repositoryId,
String fileName,
InputStream is)
Adds a file based on an InputStream object. |
void |
checkRoot(long companyId)
Ensures company's root directory exists. |
void |
copyFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
Creates a new copy of the file version. |
void |
deleteDirectory(long companyId,
long repositoryId,
String dirName)
Deletes a directory. |
protected void |
deleteEmptyAncestors(File file)
|
protected void |
deleteEmptyAncestors(long companyId,
long repositoryId,
File file)
|
void |
deleteFile(long companyId,
long repositoryId,
String fileName)
Deletes a file. |
void |
deleteFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Deletes a file at a particular version. |
protected File |
getCompanyDir(long companyId)
|
protected File |
getDirNameDir(long companyId,
long repositoryId,
String dirName)
|
File |
getFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns the file as a File object. |
InputStream |
getFileAsStream(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns the file as an InputStream object. |
protected File |
getFileNameDir(long companyId,
long repositoryId,
String fileName)
|
String[] |
getFileNames(long companyId,
long repositoryId)
|
String[] |
getFileNames(long companyId,
long repositoryId,
String dirName)
Returns all files of the directory. |
protected File |
getFileNameVersionFile(long companyId,
long repositoryId,
String fileName,
String version)
|
long |
getFileSize(long companyId,
long repositoryId,
String fileName)
Returns the size of the file. |
protected String |
getHeadVersionLabel(long companyId,
long repositoryId,
String fileName)
|
protected File |
getRepositoryDir(long companyId,
long repositoryId)
|
boolean |
hasDirectory(long companyId,
long repositoryId,
String dirName)
Returns true if the directory exists. |
boolean |
hasFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns true if the file exists. |
void |
move(String srcDir,
String destDir)
Moves an existing directory. |
void |
updateFile(long companyId,
long repositoryId,
long newRepositoryId,
String fileName)
Moves a file to a new data repository. |
void |
updateFile(long companyId,
long repositoryId,
String fileName,
String newFileName)
|
void |
updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
InputStream is)
Updates a file based on an InputStream object. |
void |
updateFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
Update's a file version label. |
| Methods inherited from class com.liferay.portlet.documentlibrary.store.BaseStore |
|---|
addFile, addFile, getFile, getFileAsBytes, getFileAsBytes, getFileAsStream, hasFile, updateFile, updateFile |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FileSystemStore()
| Method Detail |
|---|
public void addDirectory(long companyId,
long repositoryId,
String dirName)
throws PortalException
BaseStore
addDirectory in interface StoreaddDirectory in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's name
PortalException - if the directory's information was invalid
public void addFile(long companyId,
long repositoryId,
String fileName,
InputStream is)
throws PortalException,
SystemException
BaseStoreInputStream object.
addFile in interface StoreaddFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file nameis - the files's data
PortalException - if the file's information was invalid
SystemException - if a system exception occurredpublic void checkRoot(long companyId)
BaseStoreJCRStore.checkRoot(long).
checkRoot in interface StorecheckRoot in class BaseStorecompanyId - the primary key of the company
public void copyFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
throws PortalException,
SystemException
BaseStore
This method should be overrided if a more optimized approach can be used
(e.g., copyFileVersion(long, long, String, String,
String)).
copyFileVersion in interface StorecopyFileVersion in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the original's file namefromVersionLabel - the original file's version labeltoVersionLabel - the new version label
PortalException - if the file's information was invalid
SystemException - if a system exception occurred
public void deleteDirectory(long companyId,
long repositoryId,
String dirName)
throws PortalException
BaseStore
deleteDirectory in interface StoredeleteDirectory in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's name
PortalException - if the directory's information was invalid
public void deleteFile(long companyId,
long repositoryId,
String fileName)
throws PortalException
BaseStore
deleteFile in interface StoredeleteFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's name
PortalException - if the file's information was invalid
public void deleteFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
BaseStore
deleteFile in interface StoredeleteFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameversionLabel - the file's version label
PortalException - if the file's information was invalid
public File getFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
BaseStoreFile object.
This method is useful when optimizing low-level file operations like
copy. The client must not delete or change the returned File
object in any way. This method is only supported in certain stores. If
not supported, this method will throw an UnsupportedOperationException.
This method should be overrided if a more optimized approach can be used
(e.g., getFile(long, long, String, String)).
getFile in interface StoregetFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameversionLabel - the file's version label
File object with the file's name
PortalException - if the file's information was invalid
public InputStream getFileAsStream(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
BaseStoreInputStream object.
getFileAsStream in interface StoregetFileAsStream in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameversionLabel - the file's version label
InputStream object with the file's name
PortalException - if the file's information was invalid
public String[] getFileNames(long companyId,
long repositoryId)
public String[] getFileNames(long companyId,
long repositoryId,
String dirName)
throws PortalException
BaseStore
getFileNames in interface StoregetFileNames in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's name
PortalException - if the directory's information was invalid
public long getFileSize(long companyId,
long repositoryId,
String fileName)
throws PortalException
BaseStore
getFileSize in interface StoregetFileSize in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's name
PortalException - if the file's information was invalid
public boolean hasDirectory(long companyId,
long repositoryId,
String dirName)
BaseStoretrue if the directory exists.
hasDirectory in interface StorehasDirectory in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's name
true if the directory exists; false
otherwise
public boolean hasFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
BaseStoretrue if the file exists.
hasFile in interface StorehasFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameversionLabel - the file's version label
true if the file exists; false
otherwise
public void move(String srcDir,
String destDir)
BaseStoreJCRStore.move(String, String).
move in interface Storemove in class BaseStoresrcDir - the original directory's namedestDir - the new directory's name
public void updateFile(long companyId,
long repositoryId,
long newRepositoryId,
String fileName)
throws PortalException,
SystemException
BaseStore
updateFile in interface StoreupdateFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repositorynewRepositoryId - the primary key of the new data repositoryfileName - the file's name
PortalException - if the file's information was invalid
SystemException - if a system exception occurred
public void updateFile(long companyId,
long repositoryId,
String fileName,
String newFileName)
throws PortalException,
SystemException
PortalException
SystemException
public void updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
InputStream is)
throws PortalException,
SystemException
BaseStoreInputStream object.
updateFile in interface StoreupdateFile in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file nameversionLabel - the file's new version labelis - the new file's data
PortalException - if the file's information was invalid
SystemException - if a system exception occurred
public void updateFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
throws PortalException,
SystemException
BaseStoreBaseStore.copyFileVersion(long,
long, String, String, String) except that the old file version is
deleted.
updateFileVersion in interface StoreupdateFileVersion in class BaseStorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's namefromVersionLabel - the file's version labeltoVersionLabel - the file's new version label
PortalException - if the file's information was invalid
SystemException - if a system exception occurredprotected void deleteEmptyAncestors(File file)
protected void deleteEmptyAncestors(long companyId,
long repositoryId,
File file)
protected File getCompanyDir(long companyId)
protected File getDirNameDir(long companyId,
long repositoryId,
String dirName)
protected File getFileNameDir(long companyId,
long repositoryId,
String fileName)
protected File getFileNameVersionFile(long companyId,
long repositoryId,
String fileName,
String version)
protected String getHeadVersionLabel(long companyId,
long repositoryId,
String fileName)
protected File getRepositoryDir(long companyId,
long repositoryId)
|
Liferay 6.2.0-ce-b3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||