com.liferay.portlet.documentlibrary.util
Class DLPreviewableProcessor

java.lang.Object
  com.liferay.portlet.documentlibrary.util.DLPreviewableProcessor

All Implemented Interfaces:

DLProcessor

public abstract class DLPreviewableProcessor
extends java.lang.Object
implements DLProcessor

Author:

Alexander Chow, Ivica Cardic

Field Summary

protected java.util.Map<java.lang.String,java.util.concurrent.Future<?>>	futures
static java.lang.String	PREVIEW_PATH
static java.lang.String	PREVIEW_TMP_PATH
static long	REPOSITORY_ID
static int	THUMBNAIL_INDEX_CUSTOM_1
static int	THUMBNAIL_INDEX_CUSTOM_2
static int	THUMBNAIL_INDEX_DEFAULT
static java.lang.String	THUMBNAIL_PATH
static java.lang.String	THUMBNAIL_TMP_PATH

Constructor Summary

DLPreviewableProcessor()

Method Summary

protected void	addFileToStore(long companyId, java.lang.String dirName, java.lang.String filePath, java.io.File srcFile)
protected void	addFileToStore(long companyId, java.lang.String dirName, java.lang.String filePath, java.io.InputStream is)
void	cleanUp(FileEntry fileEntry)
void	cleanUp(FileVersion fileVersion)
void	copy(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
protected void	copyPreviews(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
protected void	copyThumbnails(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
static void	deleteFiles()
void	deleteFiles(FileEntry fileEntry, java.lang.String thumbnailType)
void	deleteFiles(FileVersion fileVersion, java.lang.String thumbnailType)
protected void	deleteFiles(long companyId, long groupId, long fileEntryId, long fileVersionId, java.lang.String thumbnailType)
protected void	deletePreviews(long companyId, long groupId, long fileEntryId, long fileVersionId)
protected void	deleteThumbnails(long companyId, long groupId, long fileEntryId, long fileVersionId, java.lang.String thumbnailType)
protected void	destroyProcess(java.lang.String processIdentity)
protected abstract void	doExportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
protected java.io.InputStream	doGetPreviewAsStream(FileVersion fileVersion, int index, java.lang.String type)
protected java.io.InputStream	doGetPreviewAsStream(FileVersion fileVersion, java.lang.String type)
protected int	doGetPreviewFileCount(FileVersion fileVersion)
protected long	doGetPreviewFileSize(FileVersion fileVersion, int index)
protected long	doGetPreviewFileSize(FileVersion fileVersion, int index, java.lang.String type)
protected long	doGetPreviewFileSize(FileVersion fileVersion, java.lang.String type)
protected java.io.InputStream	doGetThumbnailAsStream(FileVersion fileVersion, int index)
protected long	doGetThumbnailFileSize(FileVersion fileVersion, int index)
protected abstract void	doImportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement)
protected void	exportBinary(PortletDataContext portletDataContext, Element fileEntryElement, FileVersion fileVersion, java.io.InputStream is, java.lang.String binPath, java.lang.String binPathName)
void	exportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
protected void	exportPreview(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathSuffix, java.lang.String previewType)
protected void	exportPreview(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathSuffix, java.lang.String previewType, int fileIndex)
protected void	exportThumbnail(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathName, int index)
protected void	exportThumbnails(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathSuffix)
protected java.lang.String	getBinPath(PortletDataContext portletDataContext, FileEntry fileEntry, int index)
protected java.lang.String	getBinPath(PortletDataContext portletDataContext, FileEntry fileEntry, java.lang.String type)
protected abstract java.util.List<java.lang.Long>	getFileVersionIds()
protected static java.lang.String	getPathSegment(FileVersion fileVersion, boolean preview)
protected static java.lang.String	getPathSegment(long groupId, long fileEntryId, long fileVersionId, boolean preview)
protected java.lang.String	getPreviewFilePath(FileVersion fileVersion)
protected java.lang.String	getPreviewFilePath(FileVersion fileVersion, int index)
protected java.lang.String	getPreviewFilePath(FileVersion fileVersion, int index, java.lang.String type)
protected java.lang.String	getPreviewFilePath(FileVersion fileVersion, java.lang.String type)
protected java.lang.String	getPreviewFilePath(long groupId, long fileEntryId, long fileVersionId, int index, java.lang.String type)
protected java.lang.String	getPreviewFilePath(long groupId, long fileEntryId, long fileVersionId, java.lang.String type)
protected java.io.File	getPreviewTempFile(java.lang.String id)
protected java.io.File	getPreviewTempFile(java.lang.String id, int index)
protected java.io.File	getPreviewTempFile(java.lang.String id, int index, java.lang.String type)
protected java.io.File	getPreviewTempFile(java.lang.String id, java.lang.String type)
protected int	getPreviewTempFileCount(FileVersion fileVersion)
protected int	getPreviewTempFileCount(FileVersion fileVersion, java.lang.String type)
protected java.lang.String	getPreviewTempFilePath(java.lang.String id)
protected java.lang.String	getPreviewTempFilePath(java.lang.String id, int index)
protected java.lang.String	getPreviewTempFilePath(java.lang.String id, int index, java.lang.String type)
protected java.lang.String	getPreviewTempFilePath(java.lang.String id, java.lang.String type)
protected java.lang.String	getPreviewType()
protected abstract java.lang.String	getPreviewType(FileVersion fileVersion)
protected java.lang.String	getPreviewType(int index)
protected java.lang.String[]	getPreviewTypes()
protected java.lang.String	getThumbnailFilePath(FileVersion fileVersion, int index)
protected java.lang.String	getThumbnailFilePath(FileVersion fileVersion, java.lang.String type, int index)
protected java.io.File	getThumbnailTempFile(java.lang.String id)
protected java.io.File	getThumbnailTempFile(java.lang.String id, java.lang.String type)
protected java.lang.String	getThumbnailTempFilePath(java.lang.String id)
protected java.lang.String	getThumbnailTempFilePath(java.lang.String id, java.lang.String type)
protected java.lang.String	getThumbnailType()
protected abstract java.lang.String	getThumbnailType(FileVersion fileVersion)
protected boolean	hasPreview(FileVersion fileVersion, java.lang.String type)
protected boolean	hasPreviews(FileVersion fileVersion)
protected boolean	hasThumbnail(FileVersion fileVersion, int index)
protected boolean	hasThumbnails(FileVersion fileVersion)
void	importGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement)
protected void	importPreview(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement, java.lang.String binPathSuffix, java.lang.String previewType)
protected void	importPreview(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement, java.lang.String binPathSuffix, java.lang.String previewType, int fileIndex)
protected void	importPreviewFromLAR(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathSuffix, java.lang.String previewType, int fileIndex)
protected void	importThumbnail(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement, java.lang.String binPathName, int index)
protected void	importThumbnailFromLAR(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement, java.lang.String binPathName, int index)
protected void	importThumbnails(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement, java.lang.String binPathSuffix)
boolean	isSupported(FileVersion fileVersion)
protected boolean	isThumbnailEnabled(int index)
protected void	sendGenerationMessage(java.lang.String destinationName, FileVersion sourceFileVersion, FileVersion destinationFileVersion)
protected void	storeThumbnailImages(FileVersion fileVersion, java.io.File file)
protected void	storeThumbnailImages(FileVersion fileVersion, java.awt.image.RenderedImage renderedImage)
protected void	storeThumbnailmage(FileVersion fileVersion, java.awt.image.RenderedImage renderedImage, int index)
void	trigger(FileVersion sourceFileVersion, FileVersion destinationFileVersion) Launches the processor's work with respect to the given file version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portlet.documentlibrary.util.DLProcessor

afterPropertiesSet, isSupported

Field Detail

PREVIEW_PATH

public static final java.lang.String PREVIEW_PATH

See Also:

Constant Field Values

PREVIEW_TMP_PATH

public static final java.lang.String PREVIEW_TMP_PATH

REPOSITORY_ID

public static final long REPOSITORY_ID

See Also:

Constant Field Values

THUMBNAIL_INDEX_CUSTOM_1

public static final int THUMBNAIL_INDEX_CUSTOM_1

See Also:

Constant Field Values

THUMBNAIL_INDEX_CUSTOM_2

public static final int THUMBNAIL_INDEX_CUSTOM_2

See Also:

Constant Field Values

THUMBNAIL_INDEX_DEFAULT

public static final int THUMBNAIL_INDEX_DEFAULT

See Also:

Constant Field Values

THUMBNAIL_PATH

public static final java.lang.String THUMBNAIL_PATH

See Also:

Constant Field Values

THUMBNAIL_TMP_PATH

public static final java.lang.String THUMBNAIL_TMP_PATH

futures

protected java.util.Map<java.lang.String,java.util.concurrent.Future<?>> futures

Constructor Detail

DLPreviewableProcessor

public DLPreviewableProcessor()

Method Detail

deleteFiles

public static void deleteFiles()

cleanUp

public void cleanUp(FileEntry fileEntry)

Specified by:

cleanUp in interface DLProcessor

cleanUp

public void cleanUp(FileVersion fileVersion)

Specified by:

cleanUp in interface DLProcessor

copy

public void copy(FileVersion sourceFileVersion,
                 FileVersion destinationFileVersion)

Specified by:

copy in interface DLProcessor

deleteFiles

public void deleteFiles(FileEntry fileEntry,
                        java.lang.String thumbnailType)

deleteFiles

public void deleteFiles(FileVersion fileVersion,
                        java.lang.String thumbnailType)

exportGeneratedFiles

public void exportGeneratedFiles(PortletDataContext portletDataContext,
                                 FileEntry fileEntry,
                                 Element fileEntryElement)
                          throws java.lang.Exception

Specified by:

exportGeneratedFiles in interface DLProcessor

Throws:

java.lang.Exception

importGeneratedFiles

public void importGeneratedFiles(PortletDataContext portletDataContext,
                                 FileEntry fileEntry,
                                 FileEntry importedFileEntry,
                                 Element fileEntryElement)
                          throws java.lang.Exception

Specified by:

importGeneratedFiles in interface DLProcessor

Throws:

java.lang.Exception

isSupported

public boolean isSupported(FileVersion fileVersion)

Specified by:

isSupported in interface DLProcessor

trigger

public void trigger(FileVersion sourceFileVersion,
                    FileVersion destinationFileVersion)

Description copied from interface: DLProcessor

Launches the processor's work with respect to the given file version.

Specified by:

trigger in interface DLProcessor

Parameters:

sourceFileVersion - the file version to copy previews and thumbnails from (optionally null)

destinationFileVersion - the latest file version to process

getPathSegment

protected static java.lang.String getPathSegment(FileVersion fileVersion,
                                                 boolean preview)

getPathSegment

protected static java.lang.String getPathSegment(long groupId,
                                                 long fileEntryId,
                                                 long fileVersionId,
                                                 boolean preview)

addFileToStore

protected void addFileToStore(long companyId,
                              java.lang.String dirName,
                              java.lang.String filePath,
                              java.io.File srcFile)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addFileToStore

protected void addFileToStore(long companyId,
                              java.lang.String dirName,
                              java.lang.String filePath,
                              java.io.InputStream is)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

copyPreviews

protected void copyPreviews(FileVersion sourceFileVersion,
                            FileVersion destinationFileVersion)

copyThumbnails

protected void copyThumbnails(FileVersion sourceFileVersion,
                              FileVersion destinationFileVersion)

deleteFiles

protected void deleteFiles(long companyId,
                           long groupId,
                           long fileEntryId,
                           long fileVersionId,
                           java.lang.String thumbnailType)

deletePreviews

protected void deletePreviews(long companyId,
                              long groupId,
                              long fileEntryId,
                              long fileVersionId)

deleteThumbnails

protected void deleteThumbnails(long companyId,
                                long groupId,
                                long fileEntryId,
                                long fileVersionId,
                                java.lang.String thumbnailType)

destroyProcess

protected void destroyProcess(java.lang.String processIdentity)

doExportGeneratedFiles

protected abstract void doExportGeneratedFiles(PortletDataContext portletDataContext,
                                               FileEntry fileEntry,
                                               Element fileEntryElement)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

doGetPreviewAsStream

protected java.io.InputStream doGetPreviewAsStream(FileVersion fileVersion,
                                                   int index,
                                                   java.lang.String type)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

doGetPreviewAsStream

protected java.io.InputStream doGetPreviewAsStream(FileVersion fileVersion,
                                                   java.lang.String type)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

doGetPreviewFileCount

protected int doGetPreviewFileCount(FileVersion fileVersion)
                             throws java.lang.Exception

Throws:

java.lang.Exception

doGetPreviewFileSize

protected long doGetPreviewFileSize(FileVersion fileVersion,
                                    int index)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

doGetPreviewFileSize

protected long doGetPreviewFileSize(FileVersion fileVersion,
                                    int index,
                                    java.lang.String type)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

doGetPreviewFileSize

protected long doGetPreviewFileSize(FileVersion fileVersion,
                                    java.lang.String type)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

doGetThumbnailAsStream

protected java.io.InputStream doGetThumbnailAsStream(FileVersion fileVersion,
                                                     int index)
                                              throws PortalException,
                                                     SystemException

Throws:

PortalException

SystemException

doGetThumbnailFileSize

protected long doGetThumbnailFileSize(FileVersion fileVersion,
                                      int index)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

doImportGeneratedFiles

protected abstract void doImportGeneratedFiles(PortletDataContext portletDataContext,
                                               FileEntry fileEntry,
                                               FileEntry importedFileEntry,
                                               Element fileEntryElement)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

exportBinary

protected void exportBinary(PortletDataContext portletDataContext,
                            Element fileEntryElement,
                            FileVersion fileVersion,
                            java.io.InputStream is,
                            java.lang.String binPath,
                            java.lang.String binPathName)
                     throws SystemException

Throws:

SystemException

exportPreview

protected void exportPreview(PortletDataContext portletDataContext,
                             FileEntry fileEntry,
                             Element fileEntryElement,
                             java.lang.String binPathSuffix,
                             java.lang.String previewType)
                      throws java.lang.Exception

Throws:

java.lang.Exception

exportPreview

protected void exportPreview(PortletDataContext portletDataContext,
                             FileEntry fileEntry,
                             Element fileEntryElement,
                             java.lang.String binPathSuffix,
                             java.lang.String previewType,
                             int fileIndex)
                      throws java.lang.Exception

Throws:

java.lang.Exception

exportThumbnail

protected void exportThumbnail(PortletDataContext portletDataContext,
                               FileEntry fileEntry,
                               Element fileEntryElement,
                               java.lang.String binPathName,
                               int index)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

exportThumbnails

protected void exportThumbnails(PortletDataContext portletDataContext,
                                FileEntry fileEntry,
                                Element fileEntryElement,
                                java.lang.String binPathSuffix)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getBinPath

protected java.lang.String getBinPath(PortletDataContext portletDataContext,
                                      FileEntry fileEntry,
                                      int index)

getBinPath

protected java.lang.String getBinPath(PortletDataContext portletDataContext,
                                      FileEntry fileEntry,
                                      java.lang.String type)

getFileVersionIds

protected abstract java.util.List<java.lang.Long> getFileVersionIds()

getPreviewFilePath

protected java.lang.String getPreviewFilePath(FileVersion fileVersion)

getPreviewFilePath

protected java.lang.String getPreviewFilePath(FileVersion fileVersion,
                                              int index)

getPreviewFilePath

protected java.lang.String getPreviewFilePath(FileVersion fileVersion,
                                              int index,
                                              java.lang.String type)

getPreviewFilePath

protected java.lang.String getPreviewFilePath(FileVersion fileVersion,
                                              java.lang.String type)

getPreviewFilePath

protected java.lang.String getPreviewFilePath(long groupId,
                                              long fileEntryId,
                                              long fileVersionId,
                                              int index,
                                              java.lang.String type)

getPreviewFilePath

protected java.lang.String getPreviewFilePath(long groupId,
                                              long fileEntryId,
                                              long fileVersionId,
                                              java.lang.String type)

getPreviewTempFile

protected java.io.File getPreviewTempFile(java.lang.String id)

getPreviewTempFile

protected java.io.File getPreviewTempFile(java.lang.String id,
                                          int index)

getPreviewTempFile

protected java.io.File getPreviewTempFile(java.lang.String id,
                                          int index,
                                          java.lang.String type)

getPreviewTempFile

protected java.io.File getPreviewTempFile(java.lang.String id,
                                          java.lang.String type)

getPreviewTempFileCount

protected int getPreviewTempFileCount(FileVersion fileVersion)

getPreviewTempFileCount

protected int getPreviewTempFileCount(FileVersion fileVersion,
                                      java.lang.String type)

getPreviewTempFilePath

protected java.lang.String getPreviewTempFilePath(java.lang.String id)

getPreviewTempFilePath

protected java.lang.String getPreviewTempFilePath(java.lang.String id,
                                                  int index)

getPreviewTempFilePath

protected java.lang.String getPreviewTempFilePath(java.lang.String id,
                                                  int index,
                                                  java.lang.String type)

getPreviewTempFilePath

protected java.lang.String getPreviewTempFilePath(java.lang.String id,
                                                  java.lang.String type)

getPreviewType

protected java.lang.String getPreviewType()

getPreviewType

protected abstract java.lang.String getPreviewType(FileVersion fileVersion)

getPreviewType

protected java.lang.String getPreviewType(int index)

getPreviewTypes

protected java.lang.String[] getPreviewTypes()

getThumbnailFilePath

protected java.lang.String getThumbnailFilePath(FileVersion fileVersion,
                                                int index)

getThumbnailFilePath

protected java.lang.String getThumbnailFilePath(FileVersion fileVersion,
                                                java.lang.String type,
                                                int index)

getThumbnailTempFile

protected java.io.File getThumbnailTempFile(java.lang.String id)

getThumbnailTempFile

protected java.io.File getThumbnailTempFile(java.lang.String id,
                                            java.lang.String type)

getThumbnailTempFilePath

protected java.lang.String getThumbnailTempFilePath(java.lang.String id)

getThumbnailTempFilePath

protected java.lang.String getThumbnailTempFilePath(java.lang.String id,
                                                    java.lang.String type)

getThumbnailType

protected java.lang.String getThumbnailType()

getThumbnailType

protected abstract java.lang.String getThumbnailType(FileVersion fileVersion)

hasPreview

protected boolean hasPreview(FileVersion fileVersion,
                             java.lang.String type)
                      throws java.lang.Exception

Throws:

java.lang.Exception

hasPreviews

protected boolean hasPreviews(FileVersion fileVersion)
                       throws java.lang.Exception

Throws:

java.lang.Exception

hasThumbnail

protected boolean hasThumbnail(FileVersion fileVersion,
                               int index)

hasThumbnails

protected boolean hasThumbnails(FileVersion fileVersion)

importPreview

protected void importPreview(PortletDataContext portletDataContext,
                             FileEntry fileEntry,
                             FileEntry importedFileEntry,
                             Element fileEntryElement,
                             java.lang.String binPathSuffix,
                             java.lang.String previewType)
                      throws java.lang.Exception

Throws:

java.lang.Exception

importPreview

protected void importPreview(PortletDataContext portletDataContext,
                             FileEntry fileEntry,
                             FileEntry importedFileEntry,
                             Element fileEntryElement,
                             java.lang.String binPathSuffix,
                             java.lang.String previewType,
                             int fileIndex)
                      throws java.lang.Exception

Throws:

java.lang.Exception

importPreviewFromLAR

protected void importPreviewFromLAR(PortletDataContext portletDataContext,
                                    FileEntry fileEntry,
                                    Element fileEntryElement,
                                    java.lang.String binPathSuffix,
                                    java.lang.String previewType,
                                    int fileIndex)
                             throws java.lang.Exception

Throws:

java.lang.Exception

importThumbnail

protected void importThumbnail(PortletDataContext portletDataContext,
                               FileEntry fileEntry,
                               FileEntry importedFileEntry,
                               Element fileEntryElement,
                               java.lang.String binPathName,
                               int index)
                        throws java.lang.Exception

Throws:

java.lang.Exception

importThumbnailFromLAR

protected void importThumbnailFromLAR(PortletDataContext portletDataContext,
                                      FileEntry fileEntry,
                                      Element fileEntryElement,
                                      java.lang.String binPathName,
                                      int index)
                               throws java.lang.Exception

Throws:

java.lang.Exception

importThumbnails

protected void importThumbnails(PortletDataContext portletDataContext,
                                FileEntry fileEntry,
                                FileEntry importedFileEntry,
                                Element fileEntryElement,
                                java.lang.String binPathSuffix)
                         throws java.lang.Exception

Throws:

java.lang.Exception

isThumbnailEnabled

protected boolean isThumbnailEnabled(int index)
                              throws java.lang.Exception

Throws:

java.lang.Exception

sendGenerationMessage

protected void sendGenerationMessage(java.lang.String destinationName,
                                     FileVersion sourceFileVersion,
                                     FileVersion destinationFileVersion)

storeThumbnailImages

protected void storeThumbnailImages(FileVersion fileVersion,
                                    java.io.File file)
                             throws java.lang.Exception

Throws:

java.lang.Exception

storeThumbnailImages

protected void storeThumbnailImages(FileVersion fileVersion,
                                    java.awt.image.RenderedImage renderedImage)
                             throws java.lang.Exception

Throws:

java.lang.Exception

storeThumbnailmage

protected void storeThumbnailmage(FileVersion fileVersion,
                                  java.awt.image.RenderedImage renderedImage,
                                  int index)
                           throws java.lang.Exception

Throws:

java.lang.Exception