io.vertigo.social.webservices.comment

Class CommentWebServices

java.lang.Object

io.vertigo.social.webservices.comment.CommentWebServices

All Implemented Interfaces:

io.vertigo.core.component.Component, io.vertigo.vega.webservice.WebServices

@PathPrefix(value="/x/comment")
public final class CommentWebServices
extends Object
implements io.vertigo.vega.webservice.WebServices

Webservice for Notification extension.

Author:

npiedeloup

Constructor Summary

Constructors

Constructor and Description
CommentWebServices()

Method Summary

Modifier and Type	Method and Description
List<Comment>	getComments(String keyConcept, String id) Gets comments for keyConcept.
Map<String,Object>	getConfig() Returns config.
String	getHelp() Returns help.
Map<String,Object>	getStats() Returns stats.
String	getStatus() Returns status (code 200 or 500)
Comment	publishComment(Comment comment, String keyConcept, String id) Publishes a new comment.
Comment	updateComment(String uuid, Comment comment) Updates a comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentWebServices

public CommentWebServices()

Method Detail

getComments

@GET(value="/api/comments")
public List<Comment> getComments(@QueryParam(value="concept")
                                                              String keyConcept,
                                                              @QueryParam(value="id")
                                                              String id)

Gets comments for keyConcept.

Parameters:

keyConcept - KeyConcept type

id - KeyConcept id

Returns:

comments for keyConcept

publishComment

@POST(value="/api/comments")
public Comment publishComment(@ExcludedFields(value="uuid")
                                                            Comment comment,
                                                            @QueryParam(value="concept")
                                                            String keyConcept,
                                                            @QueryParam(value="id")
                                                            String id)

Publishes a new comment.

Parameters:

comment - Comment msg

keyConcept - KeyConcept type

id - KeyConcept id

updateComment

@PUT(value="/api/comments/{uuid}")
public Comment updateComment(@PathParam(value="uuid")
                                                                 String uuid,
                                                                 Comment comment)

Updates a comment.

Parameters:

uuid - Comment uuid

comment - Comment msg

getStatus

@GET(value="/status")
 @AnonymousAccessAllowed
public String getStatus()

Returns status (code 200 or 500)

Returns:

"OK" or error message

getStats

@GET(value="/stats")
 @AnonymousAccessAllowed
public Map<String,Object> getStats()

Returns stats.

Returns:

"OK" or error message

getConfig

@GET(value="/config")
 @AnonymousAccessAllowed
public Map<String,Object> getConfig()

Returns config.

Returns:

Config object

getHelp

@GET(value="/help")
 @AnonymousAccessAllowed
public String getHelp()

Returns help.

Returns:

Help object