com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceHttp
java.lang.Object
com.liferay.portlet.documentlibrary.service.http.DLFolderServiceHttp
public class DLFolderServiceHttp
- extends java.lang.Object
View Source
ServiceBuilder generated this class. Modifications in this class will be
overwritten the next time is generated.
This class provides a HTTP utility for the
com.liferay.portlet.documentlibrary.service.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 com.liferay.portal.security.auth.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:
HttpPrincipal
,
DLFolderServiceUtil
,
DLFolderServiceSoap
Method Summary |
static com.liferay.portlet.documentlibrary.model.DLFolder |
addFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
|
static com.liferay.portlet.documentlibrary.model.DLFolder |
copyFolder(HttpPrincipal httpPrincipal,
long groupId,
long sourceFolderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
|
static void |
deleteFolder(HttpPrincipal httpPrincipal,
long folderId)
|
static void |
deleteFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
|
static com.liferay.portlet.documentlibrary.model.DLFolder |
getFolder(HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.portlet.documentlibrary.model.DLFolder |
getFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
|
static long |
getFolderId(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> |
getFolders(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
|
static boolean |
hasInheritableLock(HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.lock.model.Lock |
lockFolder(HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.lock.model.Lock |
lockFolder(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String owner,
boolean inheritable,
long expirationTime)
|
static com.liferay.lock.model.Lock |
refreshFolderLock(HttpPrincipal httpPrincipal,
java.lang.String lockUuid,
long expirationTime)
|
static void |
reIndexSearch(HttpPrincipal httpPrincipal,
long companyId)
|
static void |
unlockFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name,
java.lang.String lockUuid)
|
static void |
unlockFolder(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String lockUuid)
|
static com.liferay.portlet.documentlibrary.model.DLFolder |
updateFolder(HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
|
static boolean |
verifyInheritableLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.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.portlet.documentlibrary.model.DLFolder addFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
copyFolder
public static com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(HttpPrincipal httpPrincipal,
long groupId,
long sourceFolderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
deleteFolder
public static void deleteFolder(HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
deleteFolder
public static void deleteFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
getFolder
public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolder
public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolderId
public static long getFolderId(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFolders
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
hasInheritableLock
public static boolean hasInheritableLock(HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
lockFolder
public static com.liferay.lock.model.Lock lockFolder(HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
lockFolder
public static com.liferay.lock.model.Lock lockFolder(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String owner,
boolean inheritable,
long expirationTime)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
refreshFolderLock
public static com.liferay.lock.model.Lock refreshFolderLock(HttpPrincipal httpPrincipal,
java.lang.String lockUuid,
long expirationTime)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
reIndexSearch
public static void reIndexSearch(HttpPrincipal httpPrincipal,
long companyId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
unlockFolder
public static void unlockFolder(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String lockUuid)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unlockFolder
public static void unlockFolder(HttpPrincipal httpPrincipal,
long groupId,
long parentFolderId,
java.lang.String name,
java.lang.String lockUuid)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateFolder
public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(HttpPrincipal httpPrincipal,
long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException,
java.rmi.RemoteException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException
verifyInheritableLock
public static boolean verifyInheritableLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String lockUuid)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException