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

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

public class DLFileEntryServiceSoap
extends Object

This class provides a SOAP utility for the 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 List, that is translated to an array of DLFileEntrySoap. If the method in the service utility returns a DLFileEntry, that is translated to a 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.

See Also:

DLFileEntryServiceHttp, DLFileEntrySoap, DLFileEntryServiceUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

DLFileEntryServiceSoap()

Method Summary

static DLFileEntrySoap	addFileEntry(long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static void	deleteFileEntry(long groupId, long folderId, String name)
static void	deleteFileEntry(long groupId, long folderId, String name, String version)
static void	deleteFileEntryByTitle(long groupId, long folderId, String titleWithExtension)
static DLFileEntrySoap[]	getFileEntries(long groupId, long folderId)
static DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, int start, int end)
static DLFileEntrySoap[]	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
static int	getFileEntriesCount(long groupId, long folderId)
static DLFileEntrySoap	getFileEntry(long groupId, long folderId, String name)
static DLFileEntrySoap	getFileEntryByTitle(long groupId, long folderId, String titleWithExtension)
static DLFileEntrySoap	getFileEntryByUuidAndGroupId(String uuid, long groupId)
static int	getFoldersFileEntriesCount(long groupId, Long[] folderIds, int status)
static DLFileEntrySoap[]	getGroupFileEntries(long groupId, long userId, int start, int end)
static DLFileEntrySoap[]	getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator obc)
static int	getGroupFileEntriesCount(long groupId, long userId)
static boolean	hasFileEntryLock(long groupId, long folderId, String name)
static DLFileEntrySoap	moveFileEntry(long groupId, long folderId, long newFolderId, String name, ServiceContext serviceContext)
static void	unlockFileEntry(long groupId, long folderId, String name)
static void	unlockFileEntry(long groupId, long folderId, String name, String lockUuid)
static DLFileEntrySoap	updateFileEntry(long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static boolean	verifyFileEntryLock(long groupId, long folderId, String name, 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 DLFileEntrySoap addFileEntry(long groupId,
                                           long folderId,
                                           String name,
                                           String title,
                                           String description,
                                           String changeLog,
                                           String extraSettings,
                                           byte[] bytes,
                                           ServiceContext serviceContext)
                                    throws RemoteException

Throws:

RemoteException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String name)
                            throws RemoteException

Throws:

RemoteException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String name,
                                   String version)
                            throws RemoteException

Throws:

RemoteException

deleteFileEntryByTitle

public static void deleteFileEntryByTitle(long groupId,
                                          long folderId,
                                          String titleWithExtension)
                                   throws RemoteException

Throws:

RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId)
                                        throws RemoteException

Throws:

RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId,
                                               int start,
                                               int end)
                                        throws RemoteException

Throws:

RemoteException

getFileEntries

public static DLFileEntrySoap[] getFileEntries(long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator obc)
                                        throws RemoteException

Throws:

RemoteException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId)
                               throws RemoteException

Throws:

RemoteException

getFileEntry

public static DLFileEntrySoap getFileEntry(long groupId,
                                           long folderId,
                                           String name)
                                    throws RemoteException

Throws:

RemoteException

getFileEntryByTitle

public static DLFileEntrySoap getFileEntryByTitle(long groupId,
                                                  long folderId,
                                                  String titleWithExtension)
                                           throws RemoteException

Throws:

RemoteException

getFileEntryByUuidAndGroupId

public static DLFileEntrySoap getFileEntryByUuidAndGroupId(String uuid,
                                                           long groupId)
                                                    throws RemoteException

Throws:

RemoteException

getFoldersFileEntriesCount

public static int getFoldersFileEntriesCount(long groupId,
                                             Long[] folderIds,
                                             int status)
                                      throws RemoteException

Throws:

RemoteException

getGroupFileEntries

public static DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                    long userId,
                                                    int start,
                                                    int end)
                                             throws RemoteException

Throws:

RemoteException

getGroupFileEntries

public static DLFileEntrySoap[] getGroupFileEntries(long groupId,
                                                    long userId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator obc)
                                             throws RemoteException

Throws:

RemoteException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId)
                                    throws RemoteException

Throws:

RemoteException

hasFileEntryLock

public static boolean hasFileEntryLock(long groupId,
                                       long folderId,
                                       String name)
                                throws RemoteException

Throws:

RemoteException

moveFileEntry

public static DLFileEntrySoap moveFileEntry(long groupId,
                                            long folderId,
                                            long newFolderId,
                                            String name,
                                            ServiceContext serviceContext)
                                     throws RemoteException

Throws:

RemoteException

unlockFileEntry

public static void unlockFileEntry(long groupId,
                                   long folderId,
                                   String name)
                            throws RemoteException

Throws:

RemoteException

unlockFileEntry

public static void unlockFileEntry(long groupId,
                                   long folderId,
                                   String name,
                                   String lockUuid)
                            throws RemoteException

Throws:

RemoteException

updateFileEntry

public static DLFileEntrySoap updateFileEntry(long groupId,
                                              long folderId,
                                              String name,
                                              String sourceFileName,
                                              String title,
                                              String description,
                                              String changeLog,
                                              boolean majorVersion,
                                              String extraSettings,
                                              byte[] bytes,
                                              ServiceContext serviceContext)
                                       throws RemoteException

Throws:

RemoteException

verifyFileEntryLock

public static boolean verifyFileEntryLock(long groupId,
                                          long folderId,
                                          String name,
                                          String lockUuid)
                                   throws RemoteException

Throws:

RemoteException