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

Class AbstractCommentOperationService<T extends OperationExtension,U extends Operation,S extends Comment>

java.lang.Object

com.adobe.cq.social.scf.core.operations.AbstractOperationService<T,U,S>

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

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,S>

Direct Known Subclasses:

AbstractForumOperationsService

@Property(name="fieldWhitelist",value={"cq:tags","tags","composedFor"},cardinality=100) @Property(name="attachmentTypeBlacklist",cardinality=2147483647,value="DEFAULT")
public abstract class AbstractCommentOperationService<T extends OperationExtension,U extends Operation,S extends Comment>
extends AbstractOperationService<T,U,S>

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 java.lang.String	CHARSET_PROPERTY The Constant CHARSET_PROPERTY.
SocialComponentFactoryManager	componentFactoryManager
static java.lang.String	PROP_CONTEXT_PATH
static java.lang.String	PROP_MESSAGE The name of the property that holds the comment message.
static java.lang.String	PROPERTY_ATTACHMENT_TYPE_BLACKLIST The name of the property that holds a black list of attachment mime types that are unsafe.
static java.lang.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 java.lang.String[]	RESERVED_PROPERTY_NAMES List of properties that the comment will overwrite.
static java.lang.String	TAGS_PROPERTY The Constant TAGS_PROPERTY.

Constructor Summary

Constructors

Constructor and Description
AbstractCommentOperationService()

Method Summary

Modifier and Type	Method and Description
Resource	changeState(Resource commentResource, java.lang.String author, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session)
Resource	changeState(SlingHttpServletRequest request, Session session)
Resource	create(Resource root, java.lang.String author, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session)
Resource	create(SlingHttpServletRequest request, Session session)
void	delete(Resource commentResource, com.adobe.cq.social.commons.CommentSystem cs, Session session)
void	delete(Resource commentResource, com.adobe.cq.social.commons.CommentSystem cs, Session session, java.util.Map<java.lang.String,java.lang.Object> conditionals) Process a comment delete request sent by a client.
void	delete(Resource commentResource, Session session)
void	delete(Resource commentResource, Session session, java.util.Map<java.lang.String,java.lang.Object> conditionals)
void	delete(SlingHttpServletRequest request, Session session)
void	delete(SlingHttpServletRequest request, Session session, java.util.Map<java.lang.String,java.lang.Object> conditionals) Delete a Comment specified by the SlingHttpServletRequest using the specified Session
InheritedOperationExtensionManager	getInheritedOperationExtensionManager() Get the InheritedOperationExtensionManager which allows parent extension to be executed as part of the operation.
Resource	move(Resource commentResource, Resource parentResource, Session session)
Resource	move(SlingHttpServletRequest request, Session session)
void	removeAttachment(Resource attachment, ResourceResolver serviceUserResolver)
void	removeAttachment(Resource commentResource, java.lang.String attachment, Session session)
void	removeAttachment(SlingHttpServletRequest request, Session session)
Resource	update(Resource commentResource, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session)
Resource	update(SlingHttpServletRequest request, Session session)
Resource	uploadImage(Resource targetCommentSystemResource, com.adobe.cq.social.commons.CommentSystem cs, java.lang.String author, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session)
Resource	uploadImage(SlingHttpServletRequest request, Session session)
Resource	uploadImageToTemp(Resource targetCommentSystemResource, com.adobe.cq.social.commons.CommentSystem cs, java.lang.String author, java.util.List<javax.activation.DataSource> attachments, Session session)

Methods inherited from class com.adobe.cq.social.scf.core.operations.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 java.lang.String CHARSET_PROPERTY

The Constant CHARSET_PROPERTY.

See Also:

Constant Field Values

TAGS_PROPERTY

public static final java.lang.String TAGS_PROPERTY

The Constant TAGS_PROPERTY.

See Also:

Constant Field Values

PROPERTY_FIELD_WHITELIST

