com.liferay.portlet.documentlibrary.store.DLStoreUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portlet.documentlibrary.store;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.util.ReferenceRegistry;
import java.io.File;
import java.io.InputStream;
/**
* 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 {@link
* com.liferay.portlet.documentlibrary.model.DLFolderConstants#getDataRepositoryId(
* long,long)}. For all other portlets, the repositoryId should be
* set to {@link com.liferay.portal.model.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
* @author Alexander Chow
* @author Edward Han
* @see DLStoreImpl
*/
public class DLStoreUtil {
/**
* Adds a directory.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param dirName the directory's name
* @throws PortalException if the directory's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void addDirectory(
long companyId, long repositoryId, String dirName)
throws PortalException, SystemException {
getStore().addDirectory(companyId, repositoryId, dirName);
}
/**
* Adds a file based on a byte array.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param validateFileExtension whether to validate the file's extension
* @param bytes the files's data
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName,
boolean validateFileExtension, byte[] bytes)
throws PortalException, SystemException {
getStore().addFile(
companyId, repositoryId, fileName, validateFileExtension, bytes);
}
/**
* Adds a file based on a {@link File} object.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param validateFileExtension whether to validate the file's extension
* @param file Name the file name
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName,
boolean validateFileExtension, File file)
throws PortalException, SystemException {
getStore().addFile(
companyId, repositoryId, fileName, validateFileExtension, file);
}
/**
* Adds a file based on a {@link InputStream} object.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param validateFileExtension whether to validate the file's extension
* @param is the files's data
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName,
boolean validateFileExtension, InputStream is)
throws PortalException, SystemException {
getStore().addFile(
companyId, repositoryId, fileName, validateFileExtension, is);
}
/**
* Adds a file based on a byte array. Enforces validation of file's
* extension.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param bytes the files's data
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName, byte[] bytes)
throws PortalException, SystemException {
getStore().addFile(companyId, repositoryId, fileName, bytes);
}
/**
* Adds a file based on a {@link File} object. Enforces validation of file's
* extension.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param file Name the file name
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName, File file)
throws PortalException, SystemException {
getStore().addFile(companyId, repositoryId, fileName, file);
}
/**
* Adds a file based on an {@link InputStream} object. Enforces validation
* of file's extension.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param is the files's data
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void addFile(
long companyId, long repositoryId, String fileName, InputStream is)
throws PortalException, SystemException {
getStore().addFile(companyId, repositoryId, fileName, is);
}
/**
* Ensures company's root directory exists. Only implemented by {@link
* JCRStore#checkRoot(long)}.
*
* @param companyId the primary key of the company
* @throws SystemException if a system exception occurred
*/
public static void checkRoot(long companyId) throws SystemException {
getStore().checkRoot(companyId);
}
/**
* Creates a new copy of the file version.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the original's file name
* @param fromVersionLabel the original file's version label
* @param toVersionLabel the new version label
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void copyFileVersion(
long companyId, long repositoryId, String fileName,
String fromVersionLabel, String toVersionLabel)
throws PortalException, SystemException {
getStore().copyFileVersion(
companyId, repositoryId, fileName, fromVersionLabel,
toVersionLabel);
}
/**
* Deletes a directory.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param dirName the directory's name
* @throws PortalException if the directory's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void deleteDirectory(
long companyId, long repositoryId, String dirName)
throws PortalException, SystemException {
getStore().deleteDirectory(companyId, repositoryId, dirName);
}
/**
* Deletes a file. If a file has multiple versions, all versions will be
* deleted.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void deleteFile(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
getStore().deleteFile(companyId, repositoryId, fileName);
}
/**
* Deletes a file at a particular version.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param versionLabel the file's version label
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void deleteFile(
long companyId, long repositoryId, String fileName,
String versionLabel)
throws PortalException, SystemException {
getStore().deleteFile(companyId, repositoryId, fileName, versionLabel);
}
/**
* Returns the file as a {@link File} object.
*
*
* This method is useful when optimizing low-level file operations like
* copy. The client must not delete or change the returned {@link File}
* object in any way. This method is only supported in certain stores. If
* not supported, this method will throw an {@link
* UnsupportedOperationException}.
*
*
*
* If using an S3 store, it is preferable for performance reasons to use
* {@link #getFileAsStream(long, long, String)} instead of this method
* wherever possible.
*
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @return Returns the {@link File} object with the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static File getFile(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
return getStore().getFile(companyId, repositoryId, fileName);
}
/**
* Returns the file as a {@link File} object.
*
*
* This method is useful when optimizing low-level file operations like
* copy. The client must not delete or change the returned {@link File}
* object in any way. This method is only supported in certain stores. If
* not supported, this method will throw an {@link
* UnsupportedOperationException}.
*
*
*
* If using an S3 store, it is preferable for performance reasons to use
* {@link #getFileAsStream(long, long, String, String)} instead of this
* method wherever possible.
*
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param versionLabel the file's version label
* @return Returns the {@link File} object with the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static File getFile(
long companyId, long repositoryId, String fileName,
String versionLabel)
throws PortalException, SystemException {
return getStore().getFile(
companyId, repositoryId, fileName, versionLabel);
}
/**
* Returns the file as a byte array.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @return Returns the byte array with the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static byte[] getFileAsBytes(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
return getStore().getFileAsBytes(companyId, repositoryId, fileName);
}
/**
* Returns the file as a byte array.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param versionLabel the file's version label
* @return Returns the byte array with the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static byte[] getFileAsBytes(
long companyId, long repositoryId, String fileName,
String versionLabel)
throws PortalException, SystemException {
return getStore().getFileAsBytes(
companyId, repositoryId, fileName, versionLabel);
}
/**
* Returns the file as an {@link java.io.InputStream} object.
*
*
* If using an S3 store, it is preferable for performance reasons to use
* this method to get the file as an {@link java.io.InputStream} instead of
* using other methods to get the file as a {@link java.io.File}.
*
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @return Returns the {@link java.io.InputStream} object with the file's
* name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static InputStream getFileAsStream(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
return getStore().getFileAsStream(companyId, repositoryId, fileName);
}
/**
* Returns the file as an {@link java.io.InputStream} object.
*
*
* If using an S3 store, it is preferable for performance reasons to use
* this method to get the file as an {@link java.io.InputStream} instead of
* using other methods to get the file as a {@link java.io.File}.
*
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param versionLabel the file's version label
* @return Returns the {@link java.io.InputStream} object with the file's
* name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static InputStream getFileAsStream(
long companyId, long repositoryId, String fileName,
String versionLabel)
throws PortalException, SystemException {
return getStore().getFileAsStream(
companyId, repositoryId, fileName, versionLabel);
}
/**
* Returns all files of the directory.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param dirName the directory's name
* @return Returns all files of the directory
* @throws PortalException if the directory's information was invalid
* @throws SystemException if a system exception occurred
*/
public static String[] getFileNames(
long companyId, long repositoryId, String dirName)
throws PortalException, SystemException {
return getStore().getFileNames(companyId, repositoryId, dirName);
}
/**
* Returns the size of the file.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @return Returns the size of the file
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static long getFileSize(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
return getStore().getFileSize(companyId, repositoryId, fileName);
}
/**
* Returns the {@link DLStore} object. Used primarily by Spring and should
* not be used by the client.
*
* @return Returns the {@link DLStore} object
*/
public static DLStore getStore() {
if (_store == null) {
_store = (DLStore)PortalBeanLocatorUtil.locate(
DLStore.class.getName());
ReferenceRegistry.registerReference(DLStoreUtil.class, "_store");
}
return _store;
}
/**
* Returns true if the directory exists.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param dirName the directory's name
* @return true if the directory exists; false
* otherwise
* @throws PortalException if the directory's information was invalid
* @throws SystemException if a system exception occurred
*/
public static boolean hasDirectory(
long companyId, long repositoryId, String dirName)
throws PortalException, SystemException {
return getStore().hasDirectory(companyId, repositoryId, dirName);
}
/**
* Returns true if the file exists.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @return true if the file exists; false
* otherwise
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static boolean hasFile(
long companyId, long repositoryId, String fileName)
throws PortalException, SystemException {
return getStore().hasFile(companyId, repositoryId, fileName);
}
/**
* Returns true if the file exists.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param versionLabel the file's version label
* @return true if the file exists; false
* otherwise
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static boolean hasFile(
long companyId, long repositoryId, String fileName,
String versionLabel)
throws PortalException, SystemException {
return getStore().hasFile(
companyId, repositoryId, fileName, versionLabel);
}
/**
* Moves an existing directory. Only implemented by {@link
* JCRStore#move(String, String)}.
*
* @param srcDir the original directory's name
* @param destDir the new directory's name
* @throws SystemException if a system exception occurred
*/
public static void move(String srcDir, String destDir)
throws SystemException {
getStore().move(srcDir, destDir);
}
/**
* Moves a file to a new data repository.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository
* @param newRepositoryId the primary key of the new data repository
* @param fileName the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void updateFile(
long companyId, long repositoryId, long newRepositoryId,
String fileName)
throws PortalException, SystemException {
getStore().updateFile(
companyId, repositoryId, newRepositoryId, fileName);
}
/**
* Update's the file's name
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param newFileName the file's new name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void updateFile(
long companyId, long repositoryId, String fileName,
String newFileName)
throws PortalException, SystemException {
getStore().updateFile(companyId, repositoryId, fileName, newFileName);
}
/**
* Updates a file based on a {@link File} object.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param fileExtension the file's extension
* @param validateFileExtension whether to validate the file's extension
* @param versionLabel the file's new version label
* @param sourceFileName the new file's original name
* @param file Name the file name
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void updateFile(
long companyId, long repositoryId, String fileName,
String fileExtension, boolean validateFileExtension,
String versionLabel, String sourceFileName, File file)
throws PortalException, SystemException {
getStore().updateFile(
companyId, repositoryId, fileName, fileExtension,
validateFileExtension, versionLabel, sourceFileName, file);
}
/**
* Updates a file based on a {@link InputStream} object.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file name
* @param fileExtension the file's extension
* @param validateFileExtension whether to validate the file's extension
* @param versionLabel the file's new version label
* @param sourceFileName the new file's original name
* @param is the new file's data
* @throws PortalException if the file's information was invalid or is found
* to contain a virus
* @throws SystemException if a system exception occurred
*/
public static void updateFile(
long companyId, long repositoryId, String fileName,
String fileExtension, boolean validateFileExtension,
String versionLabel, String sourceFileName, InputStream is)
throws PortalException, SystemException {
getStore().updateFile(
companyId, repositoryId, fileName, fileExtension,
validateFileExtension, versionLabel, sourceFileName, is);
}
/**
* Update's a file version label. Similar to {@link #copyFileVersion(long,
* long, String, String, String)} except that the old file version is
* deleted.
*
* @param companyId the primary key of the company
* @param repositoryId the primary key of the data repository (optionally
* {@link com.liferay.portal.model.CompanyConstants#SYSTEM})
* @param fileName the file's name
* @param fromVersionLabel the file's version label
* @param toVersionLabel the file's new version label
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void updateFileVersion(
long companyId, long repositoryId, String fileName,
String fromVersionLabel, String toVersionLabel)
throws PortalException, SystemException {
getStore().updateFileVersion(
companyId, repositoryId, fileName, fromVersionLabel,
toVersionLabel);
}
/**
* Validates a file's name.
*
* @param fileName the file's name
* @param validateFileExtension whether to validate the file's extension
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(String fileName, boolean validateFileExtension)
throws PortalException, SystemException {
getStore().validate(fileName, validateFileExtension);
}
/**
* Validates a file's name and data.
*
* @param fileName the file's name
* @param validateFileExtension whether to validate the file's extension
* @param bytes the file's data (optionally null)
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(
String fileName, boolean validateFileExtension, byte[] bytes)
throws PortalException, SystemException {
getStore().validate(fileName, validateFileExtension, bytes);
}
/**
* Validates a file's name and data.
*
* @param fileName the file's name
* @param validateFileExtension whether to validate the file's extension
* @param file Name the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(
String fileName, boolean validateFileExtension, File file)
throws PortalException, SystemException {
getStore().validate(fileName, validateFileExtension, file);
}
/**
* Validates a file's name and data.
*
* @param fileName the file's name
* @param validateFileExtension whether to validate the file's extension
* @param is the file's data (optionally null)
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(
String fileName, boolean validateFileExtension, InputStream is)
throws PortalException, SystemException {
getStore().validate(fileName, validateFileExtension, is);
}
/**
* Validates a file's name and data.
*
* @param fileName the file's name
* @param fileExtension the file's extension
* @param sourceFileName the file's original name
* @param validateFileExtension whether to validate the file's extension
* @param file Name the file's name
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(
String fileName, String fileExtension, String sourceFileName,
boolean validateFileExtension, File file)
throws PortalException, SystemException {
getStore().validate(
fileName, fileExtension, sourceFileName, validateFileExtension,
file);
}
/**
* Validates a file's name and data.
*
* @param fileName the file's name
* @param fileExtension the file's extension
* @param sourceFileName the file's original name
* @param validateFileExtension whether to validate the file's extension
* @param is the file's data (optionally null)
* @throws PortalException if the file's information was invalid
* @throws SystemException if a system exception occurred
*/
public static void validate(
String fileName, String fileExtension, String sourceFileName,
boolean validateFileExtension, InputStream is)
throws PortalException, SystemException {
getStore().validate(
fileName, fileExtension, sourceFileName, validateFileExtension, is);
}
/**
* Set's the {@link DLStore} object. Used primarily by Spring and should not
* be used by the client.
*
* @param store the {@link DLStore} object
*/
public void setStore(DLStore store) {
_store = store;
ReferenceRegistry.registerReference(DLStoreUtil.class, "_store");
}
private static DLStore _store;
}