com.atlassian.confluence.pages

Class DefaultCommentManager

java.lang.Object

com.atlassian.confluence.core.DefaultContentEntityManager

com.atlassian.confluence.pages.DefaultCommentManager

All Implemented Interfaces:

ContentEntityManager, ContentDraftManagerInternal, ContentEntityManagerInternal, CommentManagerInternal, CommentManager

@ParametersAreNonnullByDefault
public class DefaultCommentManager
extends DefaultContentEntityManager
implements CommentManagerInternal

Manager for page comments.

Field Summary

Fields inherited from class com.atlassian.confluence.core.DefaultContentEntityManager

collaborativeEditingHelper

Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager

ITERATE_ALL

Constructor Summary

Constructors

Constructor and Description
DefaultCommentManager(ContentEntityObjectDao<ContentEntityObject> contentEntityObjectDao, HibernateSessionManager hibernateSessionManager, com.google.common.base.Supplier<? extends WikiToStorageConverter> wikiToStorageConverterRef, com.atlassian.event.api.EventPublisher eventPublisher, CommentDaoInternal commentDao, RelationManager relationManager, CollaborativeEditingHelper collaborativeEditingHelper, AuditingContext auditingContext)
DefaultCommentManager(ContentEntityObjectDao contentEntityObjectDao, LinkManager linkManager, ConfluenceIndexer indexer, LabelManager labelManager, AttachmentManager attachmentManager, HibernateSessionManager hibernateSessionManager, com.google.common.base.Supplier<XhtmlContent> xhtmlContent, com.atlassian.event.api.EventPublisher eventPublisher, NotificationManager notificationManager, CommentDaoInternal commentDao, RelationManager relationManager, com.google.common.base.Supplier<UserAccessor> userAccessor, com.google.common.base.Supplier<DarkFeaturesManager> darkFeaturesManager, CollaborativeEditingHelper collaborativeEditingHelper, AuditingContext auditingContext) Deprecated. since 7.5

Method Summary

Modifier and Type	Method and Description
@NonNull Comment	addCommentToObject(ContentEntityObject ceo, Comment parent, String content)
@NonNull Comment	addCommentToObject(ContentEntityObject ceo, Comment parent, String content, @Nullable NewCommentDeduplicator commentDeduplicator) Add a new comment if the given deduplicator determines that it's not a duplicate, or just return the existing duplicate otherwise.
@NonNull Comment	addCommentToPage(AbstractPage page, Comment parent, String content)
int	countAllCommentVersions() Count the total number of comments of all types, including previous versions
@NonNull Map<com.atlassian.bonnie.Searchable,Integer>	countComments(Collection<? extends com.atlassian.bonnie.Searchable> searchables)
int	countComments(com.atlassian.bonnie.Searchable searchable)
@NonNull Map<Long,Integer>	countUnresolvedComments(Collection<Long> containerIds) Count unresolved comments of comment containers.
@NonNull PageResponse<Comment>	getChildren(Comment comment, LimitedRequest pageRequest, Depth depth, com.google.common.base.Predicate<? super Comment>... predicates) Deprecated. in 7.0.1. Use CommentManagerInternal.getFilteredChildren(Comment, LimitedRequest, Depth, java.util.function.Predicate[])
@Nullable Comment	getComment(long id)
@NonNull PageResponse<Comment>	getContainerComments(long containerId, LimitedRequest pageRequest, Depth depth, com.google.common.base.Predicate<? super Comment>... predicates) Deprecated. since 7.0.1. Use {CommentManagerInternal.getFilteredContainerComments(long, LimitedRequest, Depth, java.util.function.Predicate[])}
@NonNull List<Comment>	getPageComments(long pageId, Date since) The service get all page comments (page level comments and inline comments)
@NonNull List<Comment>	getPageComments(long pageId, Date since, String ignoreUsername) The service get all page comments (page level comments and inline comments) from a particular date except for comments by the given username.
@NonNull List<Comment>	getPageLevelComments(long pageId, Date since) The service get all page level comments
@NonNull Iterator	getRecentlyUpdatedComments(Space space, int maxResults)
protected void	publishCreateEvent(ContentEntityObject obj) This method publishes *CreateEventss.
protected void	publishCreateEvent(ContentEntityObject obj, @Nullable SaveContext saveContext)
protected void	publishRemoveEvent(ContentEntityObject obj) This method publishes *RemoveEvents.
protected void	publishUpdateEvent(ContentEntityObject obj, @Nullable ContentEntityObject origObj, @Nullable SaveContext saveContext) This method publishes *UpdateEvents.
void	removeCommentFromObject(long id)
void	removeCommentFromPage(long id)
void	updateCommentContent(Comment comment, String content)

