com.liferay.portlet.documentlibrary.util

Class ImageProcessorImpl

java.lang.Object

com.liferay.document.library.kernel.util.DLPreviewableProcessor

com.liferay.portlet.documentlibrary.util.ImageProcessorImpl

All Implemented Interfaces:

DLProcessor, ImageProcessor

public class ImageProcessorImpl
extends DLPreviewableProcessor
implements ImageProcessor

Field Summary

Fields inherited from class com.liferay.document.library.kernel.util.DLPreviewableProcessor

DECRYPT_PATH, DECRYPT_TMP_PATH, futures, PREVIEW_PATH, PREVIEW_TMP_PATH, REPOSITORY_ID, THUMBNAIL_INDEX_CUSTOM_1, THUMBNAIL_INDEX_CUSTOM_2, THUMBNAIL_INDEX_DEFAULT, THUMBNAIL_PATH, THUMBNAIL_TMP_PATH, TMP_PATH

Constructor Summary

Constructors

Constructor and Description
ImageProcessorImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	cleanUp(FileEntry fileEntry) Cleans up any resources that the processor created for the file entry.
void	cleanUp(FileVersion fileVersion) Cleans up any resources that the processor created for the given file version.
protected void	doExportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
protected void	doImportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement)
protected void	exportPreview(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
void	generateImages(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
protected java.util.List<java.lang.Long>	getFileVersionIds()
java.util.Set<java.lang.String>	getImageMimeTypes()
java.io.InputStream	getPreviewAsStream(FileVersion fileVersion)
long	getPreviewFileSize(FileVersion fileVersion)
java.lang.String	getPreviewType(FileVersion fileVersion)
java.io.InputStream	getThumbnailAsStream(FileVersion fileVersion, int index)
long	getThumbnailFileSize(FileVersion fileVersion, int index)
java.lang.String	getThumbnailType(FileVersion fileVersion)
java.lang.String	getType() Returns the processor's type.
boolean	hasImages(FileVersion fileVersion)
boolean	isImageSupported(FileVersion fileVersion)
boolean	isImageSupported(java.lang.String mimeType)
boolean	isSupported(java.lang.String mimeType) Returns true if the given file MIME type is supported by this processor.
void	storeThumbnail(long companyId, long groupId, long fileEntryId, long fileVersionId, long custom1ImageId, long custom2ImageId, java.io.InputStream inputStream, java.lang.String type)
void	trigger(FileVersion sourceFileVersion, FileVersion destinationFileVersion) Launches the processor's work with respect to the destination file version.

Methods inherited from class com.liferay.document.library.kernel.util.DLPreviewableProcessor

addFileToStore, addFileToStore, copy, copyPreviews, copyThumbnail, copyThumbnails, deleteFiles, deleteFiles, deleteFiles, deleteFiles, deletePreviews, deleteThumbnail, deleteThumbnails, destroyProcess, doGetPreviewAsStream, doGetPreviewAsStream, doGetPreviewFileCount, doGetPreviewFileSize, doGetPreviewFileSize, doGetPreviewFileSize, doGetThumbnailAsStream, doGetThumbnailFileSize, exportBinary, exportGeneratedFiles, exportPreview, exportPreview, exportThumbnail, exportThumbnails, getBinPath, getBinPath, getDecryptedTempFile, getPathSegment, getPathSegment, getPreviewFilePath, getPreviewFilePath, getPreviewFilePath, getPreviewFilePath, getPreviewFilePath, getPreviewFilePath, getPreviewTempFile, getPreviewTempFile, getPreviewTempFile, getPreviewTempFile, getPreviewTempFileCount, getPreviewTempFileCount, getPreviewTempFilePath, getPreviewTempFilePath, getPreviewTempFilePath, getPreviewTempFilePath, getPreviewType, getPreviewType, getPreviewTypes, getThumbnailFilePath, getThumbnailFilePath, getThumbnailFilePath, getThumbnailTempFile, getThumbnailTempFile, getThumbnailTempFilePath, getThumbnailTempFilePath, getThumbnailType, hasPreview, hasPreviews, hasThumbnail, hasThumbnails, importGeneratedFiles, importPreview, importPreview, importPreviewFromLAR, importThumbnail, importThumbnailFromLAR, importThumbnails, isSupported, isThumbnailEnabled, sendGenerationMessage, storeThumbnailImage, storeThumbnailImages, storeThumbnailImages

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.document.library.kernel.util.ImageProcessor

exportGeneratedFiles, importGeneratedFiles

Methods inherited from interface com.liferay.document.library.kernel.util.DLProcessor

destroy

Constructor Detail

ImageProcessorImpl

public ImageProcessorImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface DLProcessor

cleanUp

public void cleanUp(FileEntry fileEntry)

Description copied from interface: DLProcessor

Cleans up any resources that the processor created for the file entry. Note that all resources for all file versions of this file entry are permanently deleted.

Specified by:

cleanUp in interface DLProcessor

Specified by:

cleanUp in interface ImageProcessor

Overrides:

cleanUp in class DLPreviewableProcessor

Parameters:

fileEntry - the file entry for which resources are cleaned up

cleanUp

public void cleanUp(FileVersion fileVersion)

Description copied from interface: DLProcessor

Cleans up any resources that the processor created for the given file version. Note that other resources associated with other file versions for the same file entry aren't affected; use DLProcessor.cleanUp(FileEntry) if you want to clean up everything.

Specified by:

cleanUp in interface DLProcessor

Specified by:

cleanUp in interface ImageProcessor

Overrides:

cleanUp in class DLPreviewableProcessor

Parameters:

fileVersion - the file version for which resources will be cleaned up

generateImages

public void generateImages(FileVersion sourceFileVersion,
                           FileVersion destinationFileVersion)
                    throws java.lang.Exception

Specified by:

generateImages in interface ImageProcessor

Throws:

java.lang.Exception

getImageMimeTypes

public java.util.Set<java.lang.String> getImageMimeTypes()

Specified by:

getImageMimeTypes in interface ImageProcessor

getPreviewAsStream

public java.io.InputStream getPreviewAsStream(FileVersion fileVersion)
                                       throws java.lang.Exception

Specified by:

getPreviewAsStream in interface ImageProcessor

Throws:

java.lang.Exception

getPreviewFileSize

public long getPreviewFileSize(FileVersion fileVersion)
                        throws java.lang.Exception

Specified by:

getPreviewFileSize in interface ImageProcessor

Throws:

java.lang.Exception

getPreviewType

public java.lang.String getPreviewType(FileVersion fileVersion)

Specified by:

getPreviewType in interface ImageProcessor

Specified by:

getPreviewType in class DLPreviewableProcessor

getThumbnailAsStream

public java.io.InputStream getThumbnailAsStream(FileVersion fileVersion,
                                                int index)
                                         throws java.lang.Exception

Specified by:

getThumbnailAsStream in interface ImageProcessor

Throws:

java.lang.Exception

getThumbnailFileSize

public long getThumbnailFileSize(FileVersion fileVersion,
                                 int index)
                          throws java.lang.Exception

Specified by:

getThumbnailFileSize in interface ImageProcessor

Throws:

java.lang.Exception

getThumbnailType

public java.lang.String getThumbnailType(FileVersion fileVersion)

Specified by:

getThumbnailType in interface ImageProcessor

Specified by:

getThumbnailType in class DLPreviewableProcessor

getType

public java.lang.String getType()

Description copied from interface: DLProcessor

Returns the processor's type. See com.liferay.portlet.documentlibrary.model.DLProcessorConstants for the set of predefined processor types.

Specified by:

getType in interface DLProcessor

Returns:

the type of this processor

hasImages

public boolean hasImages(FileVersion fileVersion)

Specified by:

hasImages in interface ImageProcessor

isImageSupported

public boolean isImageSupported(FileVersion fileVersion)

Specified by:

isImageSupported in interface ImageProcessor

isImageSupported

public boolean isImageSupported(java.lang.String mimeType)

Specified by:

isImageSupported in interface ImageProcessor

isSupported

public boolean isSupported(java.lang.String mimeType)

Description copied from interface: DLProcessor

Returns true if the given file MIME type is supported by this processor.

Specified by:

isSupported in interface DLProcessor

Specified by:

isSupported in interface ImageProcessor

Parameters:

mimeType - the MIME type

Returns:

true if this processor supports the MIME type; false otherwise

storeThumbnail

public void storeThumbnail(long companyId,
                           long groupId,
                           long fileEntryId,
                           long fileVersionId,
                           long custom1ImageId,
                           long custom2ImageId,
                           java.io.InputStream inputStream,
                           java.lang.String type)
                    throws java.lang.Exception

Specified by:

storeThumbnail in interface ImageProcessor

Throws:

java.lang.Exception

trigger

public void trigger(FileVersion sourceFileVersion,
                    FileVersion destinationFileVersion)

Description copied from interface: DLProcessor

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

Specified by:

trigger in interface DLProcessor

Specified by:

trigger in interface ImageProcessor

Overrides:

trigger in class DLPreviewableProcessor

Parameters:

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

destinationFileVersion - the latest file version to process

doExportGeneratedFiles

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

Specified by:

doExportGeneratedFiles in class DLPreviewableProcessor

Throws:

java.lang.Exception

doImportGeneratedFiles

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

Specified by:

doImportGeneratedFiles in class DLPreviewableProcessor

Throws:

java.lang.Exception

exportPreview

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

Throws:

java.lang.Exception

getFileVersionIds

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

Specified by:

getFileVersionIds in class DLPreviewableProcessor