public static final java.lang.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 java.lang.String[] RESERVED_PROPERTY_NAMES

List of properties that the comment will overwrite.

PROPERTY_ATTACHMENT_TYPE_BLACKLIST

public static final java.lang.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

PROP_MESSAGE

public static final java.lang.String PROP_MESSAGE

The name of the property that holds the comment message.

See Also:

Constant Field Values

PROP_CONTEXT_PATH

public static final java.lang.String PROP_CONTEXT_PATH

See Also:

Constant Field Values

componentFactoryManager

@Reference
public SocialComponentFactoryManager componentFactoryManager

Constructor Detail

AbstractCommentOperationService

public AbstractCommentOperationService()

Method Detail

getInheritedOperationExtensionManager

public InheritedOperationExtensionManager getInheritedOperationExtensionManager()

Description copied from interface: OperationService

Get the InheritedOperationExtensionManager which allows parent extension to be executed as part of the operation.

Specified by:

getInheritedOperationExtensionManager in interface OperationService<T extends OperationExtension,U extends Operation,S extends Comment>

Overrides:

getInheritedOperationExtensionManager in class AbstractOperationService<T extends OperationExtension,U extends Operation,S extends Comment>

Returns:

extensionManager

removeAttachment

public void removeAttachment(Resource attachment,
                             ResourceResolver serviceUserResolver)

create

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

Throws:

OperationException

create

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

Throws:

OperationException

uploadImage

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

Throws:

OperationException

uploadImageToTemp

public Resource uploadImageToTemp(Resource targetCommentSystemResource,
                                  com.adobe.cq.social.commons.CommentSystem cs,
                                  java.lang.String author,
                                  java.util.List<javax.activation.DataSource> attachments,
                                  Session session)
                           throws OperationException

Throws:

OperationException

uploadImage

public Resource uploadImage(Resource targetCommentSystemResource,
                            com.adobe.cq.social.commons.CommentSystem cs,
                            java.lang.String author,
                            java.util.Map<java.lang.String,java.lang.Object> props,
                            java.util.List<javax.activation.DataSource> attachments,
                            Session session)
                     throws OperationException

Throws:

OperationException

update

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

Throws:

OperationException

removeAttachment

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

Throws:

OperationException

removeAttachment

public void removeAttachment(Resource commentResource,
                             java.lang.String attachment,
                             Session session)
                      throws OperationException

Throws:

OperationException

update

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

Throws:

OperationException

delete

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

Throws:

OperationException

delete

public void delete(SlingHttpServletRequest request,
                   Session session,
                   java.util.Map<java.lang.String,java.lang.Object> conditionals)
            throws OperationException

Delete a Comment specified by the SlingHttpServletRequest using the specified Session

Parameters:

request - SlingHttpServletRequest

session - Session

conditionals - params deciding execution flow

Throws:

OperationException - OperationException

delete

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

Throws:

OperationException

delete

public void delete(Resource commentResource,
                   Session session,
                   java.util.Map<java.lang.String,java.lang.Object> conditionals)
            throws OperationException

Throws:

OperationException

move

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

Throws:

OperationException

move

public Resource move(Resource commentResource,
                     Resource parentResource,
                     Session session)
              throws OperationException

Throws:

OperationException

changeState

public Resource changeState(Resource commentResource,
                            java.lang.String author,
                            java.util.Map<java.lang.String,java.lang.Object> props,
                            java.util.List<javax.activation.DataSource> attachments,
                            Session session)
                     throws OperationException

Throws:

OperationException

changeState

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

Throws:

OperationException

delete

public void delete(Resource commentResource,
                   com.adobe.cq.social.commons.CommentSystem cs,
                   Session session)
            throws OperationException

Throws:

OperationException

delete

public void delete(Resource commentResource,
                   com.adobe.cq.social.commons.CommentSystem cs,
                   Session session,
                   java.util.Map<java.lang.String,java.lang.Object> conditionals)
            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

conditionals - Map

Throws:

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