Package com.logicaldoc.webservice.rest.endpoint

Class RestTagService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.webservice.soap.endpoint.SoapTagService

com.logicaldoc.webservice.rest.endpoint.RestTagService

All Implemented Interfaces:

TagService, TagService

Direct Known Subclasses:

RestTagSwagger

@Path("/")
@Consumes({"application/xml","application/json"})
@Produces("application/json")
public class RestTagService
extends SoapTagService
implements TagService

Constructor Summary

Constructors

Constructor	Description
RestTagService()

Method Summary

Modifier and Type	Method	Description
void	addDocumentTags(long docId, List<String> tags)	Adds tags to a document
void	addFolderTags(long folderId, List<String> tags)	Adds tags to a folder
List<WSDocument>	findDocumentsByTag(String tag)	Finds authorized documents for the current user having a specified tag
List<WSFolder>	findFoldersByTag(String tag)	Finds authorized folders for the current user having a specified tag.
List<String>	getDocumentTags(long docId)	Retrieves all the tags of a document
List<String>	getFolderTags(long folderId)	Retrieves all the tags of a folder
List<WSTagCloud>	getTagCloud()	Retrieves all tag clouds in the repository
List<String>	getTags()	Retrieves all the tags in the repository
List<String>	getTagsPreset()	Retrieves all the tags in the preset (if the input mode is preset).
void	setDocumentTags(long docId, List<String> tags)	Sets the tags of a document
void	setFolderTags(long folderId, List<String> tags)	Sets the tags of a folder

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

addDocumentTags, addFolderTags, findDocumentsByTag, findFoldersByTag, getDocumentTags, getFolderTags, getTagCloud, getTags, getTagsPreset, setDocumentTags, setFolderTags

Methods inherited from class com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

Methods inherited from class java.lang.Object

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

Constructor Details

RestTagService

public RestTagService()

Method Details

setDocumentTags

@POST
@Path("/setDocumentTags")
@Consumes("application/x-www-form-urlencoded")
public void setDocumentTags(@FormParam("docId")
 long docId,
 @FormParam("tag")
 List<String> tags)
                     throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Description copied from interface: TagService

Sets the tags of a document

Specified by:

setDocumentTags in interface TagService

Parameters:

docId - identifier of the document

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

UnexistingResourceException - The specified document does not exist

addDocumentTags

@POST
@Path("/addDocumentTags")
@Consumes("application/x-www-form-urlencoded")
public void addDocumentTags(@FormParam("docId")
 long docId,
 @FormParam("tag")
 List<String> tags)
                     throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Description copied from interface: TagService

Adds tags to a document

Specified by:

addDocumentTags in interface TagService

Parameters:

docId - identifier of the document

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

UnexistingResourceException - The indicated document does not exist

getDocumentTags

@GET
@Path("/getDocumentTags")
public List<String> getDocumentTags(@QueryParam("docId")
 long docId)
                             throws PermissionException,
AuthenticationException,
PersistenceException,
WebserviceException,
UnexistingResourceException

Description copied from interface: TagService

Retrieves all the tags of a document

Specified by:

getDocumentTags in interface TagService

Parameters:

docId - identifier of the document

Returns:

The tags of the document

Throws:

PermissionException - The user does not have the required permission

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

UnexistingResourceException - The specified document does not exist

setFolderTags

@POST
@Path("/setFolderTags")
@Consumes("application/x-www-form-urlencoded")
public void setFolderTags(@FormParam("folderId")
 long folderId,
 @FormParam("tag")
 List<String> tags)
                   throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Description copied from interface: TagService

Sets the tags of a folder

Specified by:

setFolderTags in interface TagService

Parameters:

folderId - identifier of the folder

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

addFolderTags

@POST
@Path("/addFolderTags")
@Consumes("application/x-www-form-urlencoded")
public void addFolderTags(@FormParam("folderId")
 long folderId,
 @FormParam("tag")
 List<String> tags)
                   throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Description copied from interface: TagService

Adds tags to a folder

Specified by:

addFolderTags in interface TagService

Parameters:

folderId - identifier of the folder

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getFolderTags

@GET
@Path("/getFolderTags")
public List<String> getFolderTags(@QueryParam("folderId")
 long folderId)
                           throws PermissionException,
AuthenticationException,
PersistenceException,
WebserviceException

Description copied from interface: TagService

Retrieves all the tags of a folder

Specified by:

getFolderTags in interface TagService

Parameters:

folderId - identifier of the folder

Returns:

The tags of the folder

Throws:

PermissionException - The user does not have the required permission

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

getTags

@GET
@Path("/getTags")
public List<String> getTags()
                     throws AuthenticationException,
PersistenceException,
WebserviceException

Description copied from interface: TagService

Retrieves all the tags in the repository

Specified by:

getTags in interface TagService

Returns:

The tags in the repository

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

getTagCloud

@GET
@Path("/getTagCloud")
public List<WSTagCloud> getTagCloud()
                             throws AuthenticationException,
PersistenceException,
WebserviceException

Description copied from interface: TagService

Retrieves all tag clouds in the repository

Specified by:

getTagCloud in interface TagService

Returns:

The tags in the repository

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

findDocumentsByTag

@GET
@Path("/findDocumentsByTag")
public List<WSDocument> findDocumentsByTag(@QueryParam("tag")
 String tag)
                                    throws AuthenticationException,
PersistenceException,
WebserviceException

Description copied from interface: TagService

Finds authorized documents for the current user having a specified tag

Specified by:

findDocumentsByTag in interface TagService

Parameters:

tag - Tag of the document

Returns:

Collection of found documents

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

findFoldersByTag

@GET
@Path("/findFoldersByTag")
public List<WSFolder> findFoldersByTag(@QueryParam("tag")
 String tag)
                                throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: TagService

Finds authorized folders for the current user having a specified tag.

Specified by:

findFoldersByTag in interface TagService

Parameters:

tag - Tag of the folder

Returns:

Collection of found folders

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getTagsPreset

@GET
@Path("/getTagsPreset")
public List<String> getTagsPreset()
                           throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: TagService

Retrieves all the tags in the preset (if the input mode is preset).

Specified by:

getTagsPreset in interface TagService

Returns:

The tags in the preset

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database