|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portlet.documentlibrary.service.http.DLAppServiceSoap
public class DLAppServiceSoap
This class provides a SOAP utility for the
DLAppServiceUtil
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.
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/api/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.
The SOAP utility is only generated for remote services.
DLAppServiceHttp
,
DLAppServiceUtil
Constructor Summary | |
---|---|
DLAppServiceSoap()
|
Method Summary | |
---|---|
static DLFileShortcutSoap |
addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds a file shortcut to the existing file entry. |
static void |
cancelCheckOut(long fileEntryId)
Cancels the check out of the file entry. |
static void |
checkInFileEntry(long fileEntryId,
boolean majorVersion,
String changeLog,
ServiceContext serviceContext)
Checks in the file entry. |
static void |
checkInFileEntry(long fileEntryId,
String lockUuid)
Checks in the file entry using the lock's UUID. |
static void |
checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
Check out a file entry. |
static void |
deleteFileEntry(long fileEntryId)
Deletes the file entry with the primary key. |
static void |
deleteFileEntryByTitle(long repositoryId,
long folderId,
String title)
Deletes the file entry with the title in the folder. |
static void |
deleteFileShortcut(long fileShortcutId)
Deletes the file shortcut with the primary key. |
static void |
deleteFolder(long folderId)
Deletes the folder with the primary key and all of its subfolders and file entries. |
static void |
deleteFolder(long repositoryId,
long parentFolderId,
String name)
Deletes the folder with the name in the parent folder and all of its subfolders and file entries. |
static void |
deleteTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName)
Deletes the temporary file entry. |
static int |
getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
Returns the number of file entries and shortcuts in the folder. |
static int |
getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes)
Returns the number of file entries and shortcuts in the folder. |
static int |
getFileEntriesCount(long repositoryId,
long folderId)
Returns the number of file entries in the folder. |
static int |
getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the number of file entries with the file entry type in the folder. |
static DLFileShortcutSoap |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key. |
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder. |
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
|
static int |
getFoldersCount(long repositoryId,
long parentFolderId)
Returns the number of immediate subfolders of the parent folder. |
static int |
getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories. |
static int |
getFoldersFileEntriesCount(long repositoryId,
Long[] folderIds,
int status)
Returns the number of immediate subfolders and file entries across the folders. |
static int |
getGroupFileEntriesCount(long groupId,
long userId)
Returns the number of file entries in a group starting at the repository default parent folder that are stored within the Liferay repository. |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
Returns the number of file entries in a group starting at the root folder that are stored within the Liferay repository. |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
|
static int |
getMountFoldersCount(long repositoryId,
long parentFolderId)
Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static Long[] |
getSubfolderIds(long repositoryId,
long folderId)
Returns all the descendant folders of the folder with the primary key. |
static void |
getSubfolderIds(long repositoryId,
Long[] folderIds,
long folderId)
|
static Long[] |
getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
Returns descendant folders of the folder with the primary key, optionally limiting to one level deep. |
static String[] |
getTempFileEntryNames(long groupId,
long folderId,
String tempFolderName)
Returns all the temporary file entry names. |
static void |
revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
Reverts the file entry to a previous version. |
static void |
unlockFileEntry(long fileEntryId)
|
static void |
unlockFileEntry(long fileEntryId,
String lockUuid)
|
static void |
unlockFolder(long repositoryId,
long folderId,
String lockUuid)
Unlocks the folder. |
static void |
unlockFolder(long repositoryId,
long parentFolderId,
String name,
String lockUuid)
Unlocks the folder. |
static DLFileShortcutSoap |
updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry. |
static boolean |
verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
Returns true if the file entry is checked out. |
static boolean |
verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid)
|
static boolean |
verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
Returns true if the inheritable lock exists. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DLAppServiceSoap()
Method Detail |
---|
public static DLFileShortcutSoap addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException
- if the parent folder or file entry could not be
found, or if the file shortcut's information was invalid
SystemException
- if a system exception occurred
RemoteException
public static void cancelCheckOut(long fileEntryId) throws RemoteException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to cancel the
checkout
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
checkInFileEntry(long, boolean, String, ServiceContext)
,
#checkOutFileEntry(long)
public static void checkInFileEntry(long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext) throws RemoteException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to check inmajorVersion
- whether the new file version is a major versionchangeLog
- the file's version change logserviceContext
- the service context to be applied
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
cancelCheckOut(long)
,
#checkOutFileEntry(long)
public static void checkInFileEntry(long fileEntryId, String lockUuid) throws RemoteException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to check inlockUuid
- the lock's universally unique identifier
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
cancelCheckOut(long)
,
#checkOutFileEntry(long, String, long)
public static void checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws RemoteException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the file entry to check outserviceContext
- the service context to be applied
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
cancelCheckOut(long)
,
checkInFileEntry(long, boolean, String, ServiceContext)
public static void deleteFileEntry(long fileEntryId) throws RemoteException
fileEntryId
- the primary key of the file entry
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
public static void deleteFileEntryByTitle(long repositoryId, long folderId, String title) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldertitle
- the file entry's title
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
public static void deleteFileShortcut(long fileShortcutId) throws RemoteException
fileShortcutId
- the primary key of the file shortcut
PortalException
- if the file shortcut could not be found
SystemException
- if a system exception occurred
RemoteException
public static void deleteFolder(long folderId) throws RemoteException
folderId
- the primary key of the folder
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static void deleteFolder(long repositoryId, long parentFolderId, String name) throws RemoteException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static void deleteTempFileEntry(long groupId, long folderId, String fileName, String tempFolderName) throws RemoteException
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry was
eventually to residefileName
- the file's original nametempFolderName
- the temporary folder's name
PortalException
- if the file name was invalid
SystemException
- if a system exception occurred
RemoteException
TempFileUtil
public static int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow status
PortalException
- if the folder ould not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusmimeTypes
- allowed media types
PortalException
- if the folder ould not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFileEntriesCount(long repositoryId, long folderId) throws RemoteException
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folder
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFileEntriesCount(long repositoryId, long folderId, long fileEntryTypeId) throws RemoteException
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry type
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static DLFileShortcutSoap getFileShortcut(long fileShortcutId) throws RemoteException
fileShortcutId
- the primary key of the file shortcut
PortalException
- if the file shortcut could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, boolean includeMountFolders) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for
third-party repositories
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) throws RemoteException
RemoteException
public static int getFoldersCount(long repositoryId, long parentFolderId) throws RemoteException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFoldersCount(long repositoryId, long parentFolderId, boolean includeMountFolders) throws RemoteException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for
third-party repositories
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getFoldersFileEntriesCount(long repositoryId, Long[] folderIds, int status) throws RemoteException
repositoryId
- the primary key of the repositoryfolderIds
- the primary keys of folders from which to count
immediate subfolders and file entriesstatus
- the workflow status
PortalException
- if the repository could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId) throws RemoteException
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws RemoteException
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)rootFolderId
- the primary key of the root folder to begin the
search
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
RemoteException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws RemoteException
RemoteException
public static int getMountFoldersCount(long repositoryId, long parentFolderId) throws RemoteException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folder
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
RemoteException
public static void getSubfolderIds(long repositoryId, Long[] folderIds, long folderId) throws RemoteException
RemoteException
public static Long[] getSubfolderIds(long repositoryId, long folderId) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folder
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
RemoteException
public static Long[] getSubfolderIds(long repositoryId, long folderId, boolean recurse) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderrecurse
- whether to recurse through each subfolder
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
RemoteException
public static String[] getTempFileEntryNames(long groupId, long folderId, String tempFolderName) throws RemoteException
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will
eventually residetempFolderName
- the temporary folder's name
PortalException
- if the folder was invalid
SystemException
- if a system exception occurred
RemoteException
#addTempFileEntry(long, long, String, String, File)
,
TempFileUtil
public static void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext) throws RemoteException
fileEntryId
- the primary key of the file entryversion
- the version to revert back toserviceContext
- the service context to be applied
PortalException
- if the file entry or version could not be found
SystemException
- if a system exception occurred
RemoteException
public static void unlockFileEntry(long fileEntryId) throws RemoteException
RemoteException
public static void unlockFileEntry(long fileEntryId, String lockUuid) throws RemoteException
RemoteException
public static void unlockFolder(long repositoryId, long folderId, String lockUuid) throws RemoteException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderlockUuid
- the lock's universally unique identifier
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static void unlockFolder(long repositoryId, long parentFolderId, String name, String lockUuid) throws RemoteException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent foldername
- the folder's namelockUuid
- the lock's universally unique identifier
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
RemoteException
public static DLFileShortcutSoap updateFileShortcut(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws RemoteException
fileShortcutId
- the primary key of the file shortcutfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException
- if the file shortcut, folder, or file entry could
not be found
SystemException
- if a system exception occurred
RemoteException
public static boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, String lockUuid) throws RemoteException
true
if the file entry is checked out. This method
is primarily used by WebDAV.
repositoryId
- the primary key for the repositoryfileEntryId
- the primary key for the file entrylockUuid
- the lock's universally unique identifier
true
if the file entry is checked out;
false
otherwise
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
public static boolean verifyFileEntryLock(long repositoryId, long fileEntryId, String lockUuid) throws RemoteException
RemoteException
public static boolean verifyInheritableLock(long repositoryId, long folderId, String lockUuid) throws RemoteException
true
if the inheritable lock exists. This method is
primarily used by WebDAV.
repositoryId
- the primary key for the repositoryfolderId
- the primary key for the folderlockUuid
- the lock's universally unique identifier
true
if the inheritable lock exists;
false
otherwise
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |