Package com.atlassian.confluence.impl.content

Class DefaultCommentManager

java.lang.Object

com.atlassian.confluence.impl.content.DefaultContentEntityManager

com.atlassian.confluence.impl.content.DefaultCommentManager

All Implemented Interfaces:

ContentEntityManager, ContentDraftManagerInternal, ContentEntityManagerInternal, CommentManagerInternal, CommentManager

@ParametersAreNonnullByDefault
public class DefaultCommentManager
extends DefaultContentEntityManager
implements CommentManagerInternal

Manager for page comments.

Since:

7.15

Field Summary

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

ITERATE_ALL

Constructor Summary

Constructors

Constructor

Description

DefaultCommentManager(ContentEntityObjectDaoInternal contentEntityObjectDao, org.hibernate.SessionFactory sessionFactory, WikiToStorageConverter wikiToStorageConverter, com.atlassian.event.api.EventPublisher eventPublisher, CommentDaoInternal commentDao, RelationManager relationManager, CollaborativeEditingHelper collaborativeEditingHelper, AuditingContext auditingContext, RetentionFeatureChecker retentionFeatureChecker, NotificationManager notificationManager, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method	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
long	countCommentByStatuses(List<ContentStatus> contentStatuses)	Retrieve the latest content count of specific content type for a given space with a particular status.
int	countComments(Searchable searchable)
@NonNull Map<Searchable,Integer>	countComments(Collection<? extends Searchable> searchables)
long	countSpaceCommentByStatuses(Space space, List<ContentStatus> contentStatuses)	Retrieve the latest content count of specific content type for a given space with a particular status.
@NonNull Map<Long,Integer>	countUnresolvedComments(Collection<Long> containerIds)	Count unresolved comments of comment containers.
@Nullable Comment	getComment(long id)
@NonNull PageResponse<Comment>	getFilteredChildren(Comment comment, LimitedRequest pageRequest, Depth depth, Predicate<? super Comment> filter)	Returns the children of a comment, limited to the pagination requested.
@NonNull PageResponse<Comment>	getFilteredContainerComments(long containerId, LimitedRequest pageRequest, Depth depth, Predicate<? super Comment> filter)	Returns the children comments of a ContentEntityObject, limited to the pagination requested.
@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, ConfluenceUser ignoreUser)	The service get all page comments (page level comments and inline comments) from a particular date except for comments by the given user.
@NonNull List<Comment>	getPageLevelComments(long pageId, Date since)	The service get all page level comments
@NonNull Iterator<Comment>	getRecentlyUpdatedComments(Space space, int maxResults)
void	removeCommentFromObject(long id)
void	removeCommentFromPage(long id)
@NonNull PageResponse<Comment>	scanFilteredComments(Space space, List<ContentStatus> statuses, LimitedRequest pageRequest, Predicate<? super Comment>... filter)	Retrieves all the existing comments associated with the instance of Confluence, while applying the specified pagination parameters to limit the number of results returned in each request.
@NonNull PageResponse<Comment>	scanFilteredComments(List<ContentStatus> statuses, LimitedRequest pageRequest, Predicate<? super Comment>... filter)	Retrieves all the current comments within the specified space, with the results limited according to the provided pagination parameters.
void	updateCommentContent(Comment comment, String content)

Methods inherited from class com.atlassian.confluence.impl.content.DefaultContentEntityManager

convertFromWikiToStorageFormatIfRequired, countContentBySpaceIdAndStatus, createDraft, filteredResponseWithCursor, filteredResponseWithCursor, findAllDraftsFor, findAllDraftsWithUnpublishedChangesForUser, findDraftFor, findDraftFor, findUnpublishedContentWithUserContributions, getById, getById, getById, getByIdsAndFilters, getContentAuthoredByUser, getContributionStatusByUser, getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionHistorySummaries, getVersionsLastEditedByUser, publishCreateEvent, publishRemoveEvent, publishUpdateEvent, refreshContentEntity, removeContentEntities, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, 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.core.ContentEntityManager

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

Constructor Details

DefaultCommentManager

public DefaultCommentManager(ContentEntityObjectDaoInternal contentEntityObjectDao,
 org.hibernate.SessionFactory sessionFactory,
 WikiToStorageConverter wikiToStorageConverter,
 com.atlassian.event.api.EventPublisher eventPublisher,
 CommentDaoInternal commentDao,
 RelationManager relationManager,
 CollaborativeEditingHelper collaborativeEditingHelper,
 AuditingContext auditingContext,
 RetentionFeatureChecker retentionFeatureChecker,
 NotificationManager notificationManager,
 PermissionManager permissionManager)

Since:

7.16

Method Details

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<Comment> 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,
 ConfluenceUser ignoreUser)

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 user.

Specified by:

getPageComments in interface CommentManager

Parameters:

pageId - page id of comment

since - comment time

ignoreUser - user excepted

Returns:

all comment

getFilteredContainerComments

public @NonNull PageResponse<Comment> getFilteredContainerComments(long containerId,
 LimitedRequest pageRequest,
 Depth depth,
 Predicate<? super Comment> filter)

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

Specified by:

getFilteredContainerComments in interface CommentManagerInternal

Parameters:

containerId -

pageRequest -

depth -

filter -

Returns:

the paginated response of Comment entities

scanFilteredComments

public @NonNull PageResponse<Comment> scanFilteredComments(Space space,
 List<ContentStatus> statuses,
 LimitedRequest pageRequest,
 Predicate<? super Comment>... filter)

Description copied from interface: CommentManagerInternal

Retrieves all the existing comments associated with the instance of Confluence, while applying the specified pagination parameters to limit the number of results returned in each request.

Specified by:

scanFilteredComments in interface CommentManagerInternal

Parameters:

space - the space to locate comments in

statuses - list of content status which we are interested to fetch

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Comment entities in the given space

scanFilteredComments

public @NonNull PageResponse<Comment> scanFilteredComments(List<ContentStatus> statuses,
 LimitedRequest pageRequest,
 Predicate<? super Comment>... filter)

Description copied from interface: CommentManagerInternal

Retrieves all the current comments within the specified space, with the results limited according to the provided pagination parameters.

Specified by:

scanFilteredComments in interface CommentManagerInternal

Parameters:

statuses - list of content status which we are interested to fetch

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Comment entities in any space

countSpaceCommentByStatuses

public long countSpaceCommentByStatuses(Space space,
 List<ContentStatus> contentStatuses)

Description copied from interface: CommentManagerInternal

Retrieve the latest content count of specific content type for a given space with a particular status.

Specified by:

countSpaceCommentByStatuses in interface CommentManagerInternal

Parameters:

space - the space

contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED

Returns:

the number of content objects with that status in that space

countCommentByStatuses

public long countCommentByStatuses(List<ContentStatus> contentStatuses)

Description copied from interface: CommentManagerInternal

Retrieve the latest content count of specific content type for a given space with a particular status.

Specified by:

countCommentByStatuses in interface CommentManagerInternal

Parameters:

contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED

Returns:

the number of content objects with that status in that space

countComments

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

Specified by:

countComments in interface CommentManager

countComments

public int countComments(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

getFilteredChildren

public @NonNull PageResponse<Comment> getFilteredChildren(Comment comment,
 LimitedRequest pageRequest,
 Depth depth,
 Predicate<? super Comment> filter)

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

Specified by:

getFilteredChildren in interface CommentManagerInternal

Parameters:

comment - the comment to find children for

pageRequest - the pagination requested

depth - the depth to return children to

filter - optional predicates used to filter the comments

Returns:

the paginated response of Comment entities

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