org.exoplatform.wcm.connector.collaboration

Class CommentConnector

java.lang.Object

org.exoplatform.wcm.connector.BaseConnector

org.exoplatform.wcm.connector.collaboration.CommentConnector

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class CommentConnector
extends BaseConnector
implements org.exoplatform.services.rest.resource.ResourceContainer

The CommentConnector aims to manage and use comments for the content.

eXo level API

Experimental

eXo anchor for generated doc on REST API

CommentConnector

Field Summary

Fields inherited from class org.exoplatform.wcm.connector.BaseConnector

fileHandler, fileUploadHandler, folderHandler, IF_MODIFIED_SINCE_DATE_FORMAT, LAST_MODIFIED_PROPERTY, linkManager, livePortalManagerService, repositoryService, votingService, webSchemaConfigService

Constructor Summary

Constructors

Constructor and Description
CommentConnector(CommentsService commentsService) Instantiates a new tag connector.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addComment(String jcrPath, String comment) Adds a new comment to the content.
javax.ws.rs.core.Response	deleteComment(String jcrPath, String commentId) Delete a comment of a content.
javax.ws.rs.core.Response	getComments(String jcrPath) Gets all comments for a specific content.
protected String	getContentStorageType() Gets the content storage type.
protected javax.jcr.Node	getNode(String jcrPath) Get the jcr node of the given jcr path
protected javax.jcr.Node	getRootContentStorage(javax.jcr.Node parentNode) Gets the root content storage.

Methods inherited from class org.exoplatform.wcm.connector.BaseConnector

buildXMLResponseCommon, buildXMLResponseForContentStorage, buildXMLResponseForPortal, buildXMLResponseForRoot, buildXMLResponseOnExpand, getContent, getContent, getCorrectContentStorage, getCurrentPortalNode, getResponse, getWebContent

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentConnector

public CommentConnector(CommentsService commentsService)

Instantiates a new tag connector.

Parameters:

commentsService - Service instantiation.

Method Detail

addComment

public javax.ws.rs.core.Response addComment(String jcrPath,
                                            String comment)
                                     throws Exception

Adds a new comment to the content.

Parameters:

jcrPath - The JCR path of the content.

comment - The comment to add.

Returns:

The last modified date as a property to check the result.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

CommentConnector.addComment

getComments

public javax.ws.rs.core.Response getComments(String jcrPath)
                                      throws Exception

Gets all comments for a specific content.

Parameters:

jcrPath - The JCR path of the content.

Returns:

All comments

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

CommentConnector.getComments

deleteComment

public javax.ws.rs.core.Response deleteComment(String jcrPath,
                                               String commentId)
                                        throws Exception

Delete a comment of a content.

Parameters:

jcrPath - The JCR path of the content.

commentId - The id of the comment to delete.

Returns:

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

CommentConnector.deleteComment

getNode

protected javax.jcr.Node getNode(String jcrPath)
                          throws Exception

Get the jcr node of the given jcr path

Parameters:

jcrPath -

Returns:

The node of the given jcr path

Throws:

Exception

getRootContentStorage

protected javax.jcr.Node getRootContentStorage(javax.jcr.Node parentNode)
                                        throws Exception

Description copied from class: BaseConnector

Gets the root content storage.

Specified by:

getRootContentStorage in class BaseConnector

Parameters:

parentNode - the node

Returns:

the root content storage

Throws:

Exception - the exception

getContentStorageType

protected String getContentStorageType()
                                throws Exception

Description copied from class: BaseConnector

Gets the content storage type.

Specified by:

getContentStorageType in class BaseConnector

Returns:

the content storage type

Throws:

Exception - the exception