Class SoapFolderClient
java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<FolderService>
com.logicaldoc.webservice.soap.client.SoapFolderClient
- All Implemented Interfaces:
FolderService
Folder Web Service client.
- Since:
- 7.5
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
ConstructorDescriptionSoapFolderClient
(String endpoint) SoapFolderClient
(String endpoint, int gzipThreshold, boolean log, int timeout) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Copies an existing folder with the given identifier.Creates a new folder.createAlias
(String sid, long parentId, long foldRef) Creates a new folder aliaslong
createFolder
(String sid, long parentId, String name) Create a new folder.createPath
(String sid, long parentId, String path) Creates the folder for the specified path.void
Deletes an existing folder.findByPath
(String sid, String path) Finds the folder at the specified pathGets the Default workspaceGets an existing folderWSRight[]
getGrantedGroups
(String sid, long folderId) Retrieves the list of granted groups for the given folderWSRight[]
getGrantedUsers
(String sid, long folderId) Retrieves the list of granted users for the given folder.WSFolder[]
Computes the path from the root to the target folder.getRootFolder
(String sid) Gets root metadatavoid
grantGroup
(String sid, long folderId, long groupId, int permissions, boolean recursive) Grants group permission to the foldervoid
Grants user permission to the folder.boolean
Tests if the current user has a specific permission on a folderboolean
isReadable
(String sid, long folderId) Tests if a folder is readable.boolean
isWritable
(String sid, long folderId) Tests if a folder is writableWSFolder[]
listChildren
(String sid, long folderId) Lists all direct folders of a parent folder.
Attention: readable only sub-folders are returned.WSFolder[]
listWorkspaces
(String sid) Retrieves the list of all workspaces.void
Merges the contents of folder into a targetvoid
Moves an existing folder with the given identifier.void
Renames an existing folder.void
Updates an existing folder.
-
Constructor Details
-
SoapFolderClient
-
SoapFolderClient
-
-
Method Details
-
create
public WSFolder create(String sid, WSFolder folder) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Creates a new folder. The user can completely customize the folder through a value object containing the folder's metadata- Specified by:
create
in interfaceFolderService
- Parameters:
sid
- Session identifierfolder
- value object containing the folder's metadata- Returns:
- The value object containing the folder's metadata
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
createFolder
public long createFolder(String sid, long parentId, String name) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Create a new folder.- Specified by:
createFolder
in interfaceFolderService
- Parameters:
sid
- Session identifierparentId
- The parent's IDname
- The new folder's name- Returns:
- The newly created folder ID
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
delete
public void delete(String sid, long folderId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Deletes an existing folder.- Specified by:
delete
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder id- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getFolder
public WSFolder getFolder(String sid, long folderId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Gets an existing folder- Specified by:
getFolder
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder id- Returns:
- A value object containing the folder's metadata
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
isReadable
public boolean isReadable(String sid, long folderId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Tests if a folder is readable.- Specified by:
isReadable
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder id- Returns:
- True if the identifier denotes a readable folder, otherwise false.
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
move
public void move(String sid, long folderId, long parentId) throws AuthenticationException, PersistenceException, WebserviceException Description copied from interface:FolderService
Moves an existing folder with the given identifier.- Specified by:
move
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder idparentId
- The folder id of the new parent folder- Throws:
AuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
copy
public void copy(String sid, long folderId, long parentId, int foldersOnly, String securityOption) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Copies an existing folder with the given identifier.- Specified by:
copy
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder idparentId
- The folder id of the target folderfoldersOnly
- If 1, only the folders will be copied and not the documentssecurityOption
- How to assign the security policies to the newly created folders:- null or none: empty security policies
- inherit: the new folder will point to the parent for the security policies
- replicate: the new folder will have a copy of the security policies of the source folder
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
rename
public void rename(String sid, long folderId, String name) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Renames an existing folder.- Specified by:
rename
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder idname
- The new folder name- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
listChildren
public WSFolder[] listChildren(String sid, long folderId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Lists all direct folders of a parent folder.
Attention: readable only sub-folders are returned.- Specified by:
listChildren
in interfaceFolderService
- Parameters:
sid
- identifier of th sessionfolderId
- identifier of the folder- Returns:
- Array of folders contained in the folder
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getRootFolder
public WSFolder getRootFolder(String sid) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Gets root metadata- Specified by:
getRootFolder
in interfaceFolderService
- Parameters:
sid
- Session identifier- Returns:
- A value object containing the folder's metadata
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getDefaultWorkspace
public WSFolder getDefaultWorkspace(String sid) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Gets the Default workspace- Specified by:
getDefaultWorkspace
in interfaceFolderService
- Parameters:
sid
- Session identifier- Returns:
- A value object containing the workspace's metadata
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
isWritable
public boolean isWritable(String sid, long folderId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Tests if a folder is writable- Specified by:
isWritable
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder id- Returns:
- True if the identifier denotes a writable folder, otherwise false
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getPath
public WSFolder[] getPath(String sid, long folderId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Computes the path from the root to the target folder.- Specified by:
getPath
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The target folder id- Returns:
- The list of folder, the first is the root, the last is the target folder
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getGrantedGroups
public WSRight[] getGrantedGroups(String sid, long folderId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Retrieves the list of granted groups for the given folder- Specified by:
getGrantedGroups
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- Folder id- Returns:
- 'error' if error occurred, the right objects collection
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getGrantedUsers
public WSRight[] getGrantedUsers(String sid, long folderId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Retrieves the list of granted users for the given folder.- Specified by:
getGrantedUsers
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- Folder id- Returns:
- 'error' if error occurred, the right objects collection.
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
grantGroup
public void grantGroup(String sid, long folderId, long groupId, int permissions, boolean recursive) throws PermissionException, AuthenticationException, PersistenceException, WebserviceException Description copied from interface:FolderService
Grants group permission to the folder- Specified by:
grantGroup
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- Folder idgroupId
- Group Idpermissions
- the permission integer representation. If '0', the group will be not granted to access the folder.recursive
- recursion option. If true, the grant operation is applied also to the subfolders- Throws:
PermissionException
- The user does not have the required permissionAuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
grantUser
public void grantUser(String sid, long folderId, long userId, int permissions, boolean recursive) throws PermissionException, AuthenticationException, PersistenceException, WebserviceException Description copied from interface:FolderService
Grants user permission to the folder.- Specified by:
grantUser
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- Folder iduserId
- User Idpermissions
- the permission integer representation. If '0', the user will be not granted to access the folder.recursive
- recursion option. If true, the grant operation is applied also to the subfolders.- Throws:
PermissionException
- The user does not have the required permissionAuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
update
public void update(String sid, WSFolder folder) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Updates an existing folder. To perform this you need the RENAME permission.- Specified by:
update
in interfaceFolderService
- Parameters:
sid
- Session identifierfolder
- The folders metadata(please compile the ID)- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
createPath
public WSFolder createPath(String sid, long parentId, String path) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Creates the folder for the specified path. All unexisting nodes specified in the path will be created- Specified by:
createPath
in interfaceFolderService
- Parameters:
sid
- Session identifierparentId
- The parent folderpath
- The folder's path(for example /Default/dog/cat/mouse)- Returns:
- the folder that represents the given path
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
listWorkspaces
public WSFolder[] listWorkspaces(String sid) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Retrieves the list of all workspaces.- Specified by:
listWorkspaces
in interfaceFolderService
- Parameters:
sid
- Session identifier- Returns:
- array of workspaces
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
findByPath
public WSFolder findByPath(String sid, String path) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Finds the folder at the specified path- Specified by:
findByPath
in interfaceFolderService
- Parameters:
sid
- Session identifierpath
- The folder's path(for example /Default/dog/cat/mouse)- Returns:
- The created folder
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
isGranted
public boolean isGranted(String sid, long folderId, int permission) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:FolderService
Tests if the current user has a specific permission on a folder- Specified by:
isGranted
in interfaceFolderService
- Parameters:
sid
- Session identifierfolderId
- The folder idpermission
- The permission representation- Returns:
- True if the identifier denotes a granted permission, otherwise false
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
createAlias
public WSFolder createAlias(String sid, long parentId, long foldRef) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Creates a new folder alias- Specified by:
createAlias
in interfaceFolderService
- Parameters:
sid
- Session identifierparentId
- The parent folderfoldRef
- The referenced folder- Returns:
- The newly created alias
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
merge
public void merge(String sid, long sourceId, long targetId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:FolderService
Merges the contents of folder into a target- Specified by:
merge
in interfaceFolderService
- Parameters:
sid
- Session identifiersourceId
- Identifier of the source foldertargetId
- Identifier of the target folder- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-