java.lang.Object
- com.logicaldoc.webservice.AbstractService
- - com.logicaldoc.webservice.soap.endpoint.SoapFolderService
  - - com.logicaldoc.webservice.rest.endpoint.RestFolderService

All Implemented Interfaces:: FolderService, FolderService

Direct Known Subclasses:: RestFolderSwagger

@Path("/")
@Consumes("application/json")
@Produces("application/json")
public class RestFolderService
extends SoapFolderService
implements FolderService

Constructor Summary

Constructors
Constructor Description

RestFolderService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`copy(long folderId, long targetId, int foldersOnly, String securityOption)`	Copies an existing folder with the given identifier.
`WSFolder`	`create(WSFolder folder)`
`WSFolder`	`createAlias(long parentId, long foldRef)`	Creates a new folder alias
`long`	`createFolder(long parentId, String name)`
`WSFolder`	`createPath(long parentId, String path)`
`WSFolder`	`createSimple(String folderPath)`
`WSFolder`	`createSimpleForm(String folderPath)`
`WSFolder`	`createSimpleJSON(String jsonstr)`
`void`	`delete(long folderId)`
`WSFolder`	`findByPath(String path)`	Finds the folder at the specified path
`WSFolder`	`getDefaultWorkspace()`	Gets the Default workspace
`WSFolder`	`getFolder(long folderId)`
`WSRight[]`	`getGrantedGroups(long folderId)`	Retrieves the list of granted groups for the given folder
`WSRight[]`	`getGrantedUsers(long folderId)`	Retrieves the list of granted users for the given folder.
`WSFolder[]`	`getPath(long folderId)`
`String`	`getPathString(long folderId)`
`WSFolder`	`getRootFolder()`	Gets the root folder
`void`	`grantGroup(long folderId, long groupId, int permissions, boolean recursive)`	Grants group permission to the folder
`void`	`grantUser(long folderId, long userId, int permissions, boolean recursive)`	Grants user permission to the folder.
`boolean`	`isGranted(long folderId, int permission)`	Tests if the current user has a specific permission on a folder
`boolean`	`isReadable(long folderId)`	Tests if a folder is readable.
`boolean`	`isWritable(long folderId)`	Tests if a folder is writable
`WSFolder[]`	`listChildren(long folderId)`
`WSFolder[]`	`listWorkspaces()`	Retrieves the list of all workspaces.
`void`	`move(long folderId, long parentId)`	Moves an existing folder with the given identifier.
`void`	`rename(long folderId, String name)`	Renames an existing folder.
`void`	`update(WSFolder folder)`	Updates an existing folder.

Methods inherited from class com.logicaldoc.webservice.soap.endpoint.SoapFolderService
copy, create, createAlias, createFolder, createPath, delete, findByPath, getDefaultWorkspace, getFolder, getGrantedGroups, getGrantedUsers, getPath, getRootFolder, grantGroup, grantUser, isGranted, isReadable, isWritable, listChildren, listWorkspaces, merge, move, rename, update

Methods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RestFolderService
```
public RestFolderService()
```

Method Detail

create

@POST
@Path("/create")
public WSFolder create(WSFolder folder)
                throws AuthenticationException,
                       PermissionException,
                       WebserviceException,
                       PersistenceException

Specified by:: create in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

createSimpleForm

@POST
@Path("/createSimpleForm")
@Consumes("application/x-www-form-urlencoded")
public WSFolder createSimpleForm(@FormParam("folderPath")
                                 String folderPath)
                          throws AuthenticationException,
                                 PermissionException,
                                 WebserviceException,
                                 PersistenceException

Specified by:: createSimpleForm in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

createSimpleJSON

@POST
@Path("/createSimpleJSON")
@Consumes("application/json")
public WSFolder createSimpleJSON(String jsonstr)
                          throws AuthenticationException,
                                 PermissionException,
                                 WebserviceException,
                                 PersistenceException

Specified by:: createSimpleJSON in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

createSimple

@POST
@Path("/createSimple")
@Consumes({"text/plain","application/json"})
public WSFolder createSimple(String folderPath)
                      throws AuthenticationException,
                             PermissionException,
                             WebserviceException,
                             PersistenceException

Specified by:: createSimple in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

createPath

@POST
@Path("/createPath")
@Consumes("application/x-www-form-urlencoded")
public WSFolder createPath(@FormParam("parentId")
                           long parentId,
                           @FormParam("path")
                           String path)
                    throws AuthenticationException,
                           PermissionException,
                           WebserviceException,
                           PersistenceException

Specified by:: createPath in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

findByPath

