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

java.lang.Object
  com.liferay.portlet.documentlibrary.service.http.DLFileEntryServiceSoap

public class DLFileEntryServiceSoap
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 SOAP 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 is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to an array of com.liferay.portlet.documentlibrary.model.DLFileEntrySoap. If the method in the service utility returns a com.liferay.portlet.documentlibrary.model.DLFileEntry, that is translated to a com.liferay.portlet.documentlibrary.model.DLFileEntrySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/tunnel-web/secure/axis. Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

DLFileEntrySoap, DLFileEntryServiceUtil, DLFileEntryServiceHttp

Constructor Summary

DLFileEntryServiceSoap()

Method Summary

static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap	addFileEntry(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.DLFileEntrySoap	addFileEntry(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 void	deleteFileEntry(long folderId, java.lang.String name)
static void	deleteFileEntry(long folderId, java.lang.String name, double version)
static void	deleteFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[]	getFileEntries(long folderId)
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap	getFileEntry(long folderId, java.lang.String name)
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap	getFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
static boolean	hasFileEntryLock(long folderId, java.lang.String name)
static com.liferay.lock.model.Lock	lockFileEntry(long folderId, java.lang.String name)
static com.liferay.lock.model.Lock	lockFileEntry(long folderId, java.lang.String name, java.lang.String owner, long expirationTime)
static com.liferay.lock.model.Lock	refreshFileEntryLock(java.lang.String lockUuid, long expirationTime)
static void	unlockFileEntry(long folderId, java.lang.String name)
static void	unlockFileEntry(long folderId, java.lang.String name, java.lang.String lockUuid)
static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap	updateFileEntry(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(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

Constructor Detail

DLFileEntryServiceSoap

public DLFileEntryServiceSoap()

Method Detail

addFileEntry

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap addFileEntry(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 java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addFileEntry

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap addFileEntry(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 java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteFileEntry

public static void deleteFileEntry(long folderId,
                                   java.lang.String name)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteFileEntry

public static void deleteFileEntry(long folderId,
                                   java.lang.String name,
                                   double version)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteFileEntryByTitle

public static void deleteFileEntryByTitle(long folderId,
                                          java.lang.String titleWithExtension)
                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFileEntries

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap[] getFileEntries(long folderId)
                                                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFileEntry

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntry(long folderId,
                                                                                     java.lang.String name)
                                                                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFileEntryByTitle

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap getFileEntryByTitle(long folderId,
                                                                                            java.lang.String titleWithExtension)
                                                                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

hasFileEntryLock

public static boolean hasFileEntryLock(long folderId,
                                       java.lang.String name)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

lockFileEntry

public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
                                                        java.lang.String name)
                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

lockFileEntry

public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
                                                        java.lang.String name,
                                                        java.lang.String owner,
                                                        long expirationTime)
                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

refreshFileEntryLock

public static com.liferay.lock.model.Lock refreshFileEntryLock(java.lang.String lockUuid,
                                                               long expirationTime)
                                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unlockFileEntry

public static void unlockFileEntry(long folderId,
                                   java.lang.String name)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unlockFileEntry

public static void unlockFileEntry(long folderId,
                                   java.lang.String name,
                                   java.lang.String lockUuid)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateFileEntry

public static com.liferay.portlet.documentlibrary.model.DLFileEntrySoap updateFileEntry(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 java.rmi.RemoteException

Throws:

java.rmi.RemoteException

verifyFileEntryLock

public static boolean verifyFileEntryLock(long folderId,
                                          java.lang.String name,
                                          java.lang.String lockUuid)
                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException