com.adobe.cq.social.commons.comments.endpoints

Class AbstractCommentOperationService<T extends OperationExtension,U extends Operation>

java.lang.Object

com.adobe.cq.social.commons.client.endpoints.AbstractOperationService<T,U,Comment>

com.adobe.cq.social.commons.comments.endpoints.AbstractCommentOperationService<T,U>

Type Parameters:

T - is a OperationExtension that will be used as hooks by the extending class.

U - is a Operation that is being provided by the extending class.

All Implemented Interfaces:

OperationService<T,U,Comment>

public abstract class AbstractCommentOperationService<T extends OperationExtension,U extends Operation>
extends AbstractOperationService<T,U,Comment>

Provides abstract implementation of comment operations. This class can be extended to implement create/delete/update operations for any component that extends the comment system.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARSET_PROPERTY The Constant CHARSET_PROPERTY.
static boolean	DEFAULT_REVERSE_REPLICATE The reverse replication state.
static String	PROP_MESSAGE The name of the property that holds the comment message.
static String	PROPERTY_ATTACHMENT_TYPE_BLACKLIST The name of the property that holds a black list of attachment mime types that are unsafe.
static String	PROPERTY_FIELD_WHITELIST The name of the property that holds a white list of form field names added as additional properties to the comment.
static String	PROPERTY_REVERSE_REPLICATE The name of the property that contains defines whether the comment should be reverse-replicated.
static String[]	RESERVED_PROPERTY_NAMES List of properties that the comment will overwrite.
static String	TAGS_PROPERTY The Constant TAGS_PROPERTY.

Constructor Summary

Constructors

Constructor and Description
AbstractCommentOperationService()

Method Summary

Methods

Modifier and Type	Method and Description
Resource	create(Resource root, String author, Map<String,Object> props, List<javax.activation.DataSource> attachments, Session session)
Resource	create(SlingHttpServletRequest request, Session session)
void	delete(Resource commentResource, CommentSystem cs, Session session) Process a comment delete request sent by a client.
void	delete(Resource commentResource, Session session)
void	delete(SlingHttpServletRequest request, Session session) Delete a Comment specified by the SlingHttpServletRequest using the specified Session
Resource	update(Resource commentResource, Map<String,Object> props, List<javax.activation.DataSource> attachments, Session session)
Resource	update(SlingHttpServletRequest request, Session session)

Methods inherited from class com.adobe.cq.social.commons.client.endpoints.AbstractOperationService

addOperationExtension, performAfterActions, performBeforeActions, removeOperationExtension

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET_PROPERTY

public static final String CHARSET_PROPERTY

The Constant CHARSET_PROPERTY.

See Also:

Constant Field Values

TAGS_PROPERTY

public static final String TAGS_PROPERTY

The Constant TAGS_PROPERTY.

See Also:

Constant Field Values

PROPERTY_REVERSE_REPLICATE

public static final String PROPERTY_REVERSE_REPLICATE

The name of the property that contains defines whether the comment should be reverse-replicated.

See Also:

Constant Field Values

PROPERTY_FIELD_WHITELIST

public static final String PROPERTY_FIELD_WHITELIST

The name of the property that holds a white list of form field names added as additional properties to the comment.

See Also:

Constant Field Values

RESERVED_PROPERTY_NAMES

public static final String[] RESERVED_PROPERTY_NAMES

List of properties that the comment will overwrite.

PROPERTY_ATTACHMENT_TYPE_BLACKLIST

public static final String PROPERTY_ATTACHMENT_TYPE_BLACKLIST

The name of the property that holds a black list of attachment mime types that are unsafe.

See Also:

Constant Field Values

DEFAULT_REVERSE_REPLICATE

public static final boolean DEFAULT_REVERSE_REPLICATE

The reverse replication state.

See Also:

Constant Field Values

PROP_MESSAGE

public static final String PROP_MESSAGE

The name of the property that holds the comment message.

See Also:

Constant Field Values

Constructor Detail

AbstractCommentOperationService

public AbstractCommentOperationService()

Method Detail

create

public Resource create(Resource root,
              String author,
              Map<String,Object> props,
              List<javax.activation.DataSource> attachments,
              Session session)
                throws OperationException

Throws:

OperationException

create

public Resource create(SlingHttpServletRequest request,
              Session session)
                throws OperationException

Throws:

OperationException

update

public Resource update(SlingHttpServletRequest request,
              Session session)
                throws OperationException

Throws:

OperationException

update

public Resource update(Resource commentResource,
              Map<String,Object> props,
              List<javax.activation.DataSource> attachments,
              Session session)
                throws OperationException

Throws:

OperationException

delete

public void delete(SlingHttpServletRequest request,
          Session session)
            throws OperationException

Delete a Comment specified by the SlingHttpServletRequest using the specified Session

Parameters:

request -

session -

Throws:

OperationException

delete

public void delete(Resource commentResource,
          Session session)
            throws OperationException

Throws:

OperationException

delete

public void delete(Resource commentResource,
          CommentSystem cs,
          Session session)
            throws OperationException

Process a comment delete request sent by a client. Sends back a 204 if the delete succeeded with no entity.

Parameters:

commentResource - the comment to delete

cs - the comment system

session - the session used to delete

Throws:

OperationException - when the session cannot save the changes in the comment system