@GET
@Path("/findByPath")
@Produces("application/json")
public WSFolder findByPath(@QueryParam("path")
                           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:: path - the path
Returns:: the folder
Throws:: AuthenticationException - Invalid credentials; PermissionException - The current user does not have enough permissions; WebserviceException - A generic error in the WebService; PersistenceException - Error in the database

getRootFolder

@GET
@Path("/getRootFolder")
@Produces("application/json")
public WSFolder getRootFolder()
                       throws AuthenticationException,
                              WebserviceException,
                              PersistenceException

Description copied from interface: FolderService

Gets the root folder

Specified by:: getRootFolder in interface FolderService
Returns:: the root folder
Throws:: AuthenticationException - Invalid credentials; WebserviceException - A generic error in the WebService; PersistenceException - Error in the database

createFolder

@POST
@Path("/createFolder")
@Consumes("application/x-www-form-urlencoded")
@Produces({"text/plain","application/json","application/xml"})
public long createFolder(@FormParam("parentId")
                         long parentId,
                         @FormParam("name")
                         String name)
                  throws AuthenticationException,
                         PermissionException,
                         WebserviceException,
                         PersistenceException

Specified by:: createFolder in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

getFolder

@GET
@Path("/getFolder")
@Produces({"application/json","application/xml"})
public WSFolder getFolder(@QueryParam("folderId")
                          long folderId)
                   throws AuthenticationException,
                          PermissionException,
                          WebserviceException,
                          PersistenceException

Specified by:: getFolder in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

delete

@DELETE
@Path("/delete")
public void delete(@QueryParam("folderId")
                   long folderId)
            throws AuthenticationException,
                   PermissionException,
                   WebserviceException,
                   PersistenceException

Specified by:: delete in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

listChildren

@GET
@Path("/listChildren")
@Produces({"application/json","application/xml"})
public WSFolder[] listChildren(@QueryParam("folderId")
                               long folderId)
                        throws AuthenticationException,
                               PermissionException,
                               WebserviceException,
                               PersistenceException

Specified by:: listChildren in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

getPath

@GET
@Path("/getPath")
public WSFolder[] getPath(@QueryParam("folderId")
                          long folderId)
                   throws AuthenticationException,
                          PermissionException,
                          WebserviceException,
                          PersistenceException

Specified by:: getPath in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

getPathString

@GET
@Path("/getPathString")
public String getPathString(@QueryParam("folderId")
                            long folderId)
                     throws AuthenticationException,
                            PermissionException,
                            WebserviceException,
                            PersistenceException

Specified by:: getPathString in interface FolderService
Throws:: AuthenticationException; PermissionException; WebserviceException; PersistenceException

update
```
@POST
@Path("/update")
public void update(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:

folder - The folders metadata(please compile the ID)

Throws:

AuthenticationException - Invalid credentials

PermissionException - The current user does not have enough permissions

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

rename

@PUT
@Path("/rename")
public void rename(@QueryParam("folderId")
                   long folderId,
                   @QueryParam("name")
                   String name)
            throws AuthenticationException,
                   PermissionException,
                   WebserviceException,
                   PersistenceException

Description copied from interface: FolderService

Renames an existing folder.

Specified by:: rename in interface FolderService
Parameters:: folderId - The folder id; name - The new folder name
Throws:: AuthenticationException - Invalid credentials; PermissionException - The current user does not have enough permissions; WebserviceException - A generic error in the WebService; PersistenceException - Error in the database

move
```
@PUT
@Path("/move")
public void move(@QueryParam("folderId")
                 long folderId,
                 @QueryParam("parentId")
                 long parentId)
          throws AuthenticationException,
                 PersistenceException,
                 WebserviceException
```
Description copied from interface: FolderService

Moves an existing folder with the given identifier.

Specified by:

move in interface FolderService

Parameters:

folderId - The folder id

parentId - The folder id of the new parent folder

Throws:

AuthenticationException - Invalid credentials

PersistenceException - Error in the database

WebserviceException - A generic error in the WebService

createAlias

@POST
@Path("/createAlias")
@Consumes("application/x-www-form-urlencoded")
public WSFolder createAlias(@FormParam("parentId")
                            long parentId,
                            @FormParam("foldRef")
                            long foldRef)
                     throws AuthenticationException,
                            PermissionException,
                            WebserviceException,
                            PersistenceException

Description copied from interface: FolderService

Creates a new folder alias

Specified by:: createAlias in interface FolderService
Parameters:: parentId - The parent folder; foldRef - The referenced folder
Returns:: The newly created alias
Throws:: AuthenticationException - Invalid credentials; PermissionException - The current user does not have enough permissions; WebserviceException - A generic error in the WebService; PersistenceException - Error in the database

getDefaultWorkspace
```
@GET
@Path("/getDefaultWorkspace")
public WSFolder getDefaultWorkspace()
                             throws AuthenticationException,
                                    PermissionException,
                                    WebserviceException,
                                    PersistenceException
```
Description copied from interface: FolderService

Gets the Default workspace

Specified by:

getDefaultWorkspace in interface FolderService

Returns:

A value object containing the workspace's metadata

Throws:

AuthenticationException - Invalid credentials

PermissionException - The current user does not have enough permissions

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

listWorkspaces
```
@GET
@Path("/listWorkspaces")
public WSFolder[] listWorkspaces()
                          throws AuthenticationException,
                                 WebserviceException,
                                 PersistenceException
```
Description copied from interface: FolderService

Retrieves the list of all workspaces.

Specified by:

listWorkspaces in interface FolderService

Returns:

the list of all workspaces

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

isReadable
```
@GET
@Path("/isReadable")
public boolean isReadable(@QueryParam("folderId")
                          long folderId)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException
```
Description copied from interface: FolderService

Tests if a folder is readable.

Specified by:

isReadable in interface FolderService

Parameters:

folderId - The folder id

Returns:

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

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

isWritable
```
@GET
@Path("/isWritable")
public boolean isWritable(@QueryParam("folderId")
                          long folderId)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException
```
Description copied from interface: FolderService

Tests if a folder is writable

Specified by:

isWritable in interface FolderService

Parameters:

folderId - The folder id

Returns:

True if the identifier denotes a writable folder, otherwise false

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

isGranted
```
@GET
@Path("/isGranted")
public boolean isGranted(@QueryParam("folderId")
                         long folderId,
                         @QueryParam("permission")
                         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 interface FolderService

Parameters:

folderId - The folder id

permission - The permission representation

Returns:

True if the identifier denotes a granted permission, otherwise false

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

copy
```
@POST
@Path("/copy")
@Consumes("application/x-www-form-urlencoded")
public void copy(@FormParam("folderId")
                 long folderId,
                 @FormParam("targetId")
                 long targetId,
                 @FormParam("foldersOnly")
                 int foldersOnly,
                 @FormParam("securityOption")
                 String securityOption)
          throws AuthenticationException,
                 WebserviceException,
                 PersistenceException
```
Description copied from interface: FolderService

Copies an existing folder with the given identifier.
Specified by:

copy in interface FolderService

Parameters:

folderId - The folder id

targetId - 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 credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

grantUser
```
@PUT
@Path("/grantUser")
public void grantUser(@QueryParam("folderId")
                      long folderId,
                      @QueryParam("userId")
                      long userId,
                      @QueryParam("permissions")
                      int permissions,
                      @QueryParam("recursive")
                      boolean recursive)
               throws PermissionException,
                      AuthenticationException,
                      PersistenceException,
                      WebserviceException
```
Description copied from interface: FolderService

Grants user permission to the folder.

Specified by:

grantUser in interface FolderService

Parameters:

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:

PermissionException - The current user does not have enough permissions

AuthenticationException - Invalid credentials

PersistenceException - Error in the database

WebserviceException - A generic error in the WebService

grantGroup

@PUT
@Path("/grantGroup")
public void grantGroup(@QueryParam("folderId")
                       long folderId,
                       @QueryParam("groupId")
                       long groupId,
                       @QueryParam("permissions")
                       int permissions,
                       @QueryParam("recursive")
                       boolean recursive)
                throws PermissionException,
                       AuthenticationException,
                       PersistenceException,
                       WebserviceException

Description copied from interface: FolderService

Grants group permission to the folder

Specified by:: grantGroup in interface FolderService
Parameters:: 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:: PermissionException - The current user does not have enough permissions; AuthenticationException - Invalid credentials; PersistenceException - Error in the database; WebserviceException - A generic error in the WebService

getGrantedGroups
```
@GET
@Path("/getGrantedGroups")
public WSRight[] getGrantedGroups(@QueryParam("folderId")
                                  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 interface FolderService

Parameters:

folderId - Folder id

Returns:

'error' if error occurred, the right objects collection

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

getGrantedUsers
```
@GET
@Path("/getGrantedUsers")
public WSRight[] getGrantedUsers(@QueryParam("folderId")
                                 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 interface FolderService

Parameters:

folderId - Folder id

Returns:

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

Throws:

AuthenticationException - Invalid credentials

WebserviceException - A generic error in the WebService

PersistenceException - Error in the database

Class RestFolderService

Constructor Summary

Method Summary

Methods inherited from class com.logicaldoc.webservice.soap.endpoint.SoapFolderService

Methods inherited from class com.logicaldoc.webservice.AbstractService

Methods inherited from class java.lang.Object

Constructor Detail

RestFolderService

Method Detail

create

createSimpleForm

createSimpleJSON

createSimple

createPath

findByPath

getRootFolder

createFolder

getFolder

delete

listChildren

getPath

getPathString

update

rename

move

createAlias

getDefaultWorkspace

listWorkspaces

isReadable

isWritable

isGranted

copy

grantUser

grantGroup

getGrantedGroups

getGrantedUsers