com.liferay.portlet.documentlibrary.service.http
Class DLFileEntryServiceHttp
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFileEntryServiceHttp
public class DLFileEntryServiceHttp
- extends java.lang.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.
- Author:
- Brian Wing Shun Chan
- See Also:
DLFileEntryServiceSoap,
HttpPrincipal,
DLFileEntryServiceUtil- Generated:
|
Method Summary |
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
addFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
long fileEntryTypeId,
java.util.Map<java.lang.String,com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
java.io.File file,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
|
static void |
cancelCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static void |
checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
boolean major,
java.lang.String changeLog,
com.liferay.portal.service.ServiceContext serviceContext)
|
static void |
checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String lockUuid)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String owner,
long expirationTime)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
copyFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
|
static void |
deleteFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static void |
deleteFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String title)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
fetchFileEntryByImageId(HttpPrincipal httpPrincipal,
long imageId)
|
static java.io.InputStream |
getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version)
|
static java.io.InputStream |
getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version,
boolean incrementCounter)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String[] mimeTypes,
int start,
int end,
com.liferay.portal.kernel.util.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,
java.lang.String[] mimeTypes)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
getFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
getFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String title)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal,
java.lang.String uuid,
long groupId)
|
static com.liferay.portal.model.Lock |
getFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static int |
getFoldersFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
java.util.List<java.lang.Long> folderIds,
int status)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
|
static int |
getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId)
|
static int |
getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
|
static boolean |
hasFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static boolean |
isFileEntryCheckedOut(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static com.liferay.portal.model.Lock |
lockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static com.liferay.portal.model.Lock |
lockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String owner,
long expirationTime)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
moveFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
|
static com.liferay.portal.model.Lock |
refreshFileEntryLock(HttpPrincipal httpPrincipal,
java.lang.String lockUuid,
long expirationTime)
|
static void |
revertFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version,
com.liferay.portal.service.ServiceContext serviceContext)
|
static void |
unlockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
|
static void |
unlockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String lockUuid)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
updateFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
long fileEntryTypeId,
java.util.Map<java.lang.String,com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
java.io.File file,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
|
static boolean |
verifyFileEntryCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String lockUuid)
|
static boolean |
verifyFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String lockUuid)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLFileEntryServiceHttp
public DLFileEntryServiceHttp()
addFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
long fileEntryTypeId,
java.util.Map<java.lang.String,com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
java.io.File file,
java.io.InputStream is,
long size,
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
cancelCheckOut
public static void cancelCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId)
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
checkInFileEntry
public static void checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
boolean major,
java.lang.String changeLog,
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
checkInFileEntry
public static void checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
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
checkOutFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
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
checkOutFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String owner,
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
copyFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry copyFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
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
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
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
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String title)
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
fetchFileEntryByImageId
public static com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByImageId(HttpPrincipal httpPrincipal,
long imageId)
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
getFileAsStream
public static java.io.InputStream getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version)
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
getFileAsStream
public static java.io.InputStream getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version,
boolean incrementCounter)
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
getFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
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
getFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId,
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
getFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String[] mimeTypes,
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
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String[] mimeTypes)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
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
getFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
java.lang.String title)
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
getFileEntryByUuidAndGroupId
public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal,
java.lang.String uuid,
long groupId)
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
getFileEntryLock
public static com.liferay.portal.model.Lock getFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getFoldersFileEntriesCount
public static int getFoldersFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
java.util.List<java.lang.Long> folderIds,
int status)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getGroupFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
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
getGroupFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
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
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws com.liferay.portal.kernel.exception.SystemException
- Throws:
com.liferay.portal.kernel.exception.SystemException
hasFileEntryLock
public static boolean hasFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
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
isFileEntryCheckedOut
public static boolean isFileEntryCheckedOut(HttpPrincipal httpPrincipal,
long fileEntryId)
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
lockFileEntry
public static com.liferay.portal.model.Lock lockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
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
lockFileEntry
public static com.liferay.portal.model.Lock lockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String owner,
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
moveFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
long newFolderId,
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
refreshFileEntryLock
public static com.liferay.portal.model.Lock refreshFileEntryLock(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
revertFileEntry
public static void revertFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String version,
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
unlockFileEntry
public static void unlockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
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
unlockFileEntry
public static void unlockFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
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
updateFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
long fileEntryTypeId,
java.util.Map<java.lang.String,com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
java.io.File file,
java.io.InputStream is,
long size,
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
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId,
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
verifyFileEntryLock
public static boolean verifyFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId,
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