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, String[] tags)	Adds tags to a document
void	addFolderTags(long folderId, String[] tags)	Adds tags to a folder
WSDocument[]	findDocumentsByTag(String tag)	Finds authorized documents for the current user having a specified tag
WSFolder[]	findFoldersByTag(String tag)	Finds authorized folders for the current user having a specified tag.
String[]	getDocumentTags(long docId)	Retrieves all the tags of a document
String[]	getFolderTags(long folderId)	Retrieves all the tags of a folder
WSTagCloud[]	getTagCloud()	Retrieves all tag clouds in the repository
String[]	getTags()	Retrieves all the tags in the repository
String[]	getTagsPreset()	Retrieves all the tags in the preset (if the input mode is preset).
void	setDocumentTags(long docId, String[] tags)	Sets the tags of a document
void	setFolderTags(long folderId, 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, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession

Methods inherited from class java.lang.Object

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

Constructor Detail

RestTagService

public RestTagService()

Method Detail

setDocumentTags

@POST
@Path("/setDocumentTags")
@Consumes("application/x-www-form-urlencoded")
public void setDocumentTags(@FormParam("docId")
                            long docId,
                            @FormParam("tag")
                            String[] tags)
                     throws Exception

Description copied from interface: TagService

Sets the tags of a document

Specified by:

setDocumentTags in interface TagService

Parameters:

docId - identifier of the document

tags - array of tags

Throws:

Exception - error in the server application

addDocumentTags

@POST
@Path("/addDocumentTags")
@Consumes("application/x-www-form-urlencoded")
public void addDocumentTags(@FormParam("docId")
                            long docId,
                            @FormParam("tag")
                            String[] tags)
                     throws Exception

Description copied from interface: TagService

Adds tags to a document

Specified by:

addDocumentTags in interface TagService

Parameters:

docId - identifier of the document

tags - array of tags

Throws:

Exception - error in the server application

getDocumentTags

@GET
@Path("/getDocumentTags")
public String[] getDocumentTags(@QueryParam("docId")
                                long docId)
                         throws Exception

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:

Exception - error in the server application

setFolderTags

@POST
@Path("/setFolderTags")
@Consumes("application/x-www-form-urlencoded")
public void setFolderTags(@FormParam("folderId")
                          long folderId,
                          @FormParam("tag")
                          String[] tags)
                   throws Exception

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:

Exception - error in the server application

addFolderTags

@POST
@Path("/addFolderTags")
@Consumes("application/x-www-form-urlencoded")
public void addFolderTags(@FormParam("folderId")
                          long folderId,
                          @FormParam("tag")
                          String[] tags)
                   throws Exception

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:

Exception - error in the server application

getFolderTags

@GET
@Path("/getFolderTags")
public String[] getFolderTags(@QueryParam("folderId")
                              long folderId)
                       throws Exception

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:

Exception - error in the server application

getTags

@GET
@Path("/getTags")
public String[] getTags()
                 throws Exception

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:

Exception - error in the server application

getTagCloud

@GET
@Path("/getTagCloud")
public WSTagCloud[] getTagCloud()
                         throws Exception

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:

Exception - error in the server application

findDocumentsByTag

@GET
@Path("/findDocumentsByTag")
public WSDocument[] findDocumentsByTag(@QueryParam("tag")
                                       String tag)
                                throws Exception

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:

Exception - error in the server application

findFoldersByTag

@GET
@Path("/findFoldersByTag")
public WSFolder[] findFoldersByTag(@QueryParam("tag")
                                   String tag)
                            throws Exception

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:

Exception - error in the server application

getTagsPreset

@GET
@Path("/getTagsPreset")
public String[] getTagsPreset()
                       throws Exception

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:

Exception - error in the server application