Package com.logicaldoc.webservice.soap.client

Class SoapFolderClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<FolderService>

com.logicaldoc.webservice.soap.client.SoapFolderClient

All Implemented Interfaces:

FolderService

public class SoapFolderClient
extends SoapClient<FolderService>
implements FolderService

Folder Web Service client.

Since:

7.5

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapFolderClient(String endpoint)
SoapFolderClient(String endpoint, int gzipThreshold, boolean log, int timeout)

Method Summary

Modifier and Type	Method	Description
void	copy(String sid, long folderId, long parentId, int foldersOnly, String securityOption)	Copies an existing folder with the given identifier.
WSFolder	create(String sid, WSFolder folder)	Creates a new folder.
WSFolder	createAlias(String sid, long parentId, long foldRef)	Creates a new folder alias
long	createFolder(String sid, long parentId, String name)	Create a new folder.
WSFolder	createPath(String sid, long parentId, String path)	Creates the folder for the specified path.
void	delete(String sid, long folderId)	Deletes an existing folder.
WSFolder	findByPath(String sid, String path)	Finds the folder at the specified path
List<WSAccessControlEntry>	getAccessControlList(String sid, long folderId)	Retrieves the access control list
WSFolder	getDefaultWorkspace(String sid)	Gets the Default workspace
WSFolder	getFolder(String sid, long folderId)	Gets an existing folder
List<WSFolder>	getPath(String sid, long folderId)	Computes the path from the root to the target folder.
WSFolder	getRootFolder(String sid)	Gets root metadata
boolean	isGranted(String sid, long folderId, String permission)	Tests if the current user has a specific permission on a folder
boolean	isReadable(String sid, long folderId)	Tests if a folder is readable.
boolean	isWritable(String sid, long folderId)	Tests if a folder is writable
List<WSFolder>	list(String sid, long folderId, String sort, Integer page, Integer max)	Lists all direct folders of a parent folder. Attention: readable sub-folders only are returned.
List<WSFolder>	listChildren(String sid, long folderId)	Lists all direct folders of a parent folder. Attention: readable only sub-folders are returned.
List<WSFolder>	listWorkspaces(String sid)	Retrieves the list of all workspaces.
void	merge(String sid, long sourceId, long targetId)	Merges the contents of folder into a target
void	move(String sid, long folderId, long parentId)	Moves an existing folder with the given identifier.
void	rename(String sid, long folderId, String name)	Renames an existing folder.
void	setAccessControlList(String sid, long folderId, List<WSAccessControlEntry> acl)	Sets the Access Control List
void	update(String sid, WSFolder folder)	Updates an existing folder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoapFolderClient

public SoapFolderClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapFolderClient

public SoapFolderClient(String endpoint)

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 interface FolderService

Parameters:

sid - Session identifier

folder - value object containing the folder's metadata

Returns:

The value object containing the folder's metadata

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

parentId - The parent's ID

name - The new folder's name

Returns:

The newly created folder ID

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

A value object containing the folder's metadata

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

True if the identifier denotes a readable folder, otherwise false.

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

move

public void move(String sid,
 long folderId,
 long parentId)
          throws AuthenticationException,
PersistenceException,
WebserviceException,
PermissionException

Description copied from interface: FolderService

Moves an existing folder with the given identifier.

Specified by:

move in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

parentId - The folder id of the new parent folder

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

PermissionException - The user does not have the required permission

copy

public void copy(String sid,
 long folderId,
 long parentId,
 int foldersOnly,
 String securityOption)
          throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Description copied from interface: FolderService

Copies an existing folder with the given identifier.

Specified by:

copy in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

parentId - The folder id of the target folder

foldersOnly - If 1, only the folders will be copied and not the documents

securityOption - 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 session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

PermissionException - The user does not have the required permission

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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

name - The new folder name

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

listChildren

public List<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 interface FolderService

Parameters:

sid - identifier of th session

folderId - identifier of the folder

Returns:

List of folders contained in the folder

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

list

public List<WSFolder> list(String sid,
 long folderId,
 String sort,
 Integer page,
 Integer max)
                    throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Description copied from interface: FolderService

Lists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.

Specified by:

list in interface FolderService

Parameters:

sid - identifier of th session

folderId - identifier of the folder

sort - Optional sort criteria (eg creation asc)

page - Optional page number

max - Optional maximum number of elements per page

Returns:

List of folders contained in the folder

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

PermissionException - The user does not have the required permission

getRootFolder

public WSFolder getRootFolder(String sid)
                       throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: FolderService

Gets root metadata

Specified by:

getRootFolder in interface FolderService

Parameters:

sid - Session identifier

Returns:

A value object containing the folder's metadata

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

Returns:

A value object containing the workspace's metadata

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

True if the identifier denotes a writable folder, otherwise false

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getPath

public List<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 interface FolderService

Parameters:

sid - Session identifier

folderId - The target folder id

Returns:

The list of folder, the first is the root, the last is the target folder

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

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 interface FolderService

Parameters:

sid - Session identifier

folder - The folders metadata(please compile the ID)

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

parentId - The parent folder

path - The folder's path(for example /Default/dog/cat/mouse)

Returns:

the folder that represents the given path

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

listWorkspaces

public List<WSFolder> listWorkspaces(String sid)
                              throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: FolderService

Retrieves the list of all workspaces.

Specified by:

listWorkspaces in interface FolderService

Parameters:

sid - Session identifier

Returns:

list of workspaces

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

path - The folder's path(for example /Default/dog/cat/mouse)

Returns:

The created folder

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

isGranted

public boolean isGranted(String sid,
 long folderId,
 String 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 interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

permission - The permission to check (eg: 'read', 'write', ...)

Returns:

True if the identifier denotes a granted permission, otherwise false

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

parentId - The parent folder

foldRef - The referenced folder

Returns:

The newly created alias

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface FolderService

Parameters:

sid - Session identifier

sourceId - Identifier of the source folder

targetId - Identifier of the target folder

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAccessControlList

public List<WSAccessControlEntry> getAccessControlList(String sid,
 long folderId)
                                                throws AuthenticationException,
WebserviceException,
PersistenceException,
PermissionException

Description copied from interface: FolderService

Retrieves the access control list

Specified by:

getAccessControlList in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

PermissionException - The permission has not been granted

setAccessControlList

public void setAccessControlList(String sid,
 long folderId,
 List<WSAccessControlEntry> acl)
                          throws PersistenceException,
PermissionException,
AuthenticationException,
WebserviceException

Description copied from interface: FolderService

Sets the Access Control List

Specified by:

setAccessControlList in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

acl - the complete Access Control List

Throws:

PersistenceException - Error in the database

PermissionException - The user does not have the required permission

AuthenticationException - Invalid session

WebserviceException - Error in the webservice