com.liferay.document.library.kernel.util

Class DLUtil

java.lang.Object

com.liferay.document.library.kernel.util.DLUtil

public class DLUtil
extends java.lang.Object

Author:

Brian Wing Shun Chan, Julio Camarero

Constructor Summary

Constructors

Constructor and Description
DLUtil()

Method Summary

Modifier and Type	Method and Description
static int	compareVersions(java.lang.String version1, java.lang.String version2)
static java.lang.String	getAbsolutePath(javax.portlet.PortletRequest portletRequest, long folderId)
static java.util.Set<java.lang.String>	getAllMediaGalleryMimeTypes()
static java.lang.String	getDDMStructureKey(DLFileEntryType dlFileEntryType)
static java.lang.String	getDDMStructureKey(java.lang.String fileEntryTypeUuid)
static java.lang.String	getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)
static java.lang.String	getDeprecatedDDMStructureKey(long fileEntryTypeId)
static java.lang.String	getDividedPath(long id)
static DL	getDL()
static java.lang.String	getDLFileEntryControlPanelLink(javax.portlet.PortletRequest portletRequest, long fileEntryId) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getFileEntryControlPanelLink( PortletRequest, long)
static java.lang.String	getDLFolderControlPanelLink(javax.portlet.PortletRequest portletRequest, long folderId) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getFolderControlPanelLink( PortletRequest, long)
static java.lang.String	getDownloadURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getDownloadURL( FileEntry, FileVersion, ThemeDisplay, String)
static java.lang.String	getDownloadURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString, boolean appendVersion, boolean absoluteURL) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getDownloadURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)
static java.util.Map<java.lang.String,java.lang.String>	getEmailDefinitionTerms(javax.portlet.RenderRequest renderRequest, java.lang.String emailFromAddress, java.lang.String emailFromName)
static java.util.Map<java.lang.String,java.lang.String>	getEmailFromDefinitionTerms(javax.portlet.RenderRequest renderRequest, java.lang.String emailFromAddress, java.lang.String emailFromName)
static java.util.List<FileEntry>	getFileEntries(Hits hits)
static java.lang.String	getFileEntryImage(FileEntry fileEntry, ThemeDisplay themeDisplay)
static java.util.Set<java.lang.Long>	getFileEntryTypeSubscriptionClassPKs(long userId) Deprecated. As of Judson (7.1.x), with no direct replacement
static java.lang.String	getFileIcon(java.lang.String extension)
static java.lang.String	getFileIconCssClass(java.lang.String extension)
static java.lang.String	getGenericName(java.lang.String extension)
static java.lang.String	getImagePreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay)
static java.lang.String	getImagePreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString, boolean appendVersion, boolean absoluteURL) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)
static java.lang.String	getImagePreviewURL(FileEntry fileEntry, ThemeDisplay themeDisplay) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay)
static java.lang.String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getPreviewURL( FileEntry, FileVersion, ThemeDisplay, String)
static java.lang.String	getPreviewURL(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay, java.lang.String queryString, boolean appendVersion, boolean absoluteURL) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getPreviewURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)
static <T> OrderByComparator<T>	getRepositoryModelOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static <T> OrderByComparator<T>	getRepositoryModelOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType, boolean orderByModel)
static java.lang.String	getSanitizedFileName(java.lang.String title, java.lang.String extension)
static java.lang.String	getTempFileId(long id, java.lang.String version)
static java.lang.String	getTempFileId(long id, java.lang.String version, java.lang.String languageId)
static java.lang.String	getThumbnailSrc(FileEntry fileEntry, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, ThemeDisplay)
static java.lang.String	getThumbnailSrc(FileEntry fileEntry, FileVersion fileVersion, DLFileShortcut dlFileShortcut, ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, FileVersion, ThemeDisplay)
static java.lang.String	getThumbnailSrc(FileEntry fileEntry, FileVersion fileVersion, ThemeDisplay themeDisplay) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getThumbnailSrc( FileEntry, FileVersion, ThemeDisplay)
static java.lang.String	getThumbnailSrc(FileEntry fileEntry, ThemeDisplay themeDisplay) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getThumbnailSrc( FileEntry, ThemeDisplay)
static java.lang.String	getThumbnailStyle()
static java.lang.String	getThumbnailStyle(boolean max, int margin)
static java.lang.String	getThumbnailStyle(boolean max, int margin, int height, int width)
static java.lang.String	getTitleWithExtension(FileEntry fileEntry)
static java.lang.String	getTitleWithExtension(java.lang.String title, java.lang.String extension)
static java.lang.String	getUniqueFileName(long groupId, long folderId, java.lang.String fileName)
static java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry)
static java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry, boolean)
static java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, Folder folder, FileEntry fileEntry, boolean manualCheckInRequired, boolean officeExtensionRequired) Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry, boolean, boolean)
static boolean	hasWorkflowDefinitionLink(long companyId, long groupId, long folderId, long fileEntryTypeId)
static boolean	isAutoGeneratedDLFileEntryTypeDDMStructureKey(java.lang.String ddmStructureKey)
static boolean	isOfficeExtension(java.lang.String extension)
static boolean	isSubscribedToFileEntryType(long companyId, long groupId, long userId, long fileEntryTypeId) Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFileEntryType(long, long, long, long)
static boolean	isSubscribedToFolder(long companyId, long groupId, long userId, long folderId) Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFolder(long, long, long, long)
static boolean	isSubscribedToFolder(long companyId, long groupId, long userId, long folderId, boolean recursive) Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFolder(long, long, long, long, boolean)
static boolean	isValidVersion(java.lang.String version)
void	setDL(DL dl)
static void	startWorkflowInstance(long userId, DLFileVersion dlFileVersion, java.lang.String syncEventType, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DLUtil

public DLUtil()

Method Detail

compareVersions

public static int compareVersions(java.lang.String version1,
                                  java.lang.String version2)

getAbsolutePath

public static java.lang.String getAbsolutePath(javax.portlet.PortletRequest portletRequest,
                                               long folderId)
                                        throws PortalException

Throws:

PortalException

getAllMediaGalleryMimeTypes

public static java.util.Set<java.lang.String> getAllMediaGalleryMimeTypes()

getDDMStructureKey

public static java.lang.String getDDMStructureKey(DLFileEntryType dlFileEntryType)

getDDMStructureKey

public static java.lang.String getDDMStructureKey(java.lang.String fileEntryTypeUuid)

getDeprecatedDDMStructureKey

public static java.lang.String getDeprecatedDDMStructureKey(DLFileEntryType dlFileEntryType)

getDeprecatedDDMStructureKey

public static java.lang.String getDeprecatedDDMStructureKey(long fileEntryTypeId)

getDividedPath

public static java.lang.String getDividedPath(long id)

getDL

public static DL getDL()

getDLFileEntryControlPanelLink

@Deprecated
public static java.lang.String getDLFileEntryControlPanelLink(javax.portlet.PortletRequest portletRequest,
                                                                          long fileEntryId)
                                                                   throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getFileEntryControlPanelLink( PortletRequest, long)

Throws:

PortalException

getDLFolderControlPanelLink

@Deprecated
public static java.lang.String getDLFolderControlPanelLink(javax.portlet.PortletRequest portletRequest,
                                                                       long folderId)
                                                                throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getFolderControlPanelLink( PortletRequest, long)

Throws:

PortalException

getDownloadURL

@Deprecated
public static java.lang.String getDownloadURL(FileEntry fileEntry,
                                                          FileVersion fileVersion,
                                                          ThemeDisplay themeDisplay,
                                                          java.lang.String queryString)

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getDownloadURL( FileEntry, FileVersion, ThemeDisplay, String)

getDownloadURL

@Deprecated
public static java.lang.String getDownloadURL(FileEntry fileEntry,
                                                          FileVersion fileVersion,
                                                          ThemeDisplay themeDisplay,
                                                          java.lang.String queryString,
                                                          boolean appendVersion,
                                                          boolean absoluteURL)

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getDownloadURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)

getEmailDefinitionTerms

public static java.util.Map<java.lang.String,java.lang.String> getEmailDefinitionTerms(javax.portlet.RenderRequest renderRequest,
                                                                                       java.lang.String emailFromAddress,
                                                                                       java.lang.String emailFromName)

getEmailFromDefinitionTerms

public static java.util.Map<java.lang.String,java.lang.String> getEmailFromDefinitionTerms(javax.portlet.RenderRequest renderRequest,
                                                                                           java.lang.String emailFromAddress,
                                                                                           java.lang.String emailFromName)

getFileEntries

public static java.util.List<FileEntry> getFileEntries(Hits hits)

getFileEntryImage

public static java.lang.String getFileEntryImage(FileEntry fileEntry,
                                                 ThemeDisplay themeDisplay)

getFileEntryTypeSubscriptionClassPKs

@Deprecated
public static java.util.Set<java.lang.Long> getFileEntryTypeSubscriptionClassPKs(long userId)

Deprecated. As of Judson (7.1.x), with no direct replacement

getFileIcon

public static java.lang.String getFileIcon(java.lang.String extension)

getFileIconCssClass

public static java.lang.String getFileIconCssClass(java.lang.String extension)

getGenericName

public static java.lang.String getGenericName(java.lang.String extension)

getImagePreviewURL

@Deprecated
public static java.lang.String getImagePreviewURL(FileEntry fileEntry,
                                                              FileVersion fileVersion,
                                                              ThemeDisplay themeDisplay)
                                                       throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay)

Throws:

java.lang.Exception

getImagePreviewURL

@Deprecated
public static java.lang.String getImagePreviewURL(FileEntry fileEntry,
                                                              FileVersion fileVersion,
                                                              ThemeDisplay themeDisplay,
                                                              java.lang.String queryString,
                                                              boolean appendVersion,
                                                              boolean absoluteURL)
                                                       throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)

Throws:

PortalException

getImagePreviewURL

@Deprecated
public static java.lang.String getImagePreviewURL(FileEntry fileEntry,
                                                              ThemeDisplay themeDisplay)
                                                       throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getImagePreviewURL( FileEntry, FileVersion, ThemeDisplay)

Throws:

java.lang.Exception

getPreviewURL

@Deprecated
public static java.lang.String getPreviewURL(FileEntry fileEntry,
                                                         FileVersion fileVersion,
                                                         ThemeDisplay themeDisplay,
                                                         java.lang.String queryString)

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getPreviewURL( FileEntry, FileVersion, ThemeDisplay, String)

getPreviewURL

@Deprecated
public static java.lang.String getPreviewURL(FileEntry fileEntry,
                                                         FileVersion fileVersion,
                                                         ThemeDisplay themeDisplay,
                                                         java.lang.String queryString,
                                                         boolean appendVersion,
                                                         boolean absoluteURL)

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getPreviewURL( FileEntry, FileVersion, ThemeDisplay, String, boolean, boolean)

getRepositoryModelOrderByComparator

public static <T> OrderByComparator<T> getRepositoryModelOrderByComparator(java.lang.String orderByCol,
                                                                           java.lang.String orderByType)

getRepositoryModelOrderByComparator

public static <T> OrderByComparator<T> getRepositoryModelOrderByComparator(java.lang.String orderByCol,
                                                                           java.lang.String orderByType,
                                                                           boolean orderByModel)

getSanitizedFileName

public static java.lang.String getSanitizedFileName(java.lang.String title,
                                                    java.lang.String extension)

getTempFileId

public static java.lang.String getTempFileId(long id,
                                             java.lang.String version)

getTempFileId

public static java.lang.String getTempFileId(long id,
                                             java.lang.String version,
                                             java.lang.String languageId)

getThumbnailSrc

@Deprecated
public static java.lang.String getThumbnailSrc(FileEntry fileEntry,
                                                           DLFileShortcut dlFileShortcut,
                                                           ThemeDisplay themeDisplay)
                                                    throws java.lang.Exception

Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, ThemeDisplay)

Throws:

java.lang.Exception

getThumbnailSrc

@Deprecated
public static java.lang.String getThumbnailSrc(FileEntry fileEntry,
                                                           FileVersion fileVersion,
                                                           DLFileShortcut dlFileShortcut,
                                                           ThemeDisplay themeDisplay)
                                                    throws java.lang.Exception

Deprecated. As of Wilberforce (7.0.x), replaced by getThumbnailSrc(FileEntry, FileVersion, ThemeDisplay)

Throws:

java.lang.Exception

getThumbnailSrc

@Deprecated
public static java.lang.String getThumbnailSrc(FileEntry fileEntry,
                                                           FileVersion fileVersion,
                                                           ThemeDisplay themeDisplay)
                                                    throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getThumbnailSrc( FileEntry, FileVersion, ThemeDisplay)

Throws:

java.lang.Exception

getThumbnailSrc

@Deprecated
public static java.lang.String getThumbnailSrc(FileEntry fileEntry,
                                                           ThemeDisplay themeDisplay)
                                                    throws java.lang.Exception

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getThumbnailSrc( FileEntry, ThemeDisplay)

Throws:

java.lang.Exception

getThumbnailStyle

public static java.lang.String getThumbnailStyle()

getThumbnailStyle

public static java.lang.String getThumbnailStyle(boolean max,
                                                 int margin)

getThumbnailStyle

public static java.lang.String getThumbnailStyle(boolean max,
                                                 int margin,
                                                 int height,
                                                 int width)

getTitleWithExtension

public static java.lang.String getTitleWithExtension(FileEntry fileEntry)

getTitleWithExtension

public static java.lang.String getTitleWithExtension(java.lang.String title,
                                                     java.lang.String extension)

getUniqueFileName

public static java.lang.String getUniqueFileName(long groupId,
                                                 long folderId,
                                                 java.lang.String fileName)

getWebDavURL

@Deprecated
public static java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                                                        Folder folder,
                                                        FileEntry fileEntry)
                                                 throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry)

Throws:

PortalException

getWebDavURL

@Deprecated
public static java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                                                        Folder folder,
                                                        FileEntry fileEntry,
                                                        boolean manualCheckInRequired)
                                                 throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry, boolean)

Throws:

PortalException

getWebDavURL

@Deprecated
public static java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                                                        Folder folder,
                                                        FileEntry fileEntry,
                                                        boolean manualCheckInRequired,
                                                        boolean officeExtensionRequired)
                                                 throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by com.liferay.document.library.util.DLURLHelper#FileEntryURLHelper#getWebDavURL( ThemeDisplay, Folder, FileEntry, boolean, boolean)

Throws:

PortalException

hasWorkflowDefinitionLink

public static boolean hasWorkflowDefinitionLink(long companyId,
                                                long groupId,
                                                long folderId,
                                                long fileEntryTypeId)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

isAutoGeneratedDLFileEntryTypeDDMStructureKey

public static boolean isAutoGeneratedDLFileEntryTypeDDMStructureKey(java.lang.String ddmStructureKey)

isOfficeExtension

public static boolean isOfficeExtension(java.lang.String extension)

isSubscribedToFileEntryType

@Deprecated
public static boolean isSubscribedToFileEntryType(long companyId,
                                                              long groupId,
                                                              long userId,
                                                              long fileEntryTypeId)

Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFileEntryType(long, long, long, long)

isSubscribedToFolder

@Deprecated
public static boolean isSubscribedToFolder(long companyId,
                                                       long groupId,
                                                       long userId,
                                                       long folderId)
                                                throws PortalException

Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFolder(long, long, long, long)

Throws:

PortalException

isSubscribedToFolder

@Deprecated
public static boolean isSubscribedToFolder(long companyId,
                                                       long groupId,
                                                       long userId,
                                                       long folderId,
                                                       boolean recursive)
                                                throws PortalException

Deprecated. As of Judson (7.1.x), replaced by DLSubscriptionUtil#isSubscribedToFolder(long, long, long, long, boolean)

Throws:

PortalException

isValidVersion

public static boolean isValidVersion(java.lang.String version)

startWorkflowInstance

public static void startWorkflowInstance(long userId,
                                         DLFileVersion dlFileVersion,
                                         java.lang.String syncEventType,
                                         ServiceContext serviceContext)
                                  throws PortalException

Throws:

PortalException

setDL

public void setDL(DL dl)