Methods inherited from class com.atlassian.confluence.core.DefaultContentEntityManager

createDraft, findAllDraftsFor, findAllDraftsWithUnpublishedChangesForUser, findDraftFor, findDraftFor, findUnpublishedContentWithUserContributions, getAttachmentManager, getBodyContentForRevert, getById, getById, getById, getByIds, getContentEntityObjectDao, getContributionStatusByUser, getEventPublisher, getHibernateSessionManager, getIndexer, getLabelManager, getLinkManager, getNextVersion, getNotificationManager, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeContentEntities, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.internal.pages.CommentManagerInternal

getFilteredChildren, getFilteredContainerComments

Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager

getById, getContributionStatusByUser, getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion

Methods inherited from interface com.atlassian.confluence.internal.ContentEntityManagerInternal

getByIdsAndFilters

Constructor Detail

DefaultCommentManager

public DefaultCommentManager(ContentEntityObjectDao<ContentEntityObject> contentEntityObjectDao,
                             HibernateSessionManager hibernateSessionManager,
                             com.google.common.base.Supplier<? extends WikiToStorageConverter> wikiToStorageConverterRef,
                             com.atlassian.event.api.EventPublisher eventPublisher,
                             CommentDaoInternal commentDao,
                             RelationManager relationManager,
                             CollaborativeEditingHelper collaborativeEditingHelper,
                             AuditingContext auditingContext)

Since:

7.5

DefaultCommentManager

@Deprecated
public DefaultCommentManager(ContentEntityObjectDao contentEntityObjectDao,
                                         LinkManager linkManager,
                                         ConfluenceIndexer indexer,
                                         LabelManager labelManager,
                                         AttachmentManager attachmentManager,
                                         HibernateSessionManager hibernateSessionManager,
                                         com.google.common.base.Supplier<XhtmlContent> xhtmlContent,
                                         com.atlassian.event.api.EventPublisher eventPublisher,
                                         NotificationManager notificationManager,
                                         CommentDaoInternal commentDao,
                                         RelationManager relationManager,
                                         com.google.common.base.Supplier<UserAccessor> userAccessor,
                                         com.google.common.base.Supplier<DarkFeaturesManager> darkFeaturesManager,
                                         CollaborativeEditingHelper collaborativeEditingHelper,
                                         AuditingContext auditingContext)

Deprecated. since 7.5

Since:

5.8

Method Detail

getComment

public @Nullable Comment getComment(long id)

Specified by:

getComment in interface CommentManager

addCommentToPage

public @NonNull Comment addCommentToPage(AbstractPage page,
                                         Comment parent,
                                         String content)

Specified by:

addCommentToPage in interface CommentManager

addCommentToObject

public @NonNull Comment addCommentToObject(ContentEntityObject ceo,
                                           Comment parent,
                                           String content)

Specified by:

addCommentToObject in interface CommentManager

addCommentToObject

public @NonNull Comment addCommentToObject(ContentEntityObject ceo,
                                           Comment parent,
                                           String content,
                                           @Nullable NewCommentDeduplicator commentDeduplicator)

Description copied from interface: CommentManager

Add a new comment if the given deduplicator determines that it's not a duplicate, or just return the existing duplicate otherwise.

Specified by:

addCommentToObject in interface CommentManager

updateCommentContent

public void updateCommentContent(Comment comment,
                                 String content)

Specified by:

updateCommentContent in interface CommentManager

removeCommentFromPage

public void removeCommentFromPage(long id)

Specified by:

removeCommentFromPage in interface CommentManager

removeCommentFromObject

public void removeCommentFromObject(long id)

Specified by:

removeCommentFromObject in interface CommentManager

getRecentlyUpdatedComments

public @NonNull Iterator getRecentlyUpdatedComments(Space space,
                                                    int maxResults)

Specified by:

getRecentlyUpdatedComments in interface CommentManager

getPageComments

public @NonNull List<Comment> getPageComments(long pageId,
                                              Date since)

Description copied from interface: CommentManager

The service get all page comments (page level comments and inline comments)

Specified by:

getPageComments in interface CommentManager

Parameters:

pageId - page id of comment

since - comment time

Returns:

all comment

getPageComments

public @NonNull List<Comment> getPageComments(long pageId,
                                              Date since,
                                              String ignoreUsername)

Description copied from interface: CommentManager

The service get all page comments (page level comments and inline comments) from a particular date except for comments by the given username.

Specified by:

getPageComments in interface CommentManager

Parameters:

pageId - page id of comment

since - comment time

ignoreUsername - username excepted

Returns:

all comment

getContainerComments

@Deprecated
public @NonNull PageResponse<Comment> getContainerComments(long containerId,
                                                                       LimitedRequest pageRequest,
                                                                       Depth depth,
                                                                       com.google.common.base.Predicate<? super Comment>... predicates)

Deprecated. since 7.0.1. Use {CommentManagerInternal.getFilteredContainerComments(long, LimitedRequest, Depth, java.util.function.Predicate[])}

Description copied from interface: CommentManagerInternal

Returns the children comments of a ContentEntityObject, limited to the pagination requested.

Specified by:

getContainerComments in interface CommentManagerInternal

Parameters:

containerId - the id of the container to find children for

pageRequest - the pagination requested

depth - the depth to return children to

predicates - optional predicates used to filter the comments

Returns:

the paginated response of Comment entities

countComments

public @NonNull Map<com.atlassian.bonnie.Searchable,Integer> countComments(Collection<? extends com.atlassian.bonnie.Searchable> searchables)

Specified by:

countComments in interface CommentManager

countComments

public int countComments(com.atlassian.bonnie.Searchable searchable)

Specified by:

countComments in interface CommentManager

countAllCommentVersions

public int countAllCommentVersions()

Description copied from interface: CommentManager

Count the total number of comments of all types, including previous versions

Specified by:

countAllCommentVersions in interface CommentManager

Returns:

the total number of comments

countUnresolvedComments

public @NonNull Map<Long,Integer> countUnresolvedComments(Collection<Long> containerIds)

Description copied from interface: CommentManager

Count unresolved comments of comment containers.

Specified by:

countUnresolvedComments in interface CommentManager

Parameters:

containerIds - the list of comment containers ids

Returns:

The map of container id and its unresolved comment count

getChildren

@Deprecated
public @NonNull PageResponse<Comment> getChildren(Comment comment,
                                                              LimitedRequest pageRequest,
                                                              Depth depth,
                                                              com.google.common.base.Predicate<? super Comment>... predicates)

Deprecated. in 7.0.1. Use CommentManagerInternal.getFilteredChildren(Comment, LimitedRequest, Depth, java.util.function.Predicate[])

Description copied from interface: CommentManagerInternal

Returns the children of a comment, limited to the pagination requested.

Specified by:

getChildren in interface CommentManagerInternal

Parameters:

comment - the comment to find children for

pageRequest - the pagination requested

depth - the depth to return children to

predicates - optional predicates used to filter the comments

Returns:

the paginated response of Comment entities

publishCreateEvent

protected void publishCreateEvent(ContentEntityObject obj)

Description copied from class: DefaultContentEntityManager

This method publishes *CreateEventss. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishCreateEvent in class DefaultContentEntityManager

Parameters:

obj - the created content entity object

publishCreateEvent

protected void publishCreateEvent(ContentEntityObject obj,
                                  @Nullable SaveContext saveContext)

Overrides:

publishCreateEvent in class DefaultContentEntityManager

publishRemoveEvent

protected void publishRemoveEvent(ContentEntityObject obj)

Description copied from class: DefaultContentEntityManager

This method publishes *RemoveEvents. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishRemoveEvent in class DefaultContentEntityManager

Parameters:

obj - the removed content entity object

publishUpdateEvent

protected void publishUpdateEvent(ContentEntityObject obj,
                                  @Nullable ContentEntityObject origObj,
                                  @Nullable SaveContext saveContext)

Description copied from class: DefaultContentEntityManager

This method publishes *UpdateEvents. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishUpdateEvent in class DefaultContentEntityManager

Parameters:

obj - the updated content entity object

origObj - the old version of the content entity object, for history purpose

saveContext - the associated SaveContext

getPageLevelComments

public @NonNull List<Comment> getPageLevelComments(long pageId,
                                                   Date since)

Description copied from interface: CommentManager

The service get all page level comments

Specified by:

getPageLevelComments in interface CommentManager

Parameters:

pageId - page id of comment

since - comment time

Returns:

page level comments