VERSION_DEFAULT| Constructor and Description |
|---|
BaseStore() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
addDirectory(long companyId,
long repositoryId,
String dirName)
Adds a directory.
|
void |
addFile(long companyId,
long repositoryId,
String fileName,
byte[] bytes)
Adds a file based on a byte array.
|
void |
addFile(long companyId,
long repositoryId,
String fileName,
File file)
Adds a file based on a
File object. |
abstract void |
addFile(long companyId,
long repositoryId,
String fileName,
InputStream is)
Adds a file based on an
InputStream object. |
abstract void |
checkRoot(long companyId)
Deprecated.
As of Mueller (7.2.x), with no direct replacement
|
void |
copyFileToStore(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Store targetStore) |
void |
copyFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
Creates a new copy of the file version.
|
abstract void |
deleteDirectory(long companyId,
long repositoryId,
String dirName)
Deletes a directory.
|
abstract void |
deleteFile(long companyId,
long repositoryId,
String fileName)
Deletes a file.
|
abstract void |
deleteFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Deletes a file at a particular version.
|
File |
getFile(long companyId,
long repositoryId,
String fileName)
Returns the file as a
File object. |
File |
getFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns the file as a
File object. |
byte[] |
getFileAsBytes(long companyId,
long repositoryId,
String fileName)
Returns the file as a byte array.
|
byte[] |
getFileAsBytes(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns the file as a byte array.
|
InputStream |
getFileAsStream(long companyId,
long repositoryId,
String fileName)
Returns the file as an
InputStream object. |
abstract InputStream |
getFileAsStream(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns the file as an
InputStream object. |
abstract String[] |
getFileNames(long companyId,
long repositoryId,
String dirName)
Returns all files of the directory.
|
abstract long |
getFileSize(long companyId,
long repositoryId,
String fileName)
Returns the size of the file.
|
abstract boolean |
hasDirectory(long companyId,
long repositoryId,
String dirName)
Returns
true if the directory exists. |
boolean |
hasFile(long companyId,
long repositoryId,
String fileName)
Returns
true if the file exists. |
abstract boolean |
hasFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
Returns
true if the file exists. |
protected void |
logFailedDeletion(long companyId,
long repositoryId,
String fileName) |
protected void |
logFailedDeletion(long companyId,
long repositoryId,
String fileName,
Exception exception) |
protected void |
logFailedDeletion(long companyId,
long repositoryId,
String fileName,
String versionLabel) |
protected void |
logFailedDeletion(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Exception cause) |
void |
move(String srcDir,
String destDir)
Deprecated.
As of Mueller (7.2.x), with no direct replacement
|
void |
moveFileToStore(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Store targetStore) |
abstract 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 versionLabel,
byte[] bytes)
Updates a file based on a byte array.
|
void |
updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
File file)
Updates a file based on a
File object. |
abstract 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFileNames, updateFilepublic abstract void addDirectory(long companyId,
long repositoryId,
String dirName)
addDirectory in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's namepublic void addFile(long companyId,
long repositoryId,
String fileName,
byte[] bytes)
throws PortalException
addFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file namebytes - the files's dataPortalExceptionpublic void addFile(long companyId,
long repositoryId,
String fileName,
File file)
throws PortalException
File object.addFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file namefile - Name the file namePortalExceptionpublic abstract void addFile(long companyId,
long repositoryId,
String fileName,
InputStream is)
throws PortalException
InputStream object.addFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file nameis - the files's dataPortalException@Deprecated public abstract void checkRoot(long companyId)
public void copyFileToStore(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Store targetStore)
copyFileToStore in interface Storepublic void copyFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
throws PortalException
This method should be overrided if a more optimized approach can be used
(e.g., FileSystemStore#copyFileVersion(long, long, String, String,
String)).
copyFileVersion in interface StorecompanyId - 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 labelPortalExceptionpublic abstract void deleteDirectory(long companyId,
long repositoryId,
String dirName)
deleteDirectory in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's namepublic abstract void deleteFile(long companyId,
long repositoryId,
String fileName)
deleteFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's namepublic abstract void deleteFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
deleteFile in interface StorecompanyId - 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 labelpublic File getFile(long companyId,
long repositoryId,
String fileName)
throws PortalException
File 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.
getFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameFile object with the file's namePortalExceptionpublic File getFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
File 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., FileSystemStore#getFile(long, long, String, String)).
getFile in interface StorecompanyId - 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 labelFile object with the file's namePortalExceptionpublic byte[] getFileAsBytes(long companyId,
long repositoryId,
String fileName)
throws PortalException
getFileAsBytes in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's namePortalExceptionpublic byte[] getFileAsBytes(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
getFileAsBytes in interface StorecompanyId - 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 labelPortalExceptionpublic InputStream getFileAsStream(long companyId,
long repositoryId,
String fileName)
throws PortalException
InputStream object.getFileAsStream in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nameInputStream object with the file's namePortalExceptionpublic abstract InputStream getFileAsStream(long companyId,
long repositoryId,
String fileName,
String versionLabel)
throws PortalException
InputStream object.getFileAsStream in interface StorecompanyId - 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 labelInputStream object with the file's namePortalExceptionpublic abstract String[] getFileNames(long companyId,
long repositoryId,
String dirName)
getFileNames in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's namepublic abstract long getFileSize(long companyId,
long repositoryId,
String fileName)
throws PortalException
getFileSize in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's namePortalExceptionpublic abstract boolean hasDirectory(long companyId,
long repositoryId,
String dirName)
true if the directory exists.hasDirectory in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)dirName - the directory's nametrue if the directory exists; false
otherwisepublic boolean hasFile(long companyId,
long repositoryId,
String fileName)
true if the file exists.hasFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repository (optionally
CompanyConstants.SYSTEM)fileName - the file's nametrue if the file exists; false
otherwisepublic abstract boolean hasFile(long companyId,
long repositoryId,
String fileName,
String versionLabel)
true if the file exists.hasFile in interface StorecompanyId - 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 labeltrue if the file exists; false
otherwise@Deprecated
public void move(String srcDir,
String destDir)
public void moveFileToStore(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Store targetStore)
moveFileToStore in interface Storepublic abstract void updateFile(long companyId,
long repositoryId,
long newRepositoryId,
String fileName)
throws PortalException
updateFile in interface StorecompanyId - the primary key of the companyrepositoryId - the primary key of the data repositorynewRepositoryId - the primary key of the new data repositoryfileName - the file's namePortalExceptionpublic void updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
byte[] bytes)
throws PortalException
updateFile in interface StorecompanyId - 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 labelbytes - the new file's dataPortalExceptionpublic void updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
File file)
throws PortalException
File object.updateFile in interface StorecompanyId - 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 labelfile - Name the file namePortalExceptionpublic abstract void updateFile(long companyId,
long repositoryId,
String fileName,
String versionLabel,
InputStream is)
throws PortalException
InputStream object.updateFile in interface StorecompanyId - 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 dataPortalExceptionpublic void updateFileVersion(long companyId,
long repositoryId,
String fileName,
String fromVersionLabel,
String toVersionLabel)
throws PortalException
copyFileVersion(long,
long, String, String, String) except that the old file version is
deleted.updateFileVersion in interface StorecompanyId - 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 labelPortalExceptionprotected void logFailedDeletion(long companyId,
long repositoryId,
String fileName)
protected void logFailedDeletion(long companyId,
long repositoryId,
String fileName,
Exception exception)
protected void logFailedDeletion(long companyId,
long repositoryId,
String fileName,
String versionLabel)
protected void logFailedDeletion(long companyId,
long repositoryId,
String fileName,
String versionLabel,
Exception cause)