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
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.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 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
,
DLFileEntryServiceUtil
,
DLFileEntryServiceSoap
Method Summary |
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes,
boolean addCommunityPermissions,
boolean addGuestPermissions)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
java.io.File file,
boolean addCommunityPermissions,
boolean addGuestPermissions)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
java.io.File file,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
|
static void |
deleteFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
|
static void |
deleteFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
double version)
|
static void |
deleteFileEntryByTitle(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String titleWithExtension)
|
static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> |
getFileEntries(HttpPrincipal httpPrincipal,
long folderId)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
getFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
getFileEntryByTitle(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String titleWithExtension)
|
static boolean |
hasFileEntryLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
|
static com.liferay.lock.model.Lock |
lockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
|
static com.liferay.lock.model.Lock |
lockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String owner,
long expirationTime)
|
static com.liferay.lock.model.Lock |
refreshFileEntryLock(HttpPrincipal httpPrincipal,
java.lang.String lockUuid,
long expirationTime)
|
static void |
unlockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
|
static void |
unlockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String lockUuid)
|
static com.liferay.portlet.documentlibrary.model.DLFileEntry |
updateFileEntry(HttpPrincipal httpPrincipal,
long folderId,
long newFolderId,
java.lang.String name,
java.lang.String sourceFileName,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes)
|
static boolean |
verifyFileEntryLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
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 folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
java.io.File file,
boolean addCommunityPermissions,
boolean addGuestPermissions)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes,
boolean addCommunityPermissions,
boolean addGuestPermissions)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
java.io.File file,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
addFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
deleteFileEntry
public static void deleteFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
double version)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
deleteFileEntryByTitle
public static void deleteFileEntryByTitle(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String titleWithExtension)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFileEntries
public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(HttpPrincipal httpPrincipal,
long folderId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getFileEntryByTitle
public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String titleWithExtension)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
hasFileEntryLock
public static boolean hasFileEntryLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
lockFileEntry
public static com.liferay.lock.model.Lock lockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
lockFileEntry
public static com.liferay.lock.model.Lock lockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String owner,
long expirationTime)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
refreshFileEntryLock
public static com.liferay.lock.model.Lock refreshFileEntryLock(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
unlockFileEntry
public static void unlockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name)
throws com.liferay.portal.SystemException
- Throws:
com.liferay.portal.SystemException
unlockFileEntry
public static void unlockFileEntry(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String lockUuid)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateFileEntry
public static com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(HttpPrincipal httpPrincipal,
long folderId,
long newFolderId,
java.lang.String name,
java.lang.String sourceFileName,
java.lang.String title,
java.lang.String description,
java.lang.String[] tagsEntries,
java.lang.String extraSettings,
byte[] bytes)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
verifyFileEntryLock
public static boolean verifyFileEntryLock(HttpPrincipal httpPrincipal,
long folderId,
java.lang.String name,
java.lang.String lockUuid)
throws com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException