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

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

public class DLFolderServiceHttp
extends 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.

See Also:

DLFolderServiceSoap, HttpPrincipal, DLFolderServiceUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

DLFolderServiceHttp()

Method Summary

static DLFolder	addFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
static DLFolder	copyFolder(HttpPrincipal httpPrincipal, long groupId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId)
static void	deleteFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, String name)
static List<Object>	getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status, int start, int end)
static List<Object>	getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, int start, int end)
static int	getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status)
static int	getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static DLFolder	getFolder(HttpPrincipal httpPrincipal, long folderId)
static DLFolder	getFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, String name)
static long	getFolderId(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, String name)
static long[]	getFolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId)
static List<DLFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static List<DLFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int start, int end)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status, int start, int end)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, int start, int end)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, List<Long> folderIds, long groupId, long folderId)
static boolean	hasInheritableLock(HttpPrincipal httpPrincipal, long folderId)
static Lock	lockFolder(HttpPrincipal httpPrincipal, long folderId)
static Lock	lockFolder(HttpPrincipal httpPrincipal, long folderId, String owner, boolean inheritable, long expirationTime)
static Lock	refreshFolderLock(HttpPrincipal httpPrincipal, String lockUuid, long expirationTime)
static void	unlockFolder(HttpPrincipal httpPrincipal, long groupId, long folderId, String lockUuid)
static void	unlockFolder(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, String name, String lockUuid)
static DLFolder	updateFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
static boolean	verifyInheritableLock(HttpPrincipal httpPrincipal, long folderId, 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 DLFolder addFolder(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long parentFolderId,
                                 String name,
                                 String description,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

copyFolder

public static DLFolder copyFolder(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long sourceFolderId,
                                  long parentFolderId,
                                  String name,
                                  String description,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException,
                                  RemoteException

Throws:

PortalException

SystemException

RemoteException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                                long folderId)
                         throws PortalException,
                                SystemException,
                                RemoteException

Throws:

PortalException

SystemException

RemoteException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentFolderId,
                                String name)
                         throws PortalException,
                                SystemException,
                                RemoteException

Throws:

PortalException

SystemException

RemoteException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                          long groupId,
                                                          List<Long> folderIds,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                          long groupId,
                                                          long folderId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                      long groupId,
                                                      List<Long> folderIds,
                                                      int status)
                                               throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                      long groupId,
                                                      long folderId,
                                                      int status)
                                               throws SystemException

Throws:

SystemException

getFolder

public static DLFolder getFolder(HttpPrincipal httpPrincipal,
                                 long folderId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFolder

public static DLFolder getFolder(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long parentFolderId,
                                 String name)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFolderId

public static long getFolderId(HttpPrincipal httpPrincipal,
                               long groupId,
                               long parentFolderId,
                               String name)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFolderIds

public static long[] getFolderIds(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long folderId)
                           throws SystemException

Throws:

SystemException

getFolders

public static List<DLFolder> getFolders(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long parentFolderId)
                                 throws SystemException

Throws:

SystemException

getFolders

public static List<DLFolder> getFolders(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long parentFolderId,
                                        int start,
                                        int end)
                                 throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                                    long groupId,
                                                                    List<Long> folderIds,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(HttpPrincipal httpPrincipal,
                                                                    long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws PortalException,
                                                                    SystemException

Throws:

PortalException

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                                long groupId,
                                                                List<Long> folderIds,
                                                                int status)
                                                         throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(HttpPrincipal httpPrincipal,
                                                                long groupId,
                                                                long folderId,
                                                                int status)
                                                         throws PortalException,
                                                                SystemException

Throws:

PortalException

SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                                  long groupId,
                                  long parentFolderId)
                           throws SystemException

Throws:

SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                                   List<Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws SystemException

Throws:

SystemException

hasInheritableLock

public static boolean hasInheritableLock(HttpPrincipal httpPrincipal,
                                         long folderId)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

lockFolder

public static Lock lockFolder(HttpPrincipal httpPrincipal,
                              long folderId)
                       throws PortalException,
                              SystemException,
                              RemoteException

Throws:

PortalException

SystemException

RemoteException

lockFolder

public static Lock lockFolder(HttpPrincipal httpPrincipal,
                              long folderId,
                              String owner,
                              boolean inheritable,
                              long expirationTime)
                       throws PortalException,
                              SystemException,
                              RemoteException

Throws:

PortalException

SystemException

RemoteException

refreshFolderLock

public static Lock refreshFolderLock(HttpPrincipal httpPrincipal,
                                     String lockUuid,
                                     long expirationTime)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

unlockFolder

public static void unlockFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long folderId,
                                String lockUuid)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

unlockFolder

public static void unlockFolder(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentFolderId,
                                String name,
                                String lockUuid)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateFolder

public static DLFolder updateFolder(HttpPrincipal httpPrincipal,
                                    long folderId,
                                    long parentFolderId,
                                    String name,
                                    String description,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException,
                                    RemoteException

Throws:

PortalException

SystemException

RemoteException

verifyInheritableLock

public static boolean verifyInheritableLock(HttpPrincipal httpPrincipal,
                                            long folderId,
                                            String lockUuid)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException