com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceHttp

java.lang.Object
  com.liferay.portlet.documentlibrary.service.http.DLFolderServiceHttp

public class DLFolderServiceHttp
extends java.lang.Object

This class provides a HTTP utility for the DLFolderServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

DLFolderServiceSoap, HttpPrincipal, DLFolderServiceUtil

Generated:

Constructor Summary

DLFolderServiceHttp()

Method Summary

static com.liferay.portlet.documentlibrary.model.DLFolder	addFolder(HttpPrincipal httpPrincipal, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId)
static void	deleteFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, java.lang.String name)
static java.util.List<java.lang.Object>	getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, int start, int end)
static int	getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static int	getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, java.lang.String[] mimeTypes)
static com.liferay.portlet.documentlibrary.model.DLFolder	getFolder(HttpPrincipal httpPrincipal, long folderId)
static com.liferay.portlet.documentlibrary.model.DLFolder	getFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, java.lang.String name)
static long[]	getFolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId)
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static int	getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders)
static java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, boolean includeMountFolders)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, boolean includeMountfolders)
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder>	getMountFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
static int	getMountFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
static java.util.List<java.lang.Long>	getSubfolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId, boolean recurse)
static boolean	hasFolderLock(HttpPrincipal httpPrincipal, long folderId)
static boolean	hasInheritableLock(HttpPrincipal httpPrincipal, long folderId)
static boolean	isFolderLocked(HttpPrincipal httpPrincipal, long folderId)
static com.liferay.portal.model.Lock	lockFolder(HttpPrincipal httpPrincipal, long folderId)
static com.liferay.portal.model.Lock	lockFolder(HttpPrincipal httpPrincipal, long folderId, java.lang.String owner, boolean inheritable, long expirationTime)
static com.liferay.portlet.documentlibrary.model.DLFolder	moveFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, com.liferay.portal.service.ServiceContext serviceContext)
static com.liferay.portal.model.Lock	refreshFolderLock(HttpPrincipal httpPrincipal, java.lang.String lockUuid, long expirationTime)
static void	unlockFolder(HttpPrincipal httpPrincipal, long groupId, long folderId, java.lang.String lockUuid)
static void	unlockFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, java.lang.String name, java.lang.String lockUuid)
static com.liferay.portlet.documentlibrary.model.DLFolder	updateFolder(HttpPrincipal httpPrincipal, long folderId, java.lang.String name, java.lang.String description, long defaultFileEntryTypeId, java.util.List<java.lang.Long> fileEntryTypeIds, boolean overrideFileEntryTypes, com.liferay.portal.service.ServiceContext serviceContext)
static boolean	verifyInheritableLock(HttpPrincipal httpPrincipal, long folderId, java.lang.String lockUuid)

Methods inherited from class java.lang.Object

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

Constructor Detail

DLFolderServiceHttp

public DLFolderServiceHttp()

Method Detail

addFolder

public static com.liferay.portlet.documentlibrary.model.DLFolder addFolder(HttpPrincipal httpPrincipal,
                                                                           long groupId,
                                                                           long repositoryId,
                                                                           boolean mountPoint,
                                                                           long parentFolderId,
                                                                           java.lang.String name,
                                                                           java.lang.String description,
                                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                                long folderId)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentFolderId,
                                java.lang.String name)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFileEntriesAndFileShortcuts

public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                                              long groupId,
                                                                              long folderId,
                                                                              int status,
                                                                              int start,
                                                                              int end)
                                                                       throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                      long groupId,
                                                      long folderId,
                                                      int status)
                                               throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                      long groupId,
                                                      long folderId,
                                                      int status,
                                                      java.lang.String[] mimeTypes)
                                               throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolder

public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(HttpPrincipal httpPrincipal,
                                                                           long folderId)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolder

public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(HttpPrincipal httpPrincipal,
                                                                           long groupId,
                                                                           long parentFolderId,
                                                                           java.lang.String name)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolderIds

public static long[] getFolderIds(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long folderId)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                                            long groupId,
                                                                                            long parentFolderId,
                                                                                            boolean includeMountfolders,
                                                                                            int start,
                                                                                            int end,
                                                                                            com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                     throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                                            long groupId,
                                                                                            long parentFolderId,
                                                                                            int start,
                                                                                            int end,
                                                                                            com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                     throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                                                        long groupId,
                                                                                        long folderId,
                                                                                        int status,
                                                                                        boolean includeMountFolders,
                                                                                        int start,
                                                                                        int end,
                                                                                        com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                 throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static int getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                           long groupId,
                                                           long folderId,
                                                           int status,
                                                           java.lang.String[] mimeTypes,
                                                           boolean includeMountFolders)
                                                    throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                                                        long groupId,
                                                                                        long folderId,
                                                                                        int status,
                                                                                        java.lang.String[] mimeTypes,
                                                                                        boolean includeMountFolders,
                                                                                        int start,
                                                                                        int end,
                                                                                        com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                 throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                                long groupId,
                                                                long folderId,
                                                                int status,
                                                                boolean includeMountFolders)
                                                         throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                                long groupId,
                                                                long folderId,
                                                                int status,
                                                                java.lang.String[] mimeTypes,
                                                                boolean includeMountFolders)
                                                         throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long parentFolderId)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long parentFolderId,
                                  boolean includeMountfolders)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getMountFolders

public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(HttpPrincipal httpPrincipal,
                                                                                                 long groupId,
                                                                                                 long parentFolderId,
                                                                                                 int start,
                                                                                                 int end,
                                                                                                 com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                          throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getMountFoldersCount

public static int getMountFoldersCount(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long parentFolderId)
                                throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                                   java.util.List<java.lang.Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static java.util.List<java.lang.Long> getSubfolderIds(HttpPrincipal httpPrincipal,
                                                             long groupId,
                                                             long folderId,
                                                             boolean recurse)
                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

hasFolderLock

public static boolean hasFolderLock(HttpPrincipal httpPrincipal,
                                    long folderId)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

hasInheritableLock

public static boolean hasInheritableLock(HttpPrincipal httpPrincipal,
                                         long folderId)
                                  throws com.liferay.portal.kernel.exception.PortalException,
                                         com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

isFolderLocked

public static boolean isFolderLocked(HttpPrincipal httpPrincipal,
                                     long folderId)
                              throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

lockFolder

public static com.liferay.portal.model.Lock lockFolder(HttpPrincipal httpPrincipal,
                                                       long folderId)
                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                       com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

lockFolder

public static com.liferay.portal.model.Lock lockFolder(HttpPrincipal httpPrincipal,
                                                       long folderId,
                                                       java.lang.String owner,
                                                       boolean inheritable,
                                                       long expirationTime)
                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                       com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

moveFolder

public static com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(HttpPrincipal httpPrincipal,
                                                                            long folderId,
                                                                            long parentFolderId,
                                                                            com.liferay.portal.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

refreshFolderLock

public static com.liferay.portal.model.Lock refreshFolderLock(HttpPrincipal httpPrincipal,
                                                              java.lang.String lockUuid,
                                                              long expirationTime)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unlockFolder

public static void unlockFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long folderId,
                                java.lang.String lockUuid)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unlockFolder

public static void unlockFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentFolderId,
                                java.lang.String name,
                                java.lang.String lockUuid)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateFolder

public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(HttpPrincipal httpPrincipal,
                                                                              long folderId,
                                                                              java.lang.String name,
                                                                              java.lang.String description,
                                                                              long defaultFileEntryTypeId,
                                                                              java.util.List<java.lang.Long> fileEntryTypeIds,
                                                                              boolean overrideFileEntryTypes,
                                                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

verifyInheritableLock

public static boolean verifyInheritableLock(HttpPrincipal httpPrincipal,
                                            long folderId,
                                            java.lang.String lockUuid)
                                     throws com.liferay.portal.kernel.exception.PortalException,
                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException