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

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

public class DLFileEntryServiceHttp
extends Object

This class provides a HTTP utility for the DLFileEntryServiceUtil 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:

DLFileEntryServiceSoap, HttpPrincipal, DLFileEntryServiceUtil

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

Constructor Summary

DLFileEntryServiceHttp()

Method Summary

static DLFileEntry	addFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static DLFileEntry	addFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
static void	deleteFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name)
static void	deleteFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String version)
static void	deleteFileEntryByTitle(HttpPrincipal httpPrincipal, long groupId, long folderId, String titleWithExtension)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, int start, int end)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, int start, int end, OrderByComparator obc)
static int	getFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId)
static DLFileEntry	getFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name)
static DLFileEntry	getFileEntryByTitle(HttpPrincipal httpPrincipal, long groupId, long folderId, String titleWithExtension)
static DLFileEntry	getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal, String uuid, long groupId)
static int	getFoldersFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status)
static List<DLFileEntry>	getGroupFileEntries(HttpPrincipal httpPrincipal, long groupId, long userId, int start, int end)
static List<DLFileEntry>	getGroupFileEntries(HttpPrincipal httpPrincipal, long groupId, long userId, int start, int end, OrderByComparator obc)
static int	getGroupFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long userId)
static boolean	hasFileEntryLock(HttpPrincipal httpPrincipal, long groupId, long folderId, String name)
static Lock	lockFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name)
static Lock	lockFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String owner, long expirationTime)
static DLFileEntry	moveFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, long newFolderId, String name, ServiceContext serviceContext)
static Lock	refreshFileEntryLock(HttpPrincipal httpPrincipal, String lockUuid, long expirationTime)
static void	unlockFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name)
static void	unlockFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String lockUuid)
static DLFileEntry	updateFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static DLFileEntry	updateFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, File file, ServiceContext serviceContext)
static boolean	verifyFileEntryLock(HttpPrincipal httpPrincipal, long groupId, long folderId, String name, String lockUuid)

Methods inherited from class java.lang.Object

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

Constructor Detail

DLFileEntryServiceHttp

public DLFileEntryServiceHttp()

Method Detail

addFileEntry

public static DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long folderId,
                                       String name,
                                       String title,
                                       String description,
                                       String changeLog,
                                       String extraSettings,
                                       byte[] bytes,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

addFileEntry

public static DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long folderId,
                                       String name,
                                       String title,
                                       String description,
                                       String changeLog,
                                       String extraSettings,
                                       File file,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long folderId,
                                   String name)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long folderId,
                                   String name,
                                   String version)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntryByTitle

public static void deleteFileEntryByTitle(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId,
                                          String titleWithExtension)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileEntries

public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
                                               long groupId,
                                               long folderId)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getFileEntries

public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
                                               long groupId,
                                               long folderId,
                                               int start,
                                               int end)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getFileEntries

public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
                                               long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator obc)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getFileEntriesCount

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

Throws:

PortalException

SystemException

getFileEntry

public static DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long folderId,
                                       String name)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getFileEntryByTitle

public static DLFileEntry getFileEntryByTitle(HttpPrincipal httpPrincipal,
                                              long groupId,
                                              long folderId,
                                              String titleWithExtension)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

public static DLFileEntry getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal,
                                                       String uuid,
                                                       long groupId)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getFoldersFileEntriesCount

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

Throws:

SystemException

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long userId,
                                                    int start,
                                                    int end)
                                             throws SystemException

Throws:

SystemException

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long userId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws SystemException

Throws:

SystemException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long userId)
                                    throws SystemException

Throws:

SystemException

hasFileEntryLock

public static boolean hasFileEntryLock(HttpPrincipal httpPrincipal,
                                       long groupId,
                                       long folderId,
                                       String name)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

lockFileEntry

public static Lock lockFileEntry(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long folderId,
                                 String name)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

lockFileEntry

public static Lock lockFileEntry(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long folderId,
                                 String name,
                                 String owner,
                                 long expirationTime)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

moveFileEntry

public static DLFileEntry moveFileEntry(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long folderId,
                                        long newFolderId,
                                        String name,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

refreshFileEntryLock

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

Throws:

PortalException

SystemException

unlockFileEntry

public static void unlockFileEntry(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long folderId,
                                   String name)
                            throws SystemException

Throws:

SystemException

unlockFileEntry

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

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String sourceFileName,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          String extraSettings,
                                          byte[] bytes,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String sourceFileName,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          String extraSettings,
                                          File file,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

verifyFileEntryLock

public static boolean verifyFileEntryLock(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String lockUuid)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException