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 it is generated.

Constructor Summary

DLFileEntryServiceHttp()

Method Summary

static DLFileEntry	addFileEntry(HttpPrincipal httpPrincipal, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
static DLFileVersion	cancelCheckOut(HttpPrincipal httpPrincipal, long fileEntryId)
static void	checkInFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
static void	checkInFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, String lockUuid)
static DLFileEntry	checkOutFileEntry(HttpPrincipal httpPrincipal, long fileEntryId)
static DLFileEntry	checkOutFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, ServiceContext serviceContext)
static DLFileEntry	checkOutFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, String owner, long expirationTime)
static DLFileEntry	checkOutFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
static DLFileEntry	copyFileEntry(HttpPrincipal httpPrincipal, long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
static void	deleteFileEntry(HttpPrincipal httpPrincipal, long fileEntryId)
static void	deleteFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String title)
static void	deleteFileVersion(HttpPrincipal httpPrincipal, long fileEntryId, String version)
static DLFileEntry	fetchFileEntryByImageId(HttpPrincipal httpPrincipal, long imageId)
static InputStream	getFileAsStream(HttpPrincipal httpPrincipal, long fileEntryId, String version)
static InputStream	getFileAsStream(HttpPrincipal httpPrincipal, long fileEntryId, String version, boolean incrementCounter)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, int start, int end, OrderByComparator obc)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator obc)
static List<DLFileEntry>	getFileEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator obc)
static int	getFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId)
static int	getFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId, long fileEntryTypeId)
static int	getFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId, String[] mimeTypes)
static DLFileEntry	getFileEntry(HttpPrincipal httpPrincipal, long fileEntryId)
static DLFileEntry	getFileEntry(HttpPrincipal httpPrincipal, long groupId, long folderId, String title)
static DLFileEntry	getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal, String uuid, long groupId)
static Lock	getFileEntryLock(HttpPrincipal httpPrincipal, long fileEntryId)
static int	getFoldersFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, List<Long> folderIds, int status)
static List<DLFileEntry>	getGroupFileEntries(HttpPrincipal httpPrincipal, long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator obc)
static List<DLFileEntry>	getGroupFileEntries(HttpPrincipal httpPrincipal, long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator obc)
static int	getGroupFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long userId, long rootFolderId)
static int	getGroupFileEntriesCount(HttpPrincipal httpPrincipal, long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
static boolean	hasFileEntryLock(HttpPrincipal httpPrincipal, long fileEntryId)
static boolean	isFileEntryCheckedOut(HttpPrincipal httpPrincipal, long fileEntryId)
static DLFileEntry	moveFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, long newFolderId, ServiceContext serviceContext)
static Lock	refreshFileEntryLock(HttpPrincipal httpPrincipal, String lockUuid, long expirationTime)
static void	revertFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, String version, ServiceContext serviceContext)
static DLFileEntry	updateFileEntry(HttpPrincipal httpPrincipal, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
static boolean	verifyFileEntryCheckOut(HttpPrincipal httpPrincipal, long fileEntryId, String lockUuid)
static boolean	verifyFileEntryLock(HttpPrincipal httpPrincipal, long fileEntryId, 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 repositoryId,
                                       long folderId,
                                       String sourceFileName,
                                       String mimeType,
                                       String title,
                                       String description,
                                       String changeLog,
                                       long fileEntryTypeId,
                                       Map<String,Fields> fieldsMap,
                                       File file,
                                       InputStream is,
                                       long size,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

cancelCheckOut

public static DLFileVersion cancelCheckOut(HttpPrincipal httpPrincipal,
                                           long fileEntryId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

checkInFileEntry

public static void checkInFileEntry(HttpPrincipal httpPrincipal,
                                    long fileEntryId,
                                    boolean major,
                                    String changeLog,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

checkInFileEntry

public static void checkInFileEntry(HttpPrincipal httpPrincipal,
                                    long fileEntryId,
                                    String lockUuid)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
                                            long fileEntryId)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
                                            long fileEntryId,
                                            ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
                                            long fileEntryId,
                                            String owner,
                                            long expirationTime)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
                                            long fileEntryId,
                                            String owner,
                                            long expirationTime,
                                            ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

copyFileEntry

public static DLFileEntry copyFileEntry(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long repositoryId,
                                        long fileEntryId,
                                        long destFolderId,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(HttpPrincipal httpPrincipal,
                                   long fileEntryId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntry

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

Throws:

PortalException

SystemException

deleteFileVersion

public static void deleteFileVersion(HttpPrincipal httpPrincipal,
                                     long fileEntryId,
                                     String version)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

fetchFileEntryByImageId

public static DLFileEntry fetchFileEntryByImageId(HttpPrincipal httpPrincipal,
                                                  long imageId)
                                           throws PortalException,
                                                  SystemException

Throws:

PortalException

SystemException

getFileAsStream

public static InputStream getFileAsStream(HttpPrincipal httpPrincipal,
                                          long fileEntryId,
                                          String version)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileAsStream

public static InputStream getFileAsStream(HttpPrincipal httpPrincipal,
                                          long fileEntryId,
                                          String version,
                                          boolean incrementCounter)
                                   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 SystemException

Throws:

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntriesCount

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

Throws:

SystemException

getFileEntriesCount

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

Throws:

SystemException

getFileEntriesCount

public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      long folderId,
                                      String[] mimeTypes)
                               throws SystemException

Throws:

SystemException

getFileEntry

public static DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
                                       long fileEntryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getFileEntry

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

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

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

Throws:

PortalException

SystemException

getFileEntryLock

public static Lock getFileEntryLock(HttpPrincipal httpPrincipal,
                                    long fileEntryId)
                             throws SystemException

Throws:

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,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws SystemException

Throws:

SystemException

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    String[] mimeTypes,
                                                    int status,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws SystemException

Throws:

SystemException

getGroupFileEntriesCount

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

Throws:

SystemException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long userId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    throws SystemException

Throws:

SystemException

hasFileEntryLock

public static boolean hasFileEntryLock(HttpPrincipal httpPrincipal,
                                       long fileEntryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

isFileEntryCheckedOut

public static boolean isFileEntryCheckedOut(HttpPrincipal httpPrincipal,
                                            long fileEntryId)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

moveFileEntry

public static DLFileEntry moveFileEntry(HttpPrincipal httpPrincipal,
                                        long fileEntryId,
                                        long newFolderId,
                                        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

revertFileEntry

public static void revertFileEntry(HttpPrincipal httpPrincipal,
                                   long fileEntryId,
                                   String version,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(HttpPrincipal httpPrincipal,
                                          long fileEntryId,
                                          String sourceFileName,
                                          String mimeType,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          long fileEntryTypeId,
                                          Map<String,Fields> fieldsMap,
                                          File file,
                                          InputStream is,
                                          long size,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

verifyFileEntryCheckOut

public static boolean verifyFileEntryCheckOut(HttpPrincipal httpPrincipal,
                                              long fileEntryId,
                                              String lockUuid)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

verifyFileEntryLock

public static boolean verifyFileEntryLock(HttpPrincipal httpPrincipal,
                                          long fileEntryId,
                                          String lockUuid)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException