com.liferay.document.library.kernel.store

Class DLStoreUtil

java.lang.Object

com.liferay.document.library.kernel.store.DLStoreUtil

public class DLStoreUtil
extends java.lang.Object

Provides methods for storing files in the portal. The file storage implementation can be selected in portal.properties under the property dl.store.impl. Virus checking can also be enabled under the property dl.store.antivirus.impl.

The main client for this class is the Document Library portlet. It is also used by other portlets like Wiki and Message Boards to store file attachments. For the Document Library portlet, the repositoryId can be obtained by calling com.liferay.portlet.documentlibrary.model.DLFolderConstants#getDataRepositoryId( long,long). For all other portlets, the repositoryId should be set to CompanyConstants.SYSTEM. These methods can be used in plugins and other portlets, as shown below.

 
 long repositoryId = CompanyConstants.SYSTEM;
 String dirName = "portlet_name/1234";

 try {
 DLStoreUtil.addDirectory(companyId, repositoryId, dirName);
 }
 catch (DuplicateDirectoryException dde) {
 }

 DLStoreUtil.addFile(
 companyId, repositoryId, dirName + "/" + fileName, file);
 
 

Author:

Brian Wing Shun Chan, Alexander Chow, Edward Han

See Also:

DLStoreImpl

Constructor Summary

Constructors

Constructor and Description
DLStoreUtil()

Method Summary

Modifier and Type	Method and Description
static void	addDirectory(long companyId, long repositoryId, java.lang.String dirName) Adds a directory.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, boolean validateFileExtension, byte[] bytes) Adds a file based on a byte array.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, boolean validateFileExtension, java.io.File file) Adds a file based on a File object.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, boolean validateFileExtension, java.io.InputStream is) Adds a file based on a InputStream object.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, byte[] bytes) Adds a file based on a byte array.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, java.io.File file) Adds a file based on a File object.
static void	addFile(long companyId, long repositoryId, java.lang.String fileName, java.io.InputStream is) Adds a file based on an InputStream object.
static void	checkRoot(long companyId) Ensures company's root directory exists.
static void	copyFileVersion(long companyId, long repositoryId, java.lang.String fileName, java.lang.String fromVersionLabel, java.lang.String toVersionLabel) Creates a new copy of the file version.
static void	deleteDirectory(long companyId, long repositoryId, java.lang.String dirName) Deletes a directory.
static void	deleteFile(long companyId, long repositoryId, java.lang.String fileName) Deletes a file.
static void	deleteFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Deletes a file at a particular version.
static java.io.File	getFile(long companyId, long repositoryId, java.lang.String fileName) Returns the file as a File object.
static java.io.File	getFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns the file as a File object.
static byte[]	getFileAsBytes(long companyId, long repositoryId, java.lang.String fileName) Returns the file as a byte array.
static byte[]	getFileAsBytes(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns the file as a byte array.
static java.io.InputStream	getFileAsStream(long companyId, long repositoryId, java.lang.String fileName) Returns the file as an InputStream object.
static java.io.InputStream	getFileAsStream(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns the file as an InputStream object.
static java.lang.String[]	getFileNames(long companyId, long repositoryId, java.lang.String dirName) Returns all files of the directory.
static long	getFileSize(long companyId, long repositoryId, java.lang.String fileName) Returns the size of the file.
static DLStore	getStore() Returns the DLStore object.
static boolean	hasDirectory(long companyId, long repositoryId, java.lang.String dirName) Returns true if the directory exists.
static boolean	hasFile(long companyId, long repositoryId, java.lang.String fileName) Returns true if the file exists.
static boolean	hasFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns true if the file exists.
static boolean	isValidName(java.lang.String name)
static void	move(java.lang.String srcDir, java.lang.String destDir) Moves an existing directory.
void	setStore(DLStore store) Set's the DLStore object.
static void	updateFile(long companyId, long repositoryId, long newRepositoryId, java.lang.String fileName) Moves a file to a new data repository.
static void	updateFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String newFileName) Update's the file's name
static void	updateFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String fileExtension, boolean validateFileExtension, java.lang.String versionLabel, java.lang.String sourceFileName, java.io.File file) Updates a file based on a File object.
static void	updateFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String fileExtension, boolean validateFileExtension, java.lang.String versionLabel, java.lang.String sourceFileName, java.io.InputStream is) Updates a file based on a InputStream object.
static void	updateFileVersion(long companyId, long repositoryId, java.lang.String fileName, java.lang.String fromVersionLabel, java.lang.String toVersionLabel) Update's a file version label.
static void	validate(java.lang.String fileName, boolean validateFileExtension) Validates a file's name.
static void	validate(java.lang.String fileName, boolean validateFileExtension, byte[] bytes) Validates a file's name and data.
static void	validate(java.lang.String fileName, boolean validateFileExtension, java.io.File file) Validates a file's name and data.
static void	validate(java.lang.String fileName, boolean validateFileExtension, java.io.InputStream is) Validates a file's name and data.
static void	validate(java.lang.String fileName, java.lang.String fileExtension, java.lang.String sourceFileName, boolean validateFileExtension)
static void	validate(java.lang.String fileName, java.lang.String fileExtension, java.lang.String sourceFileName, boolean validateFileExtension, java.io.File file) Validates a file's name and data.
static void	validate(java.lang.String fileName, java.lang.String fileExtension, java.lang.String sourceFileName, boolean validateFileExtension, java.io.InputStream is) Validates a file's name and data.
static void	validateDirectoryName(java.lang.String directoryName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLStoreUtil

public DLStoreUtil()

Method Detail

addDirectory

public static void addDirectory(long companyId,
                                long repositoryId,
                                java.lang.String dirName)
                         throws PortalException

Adds a directory.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           boolean validateFileExtension,
                           byte[] bytes)
                    throws PortalException

Adds a file based on a byte array.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

validateFileExtension - whether to validate the file's extension

bytes - the files's data

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           boolean validateFileExtension,
                           java.io.File file)
                    throws PortalException

Adds a file based on a File object.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

validateFileExtension - whether to validate the file's extension

file - Name the file name

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           boolean validateFileExtension,
                           java.io.InputStream is)
                    throws PortalException

Adds a file based on a InputStream object.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

validateFileExtension - whether to validate the file's extension

is - the files's data

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           byte[] bytes)
                    throws PortalException

Adds a file based on a byte array. Enforces validation of file's extension.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

bytes - the files's data

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           java.io.File file)
                    throws PortalException

Adds a file based on a File object. Enforces validation of file's extension.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

file - Name the file name

Throws:

PortalException

addFile

public static void addFile(long companyId,
                           long repositoryId,
                           java.lang.String fileName,
                           java.io.InputStream is)
                    throws PortalException

Adds a file based on an InputStream object. Enforces validation of file's extension.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

is - the files's data

Throws:

PortalException

checkRoot

public static void checkRoot(long companyId)

Ensures company's root directory exists. Only implemented by JCRStore#checkRoot(long).

Parameters:

companyId - the primary key of the company

copyFileVersion

public static void copyFileVersion(long companyId,
                                   long repositoryId,
                                   java.lang.String fileName,
                                   java.lang.String fromVersionLabel,
                                   java.lang.String toVersionLabel)
                            throws PortalException

Creates a new copy of the file version.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the original's file name

fromVersionLabel - the original file's version label

toVersionLabel - the new version label

Throws:

PortalException

deleteDirectory

public static void deleteDirectory(long companyId,
                                   long repositoryId,
                                   java.lang.String dirName)

Deletes a directory.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

deleteFile

public static void deleteFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName)
                       throws PortalException

Deletes a file. If a file has multiple versions, all versions will be deleted.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Throws:

PortalException

deleteFile

public static void deleteFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName,
                              java.lang.String versionLabel)
                       throws PortalException

Deletes a file at a particular version.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Throws:

PortalException

getFile

public static java.io.File getFile(long companyId,
                                   long repositoryId,
                                   java.lang.String fileName)
                            throws PortalException

Returns the file as a 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.

If using an S3 store, it is preferable for performance reasons to use getFileAsStream(long, long, String) instead of this method wherever possible.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

Returns the File object with the file's name

Throws:

PortalException

getFile

public static java.io.File getFile(long companyId,
                                   long repositoryId,
                                   java.lang.String fileName,
                                   java.lang.String versionLabel)
                            throws PortalException

Returns the file as a 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.

If using an S3 store, it is preferable for performance reasons to use getFileAsStream(long, long, String, String) instead of this method wherever possible.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

Returns the File object with the file's name

Throws:

PortalException

getFileAsBytes

public static byte[] getFileAsBytes(long companyId,
                                    long repositoryId,
                                    java.lang.String fileName)
                             throws PortalException

Returns the file as a byte array.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

Returns the byte array with the file's name

Throws:

PortalException

getFileAsBytes

public static byte[] getFileAsBytes(long companyId,
                                    long repositoryId,
                                    java.lang.String fileName,
                                    java.lang.String versionLabel)
                             throws PortalException

Returns the file as a byte array.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

Returns the byte array with the file's name

Throws:

PortalException

getFileAsStream

public static java.io.InputStream getFileAsStream(long companyId,
                                                  long repositoryId,
                                                  java.lang.String fileName)
                                           throws PortalException

Returns the file as an InputStream object.

If using an S3 store, it is preferable for performance reasons to use this method to get the file as an InputStream instead of using other methods to get the file as a File.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

Returns the InputStream object with the file's name

Throws:

PortalException

getFileAsStream

public static java.io.InputStream getFileAsStream(long companyId,
                                                  long repositoryId,
                                                  java.lang.String fileName,
                                                  java.lang.String versionLabel)
                                           throws PortalException

Returns the file as an InputStream object.

If using an S3 store, it is preferable for performance reasons to use this method to get the file as an InputStream instead of using other methods to get the file as a File.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

Returns the InputStream object with the file's name

Throws:

PortalException

getFileNames

public static java.lang.String[] getFileNames(long companyId,
                                              long repositoryId,
                                              java.lang.String dirName)
                                       throws PortalException

Returns all files of the directory.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

Returns:

Returns all files of the directory

Throws:

PortalException

getFileSize

public static long getFileSize(long companyId,
                               long repositoryId,
                               java.lang.String fileName)
                        throws PortalException

Returns the size of the file.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

Returns the size of the file

Throws:

PortalException

getStore

public static DLStore getStore()

Returns the DLStore object. Used primarily by Spring and should not be used by the client.

Returns:

Returns the DLStore object

hasDirectory

public static boolean hasDirectory(long companyId,
                                   long repositoryId,
                                   java.lang.String dirName)
                            throws PortalException

Returns true if the directory exists.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

Returns:

true if the directory exists; false otherwise

Throws:

PortalException

hasFile

public static boolean hasFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName)
                       throws PortalException

Returns true if the file exists.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

true if the file exists; false otherwise

Throws:

PortalException

hasFile

public static boolean hasFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName,
                              java.lang.String versionLabel)
                       throws PortalException

Returns true if the file exists.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

true if the file exists; false otherwise

Throws:

PortalException

isValidName

public static boolean isValidName(java.lang.String name)

move

public static void move(java.lang.String srcDir,
                        java.lang.String destDir)

Moves an existing directory. Only implemented by JCRStore#move(String, String).

Parameters:

srcDir - the original directory's name

destDir - the new directory's name

updateFile

public static void updateFile(long companyId,
                              long repositoryId,
                              long newRepositoryId,
                              java.lang.String fileName)
                       throws PortalException

Moves a file to a new data repository.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository

newRepositoryId - the primary key of the new data repository

fileName - the file's name

Throws:

PortalException

updateFile

public static void updateFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName,
                              java.lang.String newFileName)
                       throws PortalException

Update's the file's name

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

newFileName - the file's new name

Throws:

PortalException

updateFile

public static void updateFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName,
                              java.lang.String fileExtension,
                              boolean validateFileExtension,
                              java.lang.String versionLabel,
                              java.lang.String sourceFileName,
                              java.io.File file)
                       throws PortalException

Updates a file based on a File object.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

fileExtension - the file's extension

validateFileExtension - whether to validate the file's extension

versionLabel - the file's new version label

sourceFileName - the new file's original name

file - Name the file name

Throws:

PortalException

updateFile

public static void updateFile(long companyId,
                              long repositoryId,
                              java.lang.String fileName,
                              java.lang.String fileExtension,
                              boolean validateFileExtension,
                              java.lang.String versionLabel,
                              java.lang.String sourceFileName,
                              java.io.InputStream is)
                       throws PortalException

Updates a file based on a InputStream object.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

fileExtension - the file's extension

validateFileExtension - whether to validate the file's extension

versionLabel - the file's new version label

sourceFileName - the new file's original name

is - the new file's data

Throws:

PortalException

updateFileVersion

public static void updateFileVersion(long companyId,
                                     long repositoryId,
                                     java.lang.String fileName,
                                     java.lang.String fromVersionLabel,
                                     java.lang.String toVersionLabel)
                              throws PortalException

Update's a file version label. Similar to copyFileVersion(long, long, String, String, String) except that the old file version is deleted.

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

fromVersionLabel - the file's version label

toVersionLabel - the file's new version label

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            boolean validateFileExtension)
                     throws PortalException

Validates a file's name.

Parameters:

fileName - the file's name

validateFileExtension - whether to validate the file's extension

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            boolean validateFileExtension,
                            byte[] bytes)
                     throws PortalException

Validates a file's name and data.

Parameters:

fileName - the file's name

validateFileExtension - whether to validate the file's extension

bytes - the file's data (optionally null)

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            boolean validateFileExtension,
                            java.io.File file)
                     throws PortalException

Validates a file's name and data.

Parameters:

fileName - the file's name

validateFileExtension - whether to validate the file's extension

file - Name the file's name

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            boolean validateFileExtension,
                            java.io.InputStream is)
                     throws PortalException

Validates a file's name and data.

Parameters:

fileName - the file's name

validateFileExtension - whether to validate the file's extension

is - the file's data (optionally null)

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            java.lang.String fileExtension,
                            java.lang.String sourceFileName,
                            boolean validateFileExtension)
                     throws PortalException

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            java.lang.String fileExtension,
                            java.lang.String sourceFileName,
                            boolean validateFileExtension,
                            java.io.File file)
                     throws PortalException

Validates a file's name and data.

Parameters:

fileName - the file's name

fileExtension - the file's extension

sourceFileName - the file's original name

validateFileExtension - whether to validate the file's extension

file - Name the file's name

Throws:

PortalException

validate

public static void validate(java.lang.String fileName,
                            java.lang.String fileExtension,
                            java.lang.String sourceFileName,
                            boolean validateFileExtension,
                            java.io.InputStream is)
                     throws PortalException

Validates a file's name and data.

Parameters:

fileName - the file's name

fileExtension - the file's extension

sourceFileName - the file's original name

validateFileExtension - whether to validate the file's extension

is - the file's data (optionally null)

Throws:

PortalException

validateDirectoryName

public static void validateDirectoryName(java.lang.String directoryName)
                                  throws PortalException

Throws:

PortalException

setStore

public void setStore(DLStore store)

Set's the DLStore object. Used primarily by Spring and should not be used by the client.

Parameters:

store - the DLStore object