com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceHttp
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFolderServiceHttp
@ProviderType
public class DLFolderServiceHttp
- extends Object
Provides the 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- {$generated.description}
|
Method Summary |
static com.liferay.document.library.kernel.model.DLFolder |
addFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
boolean mountPoint,
long parentFolderId,
String name,
String description,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
|
static void |
deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static void |
deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
boolean includeTrashedEntries)
|
static void |
deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name)
|
static List<Object> |
getFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
int start,
int end)
|
static int |
getFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status)
|
static int |
getFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes)
|
static com.liferay.document.library.kernel.model.DLFolder |
getFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.document.library.kernel.model.DLFolder |
getFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name)
|
static List<Long> |
getFolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId)
|
static List<com.liferay.document.library.kernel.model.DLFolder> |
getFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int status,
boolean includeMountfolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
|
static List<com.liferay.document.library.kernel.model.DLFolder> |
getFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
|
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc)
|
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc)
|
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
boolean includeMountFolders,
com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
boolean includeMountFolders)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
boolean includeMountFolders,
com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
|
static int |
getFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
|
static int |
getFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int status,
boolean includeMountfolders)
|
static List<com.liferay.document.library.kernel.model.DLFolder> |
getMountFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
|
static int |
getMountFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
|
static void |
getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
List<Long> folderIds,
long groupId,
long folderId)
|
static void |
getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
List<Long> folderIds,
long groupId,
long folderId,
boolean recurse)
|
static List<Long> |
getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
boolean recurse)
|
static boolean |
hasFolderLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static boolean |
hasInheritableLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static boolean |
isFolderLocked(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.portal.kernel.lock.Lock |
lockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.portal.kernel.lock.Lock |
lockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
|
static com.liferay.document.library.kernel.model.DLFolder |
moveFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
|
static com.liferay.portal.kernel.lock.Lock |
refreshFolderLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
String lockUuid,
long companyId,
long expirationTime)
|
static void |
unlockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name,
String lockUuid)
|
static void |
unlockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String lockUuid)
|
static com.liferay.document.library.kernel.model.DLFolder |
updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
int restrictionType,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
|
static com.liferay.document.library.kernel.model.DLFolder |
updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
boolean overrideFileEntryTypes,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
|
static com.liferay.document.library.kernel.model.DLFolder |
updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
int restrictionType,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
|
static boolean |
verifyInheritableLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String lockUuid)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLFolderServiceHttp
public DLFolderServiceHttp()
addFolder
public static com.liferay.document.library.kernel.model.DLFolder addFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long repositoryId,
boolean mountPoint,
long parentFolderId,
String name,
String description,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
deleteFolder
public static void deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
deleteFolder
public static void deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
boolean includeTrashedEntries)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
deleteFolder
public static void deleteFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFileEntriesAndFileShortcuts
public static List<Object> getFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
int start,
int end)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFolder
public static com.liferay.document.library.kernel.model.DLFolder getFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFolder
public static com.liferay.document.library.kernel.model.DLFolder getFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFolderIds
public static List<Long> getFolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFolders
public static List<com.liferay.document.library.kernel.model.DLFolder> getFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int status,
boolean includeMountfolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFolders
public static List<com.liferay.document.library.kernel.model.DLFolder> getFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
boolean includeMountFolders,
com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
boolean includeMountFolders)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
String[] mimeTypes,
boolean includeMountFolders,
com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersCount
public static int getFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getFoldersCount
public static int getFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int status,
boolean includeMountfolders)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getMountFolders
public static List<com.liferay.document.library.kernel.model.DLFolder> getMountFolders(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFolder> obc)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getMountFoldersCount
public static int getMountFoldersCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getSubfolderIds
public static void getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
List<Long> folderIds,
long groupId,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getSubfolderIds
public static void getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
List<Long> folderIds,
long groupId,
long folderId,
boolean recurse)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
getSubfolderIds
public static List<Long> getSubfolderIds(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long folderId,
boolean recurse)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
hasFolderLock
public static boolean hasFolderLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
hasInheritableLock
public static boolean hasInheritableLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
isFolderLocked
public static boolean isFolderLocked(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
lockFolder
public static com.liferay.portal.kernel.lock.Lock lockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
lockFolder
public static com.liferay.portal.kernel.lock.Lock lockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
moveFolder
public static com.liferay.document.library.kernel.model.DLFolder moveFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
refreshFolderLock
public static com.liferay.portal.kernel.lock.Lock refreshFolderLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
String lockUuid,
long companyId,
long expirationTime)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
unlockFolder
public static void unlockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
String name,
String lockUuid)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
unlockFolder
public static void unlockFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String lockUuid)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
updateFolder
public static com.liferay.document.library.kernel.model.DLFolder updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
int restrictionType,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
updateFolder
public static com.liferay.document.library.kernel.model.DLFolder updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
boolean overrideFileEntryTypes,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
updateFolder
public static com.liferay.document.library.kernel.model.DLFolder updateFolder(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String name,
String description,
long defaultFileEntryTypeId,
List<Long> fileEntryTypeIds,
int restrictionType,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException
verifyInheritableLock
public static boolean verifyInheritableLock(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
long folderId,
String lockUuid)
throws com.liferay.portal.kernel.exception.PortalException
- Throws:
com.liferay.portal.kernel.exception.PortalException