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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDocumentTags(long docId, String[] tags)
Adds tags to a documentvoid
addFolderTags(long folderId, String[] tags)
Adds tags to a folderWSDocument[]
findDocumentsByTag(String tag)
Finds authorized documents for the current user having a specified tagWSFolder[]
findFoldersByTag(String tag)
Finds authorized folders for the current user having a specified tag.String[]
getDocumentTags(long docId)
Retrieves all the tags of a documentString[]
getFolderTags(long folderId)
Retrieves all the tags of a folderWSTagCloud[]
getTagCloud()
Retrieves all tag clouds in the repositoryString[]
getTags()
Retrieves all the tags in the repositoryString[]
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 documentvoid
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
-
-
-
-
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 interfaceTagService
- Parameters:
docId
- identifier of the documenttags
- 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 interfaceTagService
- Parameters:
docId
- identifier of the documenttags
- 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 interfaceTagService
- 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 interfaceTagService
- Parameters:
folderId
- identifier of the foldertags
- 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 interfaceTagService
- Parameters:
folderId
- identifier of the foldertags
- 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 interfaceTagService
- 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 interfaceTagService
- 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 interfaceTagService
- 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 interfaceTagService
- 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 interfaceTagService
- 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 interfaceTagService
- Returns:
- The tags in the preset
- Throws:
Exception
- error in the server application
-
-