com.logicaldoc.webservice.folder

Class FolderClient

java.lang.Object

com.logicaldoc.webservice.AbstractClient<FolderService>

com.logicaldoc.webservice.folder.FolderClient

All Implemented Interfaces:

FolderService

public class FolderClient
extends AbstractClient<FolderService>
implements FolderService

Folder Web Service client.

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.webservice.AbstractClient

client, endpoint

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
WSFolder	create(String sid, WSFolder folder) 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 with the given identifier.
WSFolder	findByPath(String sid, String path) Finds the folder at the specified path
WSFolder	getDefaultWorkspace(String sid) Gets the Default workspace
WSFolder	getFolder(String sid, long folderId) Gets folder metadata of an existing folder with the given identifier.
Right[]	getGrantedGroups(String sid, long folderId) Retrieves the list of granted groups for the given folder.
Right[]	getGrantedUsers(String sid, long folderId) Retrieves the list of granted users for the given folder.
WSFolder[]	getPath(String sid, long folderId) Computes the path from the root to the target folder.
WSFolder	getRootFolder(String sid) Gets root metadata
void	grantGroup(String sid, long folderId, long groupId, int permissions, boolean recursive) Grant group permission to the folder.
void	grantUser(String sid, long folderId, long userId, int permissions, boolean recursive) Grant user permission to the folder.
boolean	isGranted(String sid, long folderId, int permission) Test if the current user has a specific permission.
boolean	isReadable(String sid, long folderId) Test if a folder identifier is readable.
boolean	isWriteable(String sid, long folderId) Test if a folder identifier is writeable.
WSFolder[]	listChildren(String sid, long folderId) Lists all direct folders of a parent folder.
WSFolder[]	listWorkspaces(String sid) Retrieves the list of all workspaces.
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 with the given identifier.
void	update(String sid, WSFolder folder) Updates an existing folder.

Methods inherited from class com.logicaldoc.webservice.AbstractClient

configureSSL, configureTimeout, initClient

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderClient

public FolderClient(String endpoint,
            int gzipThreshold,
            boolean log,
            int timeout)
             throws IOException

Throws:

IOException

FolderClient

public FolderClient(String endpoint)
             throws IOException

Throws:

IOException

Method Detail

create

public WSFolder create(String sid,
              WSFolder folder)
                throws Exception

Description copied from interface: FolderService

Create 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:

Exception

delete

public void delete(String sid,
          long folderId)
            throws Exception

Description copied from interface: FolderService

Deletes an existing folder with the given identifier.

Specified by:

delete in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Throws:

Exception

getFolder

public WSFolder getFolder(String sid,
                 long folderId)
                   throws Exception

Description copied from interface: FolderService

Gets folder metadata of an existing folder with the given identifier.

Specified by:

getFolder in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

A value object containing the folder's metadata.

Throws:

Exception

isReadable

public boolean isReadable(String sid,
                 long folderId)
                   throws Exception

Description copied from interface: FolderService

Test if a folder identifier 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:

Exception

move

public void move(String sid,
        long folderId,
        long parentId)
          throws Exception

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:

Exception

rename

public void rename(String sid,
          long folderId,
          String name)
            throws Exception

Description copied from interface: FolderService

Renames an existing folder with the given identifier.

Specified by:

rename in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

name - The new folder name

Throws:

Exception

listChildren

public WSFolder[] listChildren(String sid,
                      long folderId)
                        throws Exception

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 - Session identifier

Returns:

Array of folders contained in the folder

Throws:

Exception

getRootFolder

public WSFolder getRootFolder(String sid)
                       throws Exception

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:

Exception

getDefaultWorkspace

public WSFolder getDefaultWorkspace(String sid)
                             throws Exception

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:

Exception

isWriteable

public boolean isWriteable(String sid,
                  long folderId)
                    throws Exception

Description copied from interface: FolderService

Test if a folder identifier is writeable.

Specified by:

isWriteable in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

Returns:

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

Throws:

Exception

getPath

public WSFolder[] getPath(String sid,
                 long folderId)
                   throws Exception

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:

Exception

getGrantedGroups

public Right[] getGrantedGroups(String sid,
                       long folderId)
                         throws Exception

Description copied from interface: FolderService

Retrieves the list of granted groups for the given folder.

Specified by:

getGrantedGroups in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection.

Throws:

Exception

getGrantedUsers

public Right[] getGrantedUsers(String sid,
                      long folderId)
                        throws Exception

Description copied from interface: FolderService

Retrieves the list of granted users for the given folder.

Specified by:

getGrantedUsers in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection.

Throws:

Exception

grantGroup

public void grantGroup(String sid,
              long folderId,
              long groupId,
              int permissions,
              boolean recursive)
                throws Exception

Description copied from interface: FolderService

Grant group permission to the folder.

Specified by:

grantGroup in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

groupId - Group Id

permissions - 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:

Exception

grantUser

public void grantUser(String sid,
             long folderId,
             long userId,
             int permissions,
             boolean recursive)
               throws Exception

Description copied from interface: FolderService

Grant user permission to the folder.

Specified by:

grantUser in interface FolderService

Parameters:

sid - Session identifier

folderId - Folder id

userId - User Id

permissions - 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:

Exception

update

public void update(String sid,
          WSFolder folder)
            throws Exception

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:

Exception

createPath

public WSFolder createPath(String sid,
                  long parentId,
                  String path)
                    throws Exception

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 path(for example /Default/dog/cat/mouse)

Returns:

The created folder

Throws:

Exception

listWorkspaces

public WSFolder[] listWorkspaces(String sid)
                          throws Exception

Description copied from interface: FolderService

Retrieves the list of all workspaces.

Specified by:

listWorkspaces in interface FolderService

Parameters:

sid - Session identifier

Returns:

the list of all workspaces

Throws:

Exception

findByPath

public WSFolder findByPath(String sid,
                  String path)
                    throws Exception

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 path(for example /Default/dog/cat/mouse)

Returns:

The created folder

Throws:

Exception

isGranted

public boolean isGranted(String sid,
                long folderId,
                int permission)
                  throws Exception

Description copied from interface: FolderService

Test if the current user has a specific permission.

Specified by:

isGranted in interface FolderService

Parameters:

sid - Session identifier

folderId - The folder id

permission - The permission representation

Returns:

True if the identifier denotes a granted permission, otherwise false.

Throws:

Exception