com.liferay.portlet.documentlibrary.service.http
Class DLFileEntryServiceHttp

java.lang.Object
  extended bycom.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

Constructor Summary
DLFileEntryServiceHttp()
           
 
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[] byteArray, 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[] byteArray, 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 com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(HttpPrincipal httpPrincipal, long folderId, java.lang.String name)
           
static void lockFileEntry(HttpPrincipal httpPrincipal, long folderId, java.lang.String name)
           
static void unlockFileEntry(HttpPrincipal httpPrincipal, long folderId, java.lang.String name)
           
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[] byteArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryServiceHttp

public DLFileEntryServiceHttp()
Method Detail

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[] byteArray,
                                                                                 boolean addCommunityPermissions,
                                                                                 boolean addGuestPermissions)
                                                                          throws com.liferay.portal.SystemException,
                                                                                 com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

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[] byteArray,
                                                                                 java.lang.String[] communityPermissions,
                                                                                 java.lang.String[] guestPermissions)
                                                                          throws com.liferay.portal.SystemException,
                                                                                 com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteFileEntry

public static void deleteFileEntry(HttpPrincipal httpPrincipal,
                                   long folderId,
                                   java.lang.String name)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteFileEntry

public static void deleteFileEntry(HttpPrincipal httpPrincipal,
                                   long folderId,
                                   java.lang.String name,
                                   double version)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getFileEntry

public static com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(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 void lockFileEntry(HttpPrincipal httpPrincipal,
                                 long folderId,
                                 java.lang.String name)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unlockFileEntry

public static void unlockFileEntry(HttpPrincipal httpPrincipal,
                                   long folderId,
                                   java.lang.String name)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

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[] byteArray)
                                                                             throws com.liferay.portal.SystemException,
                                                                                    com.liferay.portal.PortalException,
                                                                                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException