com.liferay.portlet.documentlibrary.service.http
Class DLFileEntryServiceHttp
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFileEntryServiceHttp
@ProviderType
public class DLFileEntryServiceHttp
- extends Object
Provides the 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.
|
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,DDMFormValues> ddmFormValuesMap,
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 void |
checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String lockUuid,
ServiceContext serviceContext)
|
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 status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static List<DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static List<DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static List<DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static int |
getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId)
|
static int |
getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status)
|
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<DLFileEntry> obc)
|
static List<DLFileEntry> |
getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long repositoryId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static List<DLFileEntry> |
getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
|
static int |
getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId)
|
static int |
getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long repositoryId,
long rootFolderId,
String[] mimeTypes,
int status)
|
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 boolean |
isKeepFileVersionLabel(HttpPrincipal httpPrincipal,
long fileEntryId,
ServiceContext serviceContext)
|
static DLFileEntry |
moveFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
|
static Lock |
refreshFileEntryLock(HttpPrincipal httpPrincipal,
String lockUuid,
long companyId,
long expirationTime)
|
static void |
revertFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String version,
ServiceContext serviceContext)
|
static Hits |
search(HttpPrincipal httpPrincipal,
long groupId,
long creatorUserId,
int status,
int start,
int end)
|
static Hits |
search(HttpPrincipal httpPrincipal,
long groupId,
long creatorUserId,
long folderId,
String[] mimeTypes,
int status,
int start,
int end)
|
static DLFileEntry |
updateFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
long fileEntryTypeId,
Map<String,DDMFormValues> ddmFormValuesMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
|
static DLFileEntry |
updateStatus(HttpPrincipal httpPrincipal,
long userId,
long fileVersionId,
int status,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext)
|
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 |
DLFileEntryServiceHttp
public DLFileEntryServiceHttp()
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,DDMFormValues> ddmFormValuesMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
cancelCheckOut
public static DLFileVersion cancelCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
checkInFileEntry
public static void checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
boolean major,
String changeLog,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
checkInFileEntry
public static void checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String lockUuid)
throws PortalException
- Throws:
PortalException
checkInFileEntry
public static void checkInFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String lockUuid,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String owner,
long expirationTime)
throws PortalException
- Throws:
PortalException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
copyFileEntry
public static DLFileEntry copyFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String title)
throws PortalException
- Throws:
PortalException
deleteFileVersion
public static void deleteFileVersion(HttpPrincipal httpPrincipal,
long fileEntryId,
String version)
throws PortalException
- Throws:
PortalException
fetchFileEntryByImageId
public static DLFileEntry fetchFileEntryByImageId(HttpPrincipal httpPrincipal,
long imageId)
throws PortalException
- Throws:
PortalException
getFileAsStream
public static InputStream getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
String version)
throws PortalException
- Throws:
PortalException
getFileAsStream
public static InputStream getFileAsStream(HttpPrincipal httpPrincipal,
long fileEntryId,
String version,
boolean incrementCounter)
throws PortalException
- Throws:
PortalException
getFileEntries
public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getFileEntries
public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getFileEntries
public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getFileEntries
public static List<DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId)
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status)
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
long fileEntryTypeId)
getFileEntriesCount
public static int getFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes)
getFileEntry
public static DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
getFileEntry
public static DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String title)
throws PortalException
- Throws:
PortalException
getFileEntryByUuidAndGroupId
public static DLFileEntry getFileEntryByUuidAndGroupId(HttpPrincipal httpPrincipal,
String uuid,
long groupId)
throws PortalException
- Throws:
PortalException
getFileEntryLock
public static Lock getFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
getFoldersFileEntriesCount
public static int getFoldersFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
List<Long> folderIds,
int status)
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long repositoryId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc)
throws PortalException
- Throws:
PortalException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId)
throws PortalException
- Throws:
PortalException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long repositoryId,
long rootFolderId,
String[] mimeTypes,
int status)
throws PortalException
- Throws:
PortalException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(HttpPrincipal httpPrincipal,
long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
throws PortalException
- Throws:
PortalException
hasFileEntryLock
public static boolean hasFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
isFileEntryCheckedOut
public static boolean isFileEntryCheckedOut(HttpPrincipal httpPrincipal,
long fileEntryId)
throws PortalException
- Throws:
PortalException
isKeepFileVersionLabel
public static boolean isKeepFileVersionLabel(HttpPrincipal httpPrincipal,
long fileEntryId,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
moveFileEntry
public static DLFileEntry moveFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
refreshFileEntryLock
public static Lock refreshFileEntryLock(HttpPrincipal httpPrincipal,
String lockUuid,
long companyId,
long expirationTime)
throws PortalException
- Throws:
PortalException
revertFileEntry
public static void revertFileEntry(HttpPrincipal httpPrincipal,
long fileEntryId,
String version,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
search
public static Hits search(HttpPrincipal httpPrincipal,
long groupId,
long creatorUserId,
int status,
int start,
int end)
throws PortalException
- Throws:
PortalException
search
public static Hits search(HttpPrincipal httpPrincipal,
long groupId,
long creatorUserId,
long folderId,
String[] mimeTypes,
int status,
int start,
int end)
throws PortalException
- Throws:
PortalException
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,DDMFormValues> ddmFormValuesMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException
- Throws:
PortalException
updateStatus
public static DLFileEntry updateStatus(HttpPrincipal httpPrincipal,
long userId,
long fileVersionId,
int status,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext)
throws PortalException
- Throws:
PortalException
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(HttpPrincipal httpPrincipal,
long fileEntryId,
String lockUuid)
throws PortalException
- Throws:
PortalException
verifyFileEntryLock
public static boolean verifyFileEntryLock(HttpPrincipal httpPrincipal,
long fileEntryId,
String lockUuid)
throws PortalException
- Throws:
PortalException