com.atlassian.confluence.pages.persistence.dao.hibernate

Class CachingPageDao

java.lang.Object

com.atlassian.confluence.pages.persistence.dao.hibernate.CachingPageDao

All Implemented Interfaces:

ObjectDao, ContentEntityObjectDao, VersionedObjectDao, PageDao

public class CachingPageDao
extends Object
implements PageDao

This maintains a cache of (space key, page title) -> (page id) mappings. All page ids cached refer to current pages. When a page is marked for deletion, it is removed from this cache.

Field Summary

Fields inherited from interface bucket.core.persistence.ObjectDao

NON_CACHEABLE

Constructor Summary

Constructors

Constructor and Description
CachingPageDao(PageDao delegateDao, PageIdCache pageIdCache) Deprecated. since 5.10 Use CachingPageDao(PageDao, VCacheFactory)
CachingPageDao(PageDao delegateDao, com.atlassian.vcache.VCacheFactory cacheFactory)

Method Summary

Modifier and Type	Method and Description
int	countAllPages() Counts the total number of all page entities across all spaces, including non-current pages
int	countContentBySpaceIdAndStatus(long spaceId, String status) Retrieve the count of content for a given space with a particular status.
int	countCurrentPages() Counts the total number of current pages across all spaces
int	countDraftPages() Counts the number of pages that are drafts.
int	countPagesInSubtree(Page page) Return total descendant page including input page
int	countPagesWithUnpublishedChanges() Counts the number of published pages that have unpublished changes.
List	findAll() Find all objects currently persisted of a particular type.
List<ContentEntityObject>	findAllDraftsFor(long contentId) Retrieves a list of drafts for the given content if any drafts exist.
List	findAllSorted(String s) Find all objects currently persisted of a particular type and sort results by named property.
List	findAllSorted(String s, boolean cached, int firstRow, int maxRows) Find all objects currently persisted of a particular type and sort results by named property.
List<AbstractPage>	findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String blogTitle, Space space, int maxResultCount) Searches for blog posts in all spaces except the one specified, looking for those that have the given title in a current or previous version, and returns the first maxResultCount results.
List<AbstractPage>	findBlogsWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder, String blogTitle, Space space, int maxResultCount) Searches for blogs in the space specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.
<T> PageResponse<T>	findByClassIds(Iterable<Long> ids, LimitedRequest limitedRequest, com.google.common.base.Predicate<? super T> filter) Find a list of objects from the same persistent class.
List<ContentEntityObject>	findContentBySpaceIdAndStatus(long spaceId, String status, int offset, int count) Retrieve content for a given space with a particular status.
PageResponse<ContentEntityObject>	findContentBySpaceIdAndStatus(long spaceId, String status, LimitedRequest limitedRequest, com.google.common.base.Predicate<Page> predicate) Retrieve content for a given space with a particular status.
List<ContentPermissionSummary>	findContentPermissionSummaryByIds(Collection<Long> ids) Get Content creator for bulk permission checking
ContentEntityObject	findDraftFor(long contentId) Retrieves the draft for the given content if exists.
List	findHistoricalVersionsAfterVersion(long originalContentId, int version)
long	findLatestVersionsCount() Returns the number of results for the latest versions of the current persistent class.
Iterator	findLatestVersionsIterator() Returns an iterator for the latest versions of the current persistent class.
List<AbstractPage>	findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String pageTitle, Space space, int maxResultCount) Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.
List<AbstractPage>	findPagesWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder, String pageTitle, Space space, int maxResultCount) Searches for pages in the space specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.
List<Page>	findPagesWithHistoricalTitle(String pageTitle)
List	findPreviousVersions(long originalContentId)
List<ContentEntityObject>	findUnpublishedContentWithUserContributions(String username) Retrives the drafts for the given User
PageResponse<AbstractPage>	getAbstractPages(org.joda.time.DateTime date, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Returns the abstract pages created on the given date and are in the , that also match the given filter, limited to the page request.
PageResponse<AbstractPage>	getAbstractPages(List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Retrieves a page response of all pages found in this instance of Confluence, within any of the given statuses.
PageResponse<AbstractPage>	getAbstractPages(Space space, List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Retrieves a page response for all content (pages and/or blog posts) in the given space, within any of the specified statuses and content types.
PageResponse<AbstractPage>	getAbstractPages(Space space, String title, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Returns the abstract pages from a space that exactly match the given title and are in any of the specified statuses, and match the given filter, limited to the pagination request.
PageResponse<AbstractPage>	getAbstractPages(String title, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Returns the abstract pages that exactly match the given title, are in any of the specified statuses, and match the given filter, limited to the pagination request.
PageResponse<AbstractPage>	getAbstractPagesByCreationDate(org.joda.time.DateTime date, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Returns the abstract pages created on the given date, that also match the given filter, limited to the page request.
PageResponse<AbstractPage>	getAbstractPagesByTitle(String title, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage> filter) Returns the abstract pages that exactly match the given title, limited to the pagination request.
Iterator	getAllCurrentEntities()
Map<Long,List<Long>>	getAncestorsFor(Collection<Long> ids) Get the list page ids of the ancestors of the given page ids.
int	getAuthoredPagesCountByUser(String username)
PageResponse<BlogPost>	getBlogPosts(Space space, LimitedRequest pageRequest, com.google.common.base.Predicate<? super BlogPost> filter) Retrieves a page response of all the current blog posts in the give space.
ContentEntityObject	getById(long id)
PageResponse<Page>	getChildren(Page page, LimitedRequest pageRequest, com.google.common.base.Predicate<? super Page> predicate, Depth depth) Returns the children of a page which have a status of CURRENT, limited to the pagination requested.
int	getCommentCountOnPage(long id) Count the number of comments on the passed in page.
List	getContentAuthoredByUser(String username)
Map<Long,ContributionStatus>	getContributionStatusByUser(Collection<ContentId> contentIds, com.atlassian.sal.api.user.UserKey userKey) Identifies the most recent contributions made to a Collection of content by the given user.
PageDao	getDelegateDao()
List<Long>	getDescendantIds(Page page) Finds the ids of all descendant pages of the given page
List<Long>	getDescendantIds(Page page, ContentStatus... statuses) Finds the ids of all descendant pages of the given page
List<Page>	getDescendants(Page page) Finds all descendant pages (recursive) of the given page
List<String>	getDescendantTitles(Page page) Finds all descendant titles of the given page
List<Long>	getDescendentIds(Page page)
List<Page>	getDescendents(Page page)
PageResponse<Page>	getDraftChildren(Page page, LimitedRequest pageRequest, Depth depth) Returns the children of a page which have a status of DRAFT, limited to the pagination requested.
ContentEntityObject	getFirstVersionAfter(long originalVersionContentId, int version)
ContentEntityObject	getFirstVersionBefore(long originalVersionContentId, int version)
List<ContentEntityObject>	getLastEditedVersionsOf(ContentEntityObject content) Retrieves all the last edited versions for each user who has contributed to the specified piece of content.
Integer	getMaxSiblingPosition(Page page) Gets the highest position value of all the page's siblings.
String	getObjectType(long id)
Date	getOldestPageCreationDate() Gets the creation date of the oldest page.
List<Page>	getOrphanedPages(String spaceKey)
Page	getPage(Space space, String pageTitle) Get the page by space and title.
PageResponse<AbstractPage>	getPageAndBlogPostsVersionsLastEditedByUser(com.atlassian.sal.api.user.UserKey userKey, LimitedRequest request) Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification.
PageResponse<AbstractPage>	getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts(com.atlassian.sal.api.user.UserKey userKey, LimitedRequest request) Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification.
Page	getPageById(long id) Get the page with the given id.
Page	getPageByIdWithComments(long id) Get the page with the given id, and perform an eager load of the comments and their children.
long	getPageCount(String spaceKey) Get total number of current pages in a space
Collection<Long>	getPageIds(Space space) Get the ids of all pages (current and historical) in the given space.
List<Page>	getPageInTrash(String spaceKey, String title)
PageResponse<Page>	getPages(LimitedRequest pageRequest, com.google.common.base.Predicate<? super Page> filter) Retrieves a page response of all the current pages of the Confluence instance.
List<Page>	getPages(Space space, boolean currentOnly)
PageResponse<Page>	getPages(Space space, LimitedRequest pageRequest, com.google.common.base.Predicate<? super Page> filter) Retrieves a page response of the current content in the given space.
List<Page>	getPagesByIds(Iterable<Long> ids) Get the pages with the given ids.
List<Page>	getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)
List<Page>	getPagesStartingWith(Space space, String s)
List<Page>	getPagesWithPermissions(Space space) Get all current pages in a space and eagerly fetch permissions at the same time.
Page	getPageWithComments(Space space, String pageTitle) Get the page by space and title, and perform an eager load of the comments and their children.
List<Page>	getPermissionPages(Space space)
Class	getPersistentClass()
Iterator	getRecentlyAddedEntities(String spaceKey, int maxResults)
List<Page>	getRecentlyAddedPages(int maxCount, String spaceKey)
List<Page>	getRecentlyAuthoredPagesByUser(String username, int maxCount)
Iterator	getRecentlyModifiedEntities(int maxResults)
Iterator	getRecentlyModifiedEntities(String spaceKey, int maxResults)
Iterator	getRecentlyModifiedEntitiesForUser(String username)
List	getRecentlyModifiedForChangeDigest(Date fromDate) Retrieves a list of ContentEntityObjects that have been newly added or modified since the date specified.
List<Page>	getRecentlyUpdatedPages(int maxCount, String spaceKey)
List<Page>	getTopLevelPages(Space space)
PageResponse<Page>	getTopLevelPages(Space space, LimitedRequest limitedRequest, com.google.common.base.Predicate<? super Page> predicate)
List	getTrashedContent(String spaceKey)
List<OutgoingLink>	getUndefinedLinks(String spaceKey)
List<Page>	getUndefinedPages(String spaceKey)
ContentEntityObject	getVersion(long originalVersionContentId, int version)
Map<Long,List<ConfluenceUser>>	getVersionEditContributors(Iterable<ContentEntityObject> originalVersions) Get version edit contributors for a set of content identifiers.
List<VersionHistorySummary>	getVersionHistorySummary(long originalContentId)
PageResponse<VersionHistorySummary>	getVersionHistorySummary(long originalContentId, LimitedRequest request) Get version history with pagination.
Map<Long,ContentEntityObject>	getVersionsLastEditedByUser(Collection<Long> contentIds, com.atlassian.sal.api.user.UserKey userKey) Gets the ContentEntityObject objects, either the current version or historical version relating to given contentIds of the current version that was the most recent version edited by the given user.
Map<Long,ContentEntityObject>	getVersionsLastEditedByUserNew(Collection<Long> contentIds, com.atlassian.sal.api.user.UserKey userKey) Same as ContentEntityObjectDao.getVersionsLastEditedByUser(Collection, UserKey), but a refined implementation for new Recently Worked On Drafts work.
void	refresh(com.atlassian.core.bean.EntityObject objectToRefresh) Refreshes the object again with the fresh data from db.
void	remove(com.atlassian.core.bean.EntityObject object) Remove object from persistence.
void	replicate(Object objectToReplicate) Replicate the object.
void	save(com.atlassian.core.bean.EntityObject objectToSave)
void	save(com.atlassian.core.bean.EntityObject objectToSave, com.atlassian.core.bean.EntityObject originalObject)
void	saveRaw(com.atlassian.core.bean.EntityObject objectToSave) saves the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingPageDao

@Deprecated
public CachingPageDao(PageDao delegateDao,
                                  PageIdCache pageIdCache)

Deprecated. since 5.10 Use CachingPageDao(PageDao, VCacheFactory)

CachingPageDao

public CachingPageDao(PageDao delegateDao,
                      com.atlassian.vcache.VCacheFactory cacheFactory)

Since:

5.10

Method Detail

getDelegateDao

public PageDao getDelegateDao()

getPage

public Page getPage(Space space,
                    String pageTitle)

Description copied from interface: PageDao

Get the page by space and title.

Specified by:

getPage in interface PageDao

Parameters:

space - The space the page belongs to

pageTitle - The title of the page

Returns:

the page with the given title in the given space, or null if no such page exists

getPageWithComments

public Page getPageWithComments(Space space,
                                String pageTitle)

Description copied from interface: PageDao

Get the page by space and title, and perform an eager load of the comments and their children. This can be used as a performance optimisation when it is known that all comments will be displayed.

Specified by:

getPageWithComments in interface PageDao

Parameters:

space - The space the page belongs to

pageTitle - The title of the page

Returns:

the page with the given title in the given space, or null if no such page exists

remove

public void remove(com.atlassian.core.bean.EntityObject object)

Description copied from interface: ObjectDao

Remove object from persistence.

Specified by:

remove in interface ObjectDao

save

public void save(com.atlassian.core.bean.EntityObject objectToSave,
                 com.atlassian.core.bean.EntityObject originalObject)

Specified by:

save in interface VersionedObjectDao

save

public void save(com.atlassian.core.bean.EntityObject objectToSave)

Specified by:

save in interface ObjectDao

saveRaw

public void saveRaw(com.atlassian.core.bean.EntityObject objectToSave)

Description copied from interface: ObjectDao

saves the object. if the object is new, this won't set the creation date on the object. if it already exists, then it won't set the date that it was updated.

Specified by:

saveRaw in interface ObjectDao

findAll

@Nonnull
public List findAll()

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type.

Specified by:

findAll in interface ObjectDao

findAllSorted

@Nonnull
public List findAllSorted(String s)

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type and sort results by named property.

Specified by:

findAllSorted in interface ObjectDao

Parameters:

s - the name of the property to be sorted on. This should be null if no sorting is required.

findAllSorted

@Nonnull
public List findAllSorted(String s,
                                   boolean cached,
                                   int firstRow,
                                   int maxRows)

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type and sort results by named property. This version of the method allows more control over the query.

Specified by:

findAllSorted in interface ObjectDao

Parameters:

s - the name of the property to be sorted on. This should be null if no sorting is required.

cached - control whether the results should be cached

firstRow - the index of the first result to be returned

maxRows - the maximum number of results required. Use -1 to specify no limit.

findByClassIds

@Nonnull
public <T> PageResponse<T> findByClassIds(Iterable<Long> ids,
                                                   LimitedRequest limitedRequest,
                                                   com.google.common.base.Predicate<? super T> filter)

Description copied from interface: ObjectDao

Find a list of objects from the same persistent class.

Specified by:

findByClassIds in interface ObjectDao

Type Parameters:

T - the type of entity to return

Parameters:

ids - - the ids of the entities to find

limitedRequest - the pagination request defining the page size to fetch

filter - a predicate to do in memory filtering of the result set before returning

Returns:

a list of objects matching the filters

findLatestVersionsCount

public long findLatestVersionsCount()

Description copied from interface: VersionedObjectDao

Returns the number of results for the latest versions of the current persistent class.

Specified by:

findLatestVersionsCount in interface VersionedObjectDao

Returns:

a long representing the number of results

findLatestVersionsIterator

public Iterator findLatestVersionsIterator()

Description copied from interface: VersionedObjectDao

Returns an iterator for the latest versions of the current persistent class.

Specified by:

findLatestVersionsIterator in interface VersionedObjectDao

Returns:

Iterator

findPagesWithHistoricalTitle

public List<Page> findPagesWithHistoricalTitle(String pageTitle)

Specified by:

findPagesWithHistoricalTitle in interface PageDao

findPreviousVersions

public List findPreviousVersions(long originalContentId)

Specified by:

findPreviousVersions in interface ContentEntityObjectDao

findPagesWithCurrentOrHistoricalTitleInPermittedSpace

public List<AbstractPage> findPagesWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder,
                                                                                String pageTitle,
                                                                                Space space,
                                                                                int maxResultCount)

Description copied from interface: PageDao

Searches for pages in the space specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.

Only pages in spaces the remote user is able to view will be returned.

Specified by:

findPagesWithCurrentOrHistoricalTitleInPermittedSpace in interface PageDao

pageTitle - title of a page in a previous version.

space - Space to search. Must not be null.

maxResultCount - maximum pages to return

findBlogsWithCurrentOrHistoricalTitleInPermittedSpace

public List<AbstractPage> findBlogsWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder,
                                                                                String blogTitle,
                                                                                Space space,
                                                                                int maxResultCount)

Description copied from interface: PageDao

Searches for blogs in the space specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.

Only blogs in spaces the remote user is able to view will be returned.

Specified by:

findBlogsWithCurrentOrHistoricalTitleInPermittedSpace in interface PageDao

Parameters:

permissionQueryBuilder - required to determine how to construct database queries for space permissions, for the current user

blogTitle - title of a page in a previous version.

space - Space to search. Must not be null.

maxResultCount - maximum pages to return

Returns:

a list of pages that have the given title in a previous version

findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept

public List<AbstractPage> findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder,
                                                                                          String blogTitle,
                                                                                          Space space,
                                                                                          int maxResultCount)

Description copied from interface: PageDao

Searches for blog posts in all spaces except the one specified, looking for those that have the given title in a current or previous version, and returns the first maxResultCount results.

Only pages in spaces the remote user is able to view will be returned.

Specified by:

findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept in interface PageDao

blogTitle - Title of the blog to find

space - Space to exclude from search. If null, all spaces are searched.

maxResultCount - maximum blog posts to return

Returns:

a list of blog posts that have or have had the given title

findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept

public List<AbstractPage> findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder,
                                                                                          String pageTitle,
                                                                                          Space space,
                                                                                          int maxResultCount)

Description copied from interface: PageDao

Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version, and returns the first maxResultCount results.

Only pages in spaces the remote user is able to view will be returned.

Specified by:

findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept in interface PageDao

pageTitle - title of a page in a previous version.

space - Space to exclude from search. If null, all spaces are searched.

maxResultCount - maximum pages to return

findContentPermissionSummaryByIds

public List<ContentPermissionSummary> findContentPermissionSummaryByIds(Collection<Long> ids)

Description copied from interface: PageDao

Get Content creator for bulk permission checking

Specified by:

findContentPermissionSummaryByIds in interface PageDao

Parameters:

ids - of Content

Returns:

list contain information for permission checking

getAllCurrentEntities

public Iterator getAllCurrentEntities()

Specified by:

getAllCurrentEntities in interface ContentEntityObjectDao

getAuthoredPagesCountByUser

public int getAuthoredPagesCountByUser(String username)

Specified by:

getAuthoredPagesCountByUser in interface PageDao

getById

public ContentEntityObject getById(long id)

Specified by:

getById in interface ContentEntityObjectDao

getContentAuthoredByUser

public List getContentAuthoredByUser(String username)

Specified by:

getContentAuthoredByUser in interface ContentEntityObjectDao

getDescendantIds

public List<Long> getDescendantIds(Page page)

Description copied from interface: PageDao

Finds the ids of all descendant pages of the given page

Specified by:

getDescendantIds in interface PageDao

Returns:

List of page ids

getDescendantIds

public List<Long> getDescendantIds(Page page,
                                   ContentStatus... statuses)

Description copied from interface: PageDao

Finds the ids of all descendant pages of the given page

Specified by:

getDescendantIds in interface PageDao

Returns:

List of page ids

countPagesInSubtree

public int countPagesInSubtree(Page page)

Description copied from interface: PageDao

Return total descendant page including input page

Specified by:

countPagesInSubtree in interface PageDao

Returns:

total page

getDescendentIds

public List<Long> getDescendentIds(Page page)

Specified by:

getDescendentIds in interface PageDao

getDescendants

public List<Page> getDescendants(Page page)

Description copied from interface: PageDao

Finds all descendant pages (recursive) of the given page

Specified by:

getDescendants in interface PageDao

Returns:

List of descendant pages

getDescendantTitles

public List<String> getDescendantTitles(Page page)

Description copied from interface: PageDao

Finds all descendant titles of the given page

Specified by:

getDescendantTitles in interface PageDao

Returns:

List of descendant titles

getDescendents

public List<Page> getDescendents(Page page)

Specified by:

getDescendents in interface PageDao

getFirstVersionAfter

public ContentEntityObject getFirstVersionAfter(long originalVersionContentId,
                                                int version)

Specified by:

getFirstVersionAfter in interface ContentEntityObjectDao

getFirstVersionBefore

public ContentEntityObject getFirstVersionBefore(long originalVersionContentId,
                                                 int version)

Specified by:

getFirstVersionBefore in interface ContentEntityObjectDao

getObjectType

public String getObjectType(long id)

Specified by:

getObjectType in interface ContentEntityObjectDao

getOrphanedPages

public List<Page> getOrphanedPages(String spaceKey)

Specified by:

getOrphanedPages in interface PageDao

getPageById

public Page getPageById(long id)

Description copied from interface: PageDao

Get the page with the given id.

Specified by:

getPageById in interface PageDao

Parameters:

id - of the page to load

Returns:

the page with the given id, or null if no such page exists

getPagesByIds

public List<Page> getPagesByIds(Iterable<Long> ids)

Get the pages with the given ids.

Specified by:

getPagesByIds in interface PageDao

getPageByIdWithComments

public Page getPageByIdWithComments(long id)

Description copied from interface: PageDao

Get the page with the given id, and perform an eager load of the comments and their children. This can be used as a performance optimisation when it is known that all comments will be displayed.

Specified by:

getPageByIdWithComments in interface PageDao

Parameters:

id - of the page to load

Returns:

the page with the given id, or null if no such page exists

getCommentCountOnPage

public int getCommentCountOnPage(long id)

Description copied from interface: PageDao

Count the number of comments on the passed in page.

Specified by:

getCommentCountOnPage in interface PageDao

getPageInTrash

public List<Page> getPageInTrash(String spaceKey,
                                 String title)

Specified by:

getPageInTrash in interface PageDao

getAncestorsFor

public Map<Long,List<Long>> getAncestorsFor(Collection<Long> ids)

Description copied from interface: PageDao

Get the list page ids of the ancestors of the given page ids.

Specified by:

getAncestorsFor in interface PageDao

Parameters:

ids - the list of page ids to get ancestor page ids for

Returns:

a map where the key is the given page id and the value is a list of all its ancestors' page ids

getPages

public List<Page> getPages(Space space,
                           boolean currentOnly)

Specified by:

getPages in interface PageDao

getPagesWithPermissions

public List<Page> getPagesWithPermissions(Space space)

Description copied from interface: PageDao

Get all current pages in a space and eagerly fetch permissions at the same time. This is an optimisation for when you known that permissions will need to be fetched for all or most of the pages later.

Specified by:

getPagesWithPermissions in interface PageDao

Returns:

a list of all the current pages in a space

getPages

public PageResponse<Page> getPages(Space space,
                                   LimitedRequest pageRequest,
                                   com.google.common.base.Predicate<? super Page> filter)

Description copied from interface: PageDao

Retrieves a page response of the current content in the given space.

Specified by:

getPages in interface PageDao

Parameters:

space - the space to locate the page in

pageRequest - the start and offset of the pages to retrieve

filter - the predicate to pages the returned results by, may be null

getPages

public PageResponse<Page> getPages(LimitedRequest pageRequest,
                                   com.google.common.base.Predicate<? super Page> filter)

Description copied from interface: PageDao

Retrieves a page response of all the current pages of the Confluence instance.

Specified by:

getPages in interface PageDao

Parameters:

pageRequest - the start and offset of the pages to retrieve

filter - the predicate to filter the returned results by, may be null

Returns:

the paginated list of pages

getBlogPosts

public PageResponse<BlogPost> getBlogPosts(Space space,
                                           LimitedRequest pageRequest,
                                           @Nullable
                                           com.google.common.base.Predicate<? super BlogPost> filter)

Description copied from interface: PageDao

Retrieves a page response of all the current blog posts in the give space.

Specified by:

getBlogPosts in interface PageDao

Parameters:

space - the space to locate the blog posts in

pageRequest - the start and offset of the pages to retrieve

filter - the predicate to filter the returned results by, may be null

Returns:

the paginated list of all the current blog posts by space

getPagesCreatedOrUpdatedSinceDate

public List<Page> getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)

Specified by:

getPagesCreatedOrUpdatedSinceDate in interface PageDao

getPagesStartingWith

public List<Page> getPagesStartingWith(Space space,
                                       String s)

Specified by:

getPagesStartingWith in interface PageDao

getPermissionPages

public List<Page> getPermissionPages(Space space)

Specified by:

getPermissionPages in interface PageDao

getPersistentClass

public Class getPersistentClass()

Specified by:

getPersistentClass in interface ObjectDao

getRecentlyAddedEntities

public Iterator getRecentlyAddedEntities(String spaceKey,
                                         int maxResults)

Specified by:

getRecentlyAddedEntities in interface ContentEntityObjectDao

getRecentlyAddedPages

public List<Page> getRecentlyAddedPages(int maxCount,
                                        String spaceKey)

Specified by:

getRecentlyAddedPages in interface PageDao

getRecentlyAuthoredPagesByUser

public List<Page> getRecentlyAuthoredPagesByUser(String username,
                                                 int maxCount)

Specified by:

getRecentlyAuthoredPagesByUser in interface PageDao

getRecentlyModifiedEntities

public Iterator getRecentlyModifiedEntities(int maxResults)

Specified by:

getRecentlyModifiedEntities in interface ContentEntityObjectDao

getRecentlyModifiedEntities

public Iterator getRecentlyModifiedEntities(String spaceKey,
                                            int maxResults)

Specified by:

getRecentlyModifiedEntities in interface ContentEntityObjectDao

getRecentlyModifiedEntitiesForUser

public Iterator getRecentlyModifiedEntitiesForUser(String username)

Specified by:

getRecentlyModifiedEntitiesForUser in interface ContentEntityObjectDao

getRecentlyModifiedForChangeDigest

public List getRecentlyModifiedForChangeDigest(Date fromDate)

Description copied from interface: ContentEntityObjectDao

Retrieves a list of ContentEntityObjects that have been newly added or modified since the date specified. This list excludes drafts, space descriptions and mail.

Specified by:

getRecentlyModifiedForChangeDigest in interface ContentEntityObjectDao

Parameters:

fromDate - content modified after this date will be returned

Returns:

a list of ContentEntityObjects that have been newly added or modified since the date specified

getRecentlyUpdatedPages

public List<Page> getRecentlyUpdatedPages(int maxCount,
                                          String spaceKey)

Specified by:

getRecentlyUpdatedPages in interface PageDao

getTopLevelPages

public List<Page> getTopLevelPages(Space space)

Specified by:

getTopLevelPages in interface PageDao

getTopLevelPages

public PageResponse<Page> getTopLevelPages(Space space,
                                           LimitedRequest limitedRequest,
                                           com.google.common.base.Predicate<? super Page> predicate)

Specified by:

getTopLevelPages in interface PageDao

getChildren

public PageResponse<Page> getChildren(Page page,
                                      LimitedRequest pageRequest,
                                      com.google.common.base.Predicate<? super Page> predicate,
                                      Depth depth)

Description copied from interface: PageDao

Returns the children of a page which have a status of CURRENT, limited to the pagination requested.

Specified by:

getChildren in interface PageDao

Parameters:

page - the page to find children for

pageRequest - the pagination requested

predicate - predicate used to entities

depth - the depth to return children to

Returns:

the paginated response of Page entities

getDraftChildren

public PageResponse<Page> getDraftChildren(Page page,
                                           LimitedRequest pageRequest,
                                           Depth depth)

Description copied from interface: PageDao

Returns the children of a page which have a status of DRAFT, limited to the pagination requested. Will fetch drafts all drafts regardless of whether the current authenticated user has permission to view the drafts

Specified by:

getDraftChildren in interface PageDao

Parameters:

page - the page to find children for

pageRequest - the pagination requested

depth - the depth to return children to

Returns:

the paginated response of Page entities

getMaxSiblingPosition

public Integer getMaxSiblingPosition(Page page)

Description copied from interface: PageDao

Gets the highest position value of all the page's siblings. This is useful when we need to find what position to assign to a new page that should go to the bottom.

Specified by:

getMaxSiblingPosition in interface PageDao

Parameters:

page - The page whose siblings from which to get the max position

Returns:

The highest position value of all the page's siblings

getPageIds

public Collection<Long> getPageIds(Space space)

Description copied from interface: PageDao

Get the ids of all pages (current and historical) in the given space.

Specified by:

getPageIds in interface PageDao

Parameters:

space - space to retrieve page ids from, can not be null.

Returns:

a Collection of ids for pages.

getAbstractPagesByTitle

public PageResponse<AbstractPage> getAbstractPagesByTitle(String title,
                                                          LimitedRequest pageRequest,
                                                          com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Returns the abstract pages that exactly match the given title, limited to the pagination request. To get just pages or blog posts can be requested just specifying a content type based filter.

Specified by:

getAbstractPagesByTitle in interface PageDao

Parameters:

title - the title of the page to match

pageRequest - the pagination requested

filter - the predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages by title

getAbstractPagesByCreationDate

public PageResponse<AbstractPage> getAbstractPagesByCreationDate(org.joda.time.DateTime date,
                                                                 LimitedRequest pageRequest,
                                                                 com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Returns the abstract pages created on the given date, that also match the given filter, limited to the page request. To get just pages or blog posts can be requested just specifying a content type based filter.

Specified by:

getAbstractPagesByCreationDate in interface PageDao

Parameters:

date - - the creation date to match

pageRequest - the pagination request

filter - the predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages created on the given date

getAbstractPages

public PageResponse<AbstractPage> getAbstractPages(List<ContentType> contentTypes,
                                                   List<ContentStatus> statuses,
                                                   LimitedRequest pageRequest,
                                                   @Nullable
                                                   com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Retrieves a page response of all pages found in this instance of Confluence, within any of the given statuses.

Specified by:

getAbstractPages in interface PageDao

Parameters:

contentTypes - list of content types to find

statuses - list of statuses the pages can be in

pageRequest - the start and offset of the pages to retrieve

filter - the predicate to filter the returned results by, may be null

Returns:

the paginated list of pages

getAbstractPages

public PageResponse<AbstractPage> getAbstractPages(Space space,
                                                   List<ContentType> contentTypes,
                                                   List<ContentStatus> statuses,
                                                   LimitedRequest pageRequest,
                                                   @Nullable
                                                   com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Retrieves a page response for all content (pages and/or blog posts) in the given space, within any of the specified statuses and content types.

Specified by:

getAbstractPages in interface PageDao

Parameters:

space - the space to locate the page in

contentTypes - list of content types to find

statuses - list of statuses the pages can be in

pageRequest - the pagination request

filter - the predicate to pages the returned results by, may be null

Returns:

the paginated list of pages by space, with the given statuses

getAbstractPages

public PageResponse<AbstractPage> getAbstractPages(Space space,
                                                   String title,
                                                   List<ContentStatus> statuses,
                                                   LimitedRequest pageRequest,
                                                   com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Returns the abstract pages from a space that exactly match the given title and are in any of the specified statuses, and match the given filter, limited to the pagination request. To get just pages or blog posts can be requested just specifying a content type based filter.

Specified by:

getAbstractPages in interface PageDao

Parameters:

space - space the page belongs to

title - the title of the page to match

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - the predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages by space and title, with the given statuses

getAbstractPages

public PageResponse<AbstractPage> getAbstractPages(String title,
                                                   List<ContentStatus> statuses,
                                                   LimitedRequest pageRequest,
                                                   com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Returns the abstract pages that exactly match the given title, are in any of the specified statuses, and match the given filter, limited to the pagination request. To get just pages or blog posts can be requested just specifying a content type based filter.

Specified by:

getAbstractPages in interface PageDao

Parameters:

title - the title of the page to match

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - the predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages by title

getAbstractPages

public PageResponse<AbstractPage> getAbstractPages(org.joda.time.DateTime date,
                                                   List<ContentStatus> statuses,
                                                   LimitedRequest pageRequest,
                                                   com.google.common.base.Predicate<? super AbstractPage> filter)

Description copied from interface: PageDao

Returns the abstract pages created on the given date and are in the , that also match the given filter, limited to the page request. To get just pages or blog posts can be requested just specifying a content type based filter.

Specified by:

getAbstractPages in interface PageDao

Parameters:

date - the creation date to match

statuses - list of statuses the content can be in

pageRequest - the pagination request

filter - the predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages created on the given date

getOldestPageCreationDate

public Date getOldestPageCreationDate()

Description copied from interface: ContentEntityObjectDao

Gets the creation date of the oldest page.

Specified by:

getOldestPageCreationDate in interface ContentEntityObjectDao

Returns:

creation date of the oldest page in Confluence

getTrashedContent

public List getTrashedContent(String spaceKey)

Specified by:

getTrashedContent in interface ContentEntityObjectDao

getUndefinedPages

public List<Page> getUndefinedPages(String spaceKey)

Specified by:

getUndefinedPages in interface PageDao

getUndefinedLinks

public final List<OutgoingLink> getUndefinedLinks(@Nullable
                                                  String spaceKey)

Specified by:

getUndefinedLinks in interface PageDao

getVersion

public ContentEntityObject getVersion(long originalVersionContentId,
                                      int version)

Specified by:

getVersion in interface ContentEntityObjectDao

getVersionHistorySummary

public List<VersionHistorySummary> getVersionHistorySummary(long originalContentId)

Specified by:

getVersionHistorySummary in interface ContentEntityObjectDao

getVersionHistorySummary

public PageResponse<VersionHistorySummary> getVersionHistorySummary(long originalContentId,
                                                                    LimitedRequest request)

Description copied from interface: ContentEntityObjectDao

Get version history with pagination. So we don't have issue with super long history.

Specified by:

getVersionHistorySummary in interface ContentEntityObjectDao

Parameters:

originalContentId - the content Id of latest version, the CURRENT version

request - page request contains start, limit fields for pagination purpose.

Returns:

PageResponse of version history.

getVersionEditContributors

public Map<Long,List<ConfluenceUser>> getVersionEditContributors(Iterable<ContentEntityObject> originalVersions)

Description copied from interface: ContentEntityObjectDao

Get version edit contributors for a set of content identifiers. This returns the last modified of all versions of the content.

Specified by:

getVersionEditContributors in interface ContentEntityObjectDao

Parameters:

originalVersions - the contents of latest versions, the CURRENT versions

Returns:

A map between content if and list of contributor users (null indicates anonymous).

getVersionsLastEditedByUser

public Map<Long,ContentEntityObject> getVersionsLastEditedByUser(Collection<Long> contentIds,
                                                                 com.atlassian.sal.api.user.UserKey userKey)

Description copied from interface: ContentEntityObjectDao

Gets the ContentEntityObject objects, either the current version or historical version relating to given contentIds of the current version that was the most recent version edited by the given user. Only content with a "current" status are returned.

Specified by:

getVersionsLastEditedByUser in interface ContentEntityObjectDao

Parameters:

contentIds - the ids of the content we're interested in. These *must* be ids of the latest version.

userKey - the userKey of the user that we're interested in

Returns:

the ContentEntityObject objects relating to the version of the given contentIds that were last edited by the given user.

getVersionsLastEditedByUserNew

public Map<Long,ContentEntityObject> getVersionsLastEditedByUserNew(Collection<Long> contentIds,
                                                                    com.atlassian.sal.api.user.UserKey userKey)

Description copied from interface: ContentEntityObjectDao

Same as ContentEntityObjectDao.getVersionsLastEditedByUser(Collection, UserKey), but a refined implementation for new Recently Worked On Drafts work. TODO: replace ContentEntityObjectDao.getVersionsLastEditedByUser(Collection, UserKey) with the implementation of this method

Specified by:

getVersionsLastEditedByUserNew in interface ContentEntityObjectDao

getContributionStatusByUser

public Map<Long,ContributionStatus> getContributionStatusByUser(Collection<ContentId> contentIds,
                                                                com.atlassian.sal.api.user.UserKey userKey)

Description copied from interface: ContentEntityObjectDao

Identifies the most recent contributions made to a Collection of content by the given user. A contribution can either be a page publish, unpublished changes to a draft or anything that triggers a touch relation.

It takes a Collection of contentIds and returns a Map of contentIds to ContributionStatuses for the supplied Ids. If non existing ContentIds are used, they will not be present in the returned Map. If no contribution status can be found for the supplied contentIds, they will not be present in the returned Map. Anonymous users are not supported.

Specified by:

getContributionStatusByUser in interface ContentEntityObjectDao

Parameters:

contentIds - the IDs of the content we want to query. These *must* be IDs of the latest version

userKey - the userKey of the user who's changes we are interested in

Returns:

the ContributionStatus of each content

refresh

public void refresh(com.atlassian.core.bean.EntityObject objectToRefresh)

Description copied from interface: ObjectDao

Refreshes the object again with the fresh data from db.

Specified by:

refresh in interface ObjectDao

replicate

public void replicate(Object objectToReplicate)

Description copied from interface: ObjectDao

Replicate the object. Replication does not generate a new id if the object does not exist in database and it overwrites the database row if the object already exists in database.

Specified by:

replicate in interface ObjectDao

getLastEditedVersionsOf

public List<ContentEntityObject> getLastEditedVersionsOf(ContentEntityObject content)

Description copied from interface: ContentEntityObjectDao

Retrieves all the last edited versions for each user who has contributed to the specified piece of content. That is, if a user has contributed multiple edits, only the version that corresponds to their latest edit will be added to the list returned. Result will be sorted with the earliest version coming first.

Specified by:

getLastEditedVersionsOf in interface ContentEntityObjectDao

Parameters:

content - content (must be the latest version)

Returns:

the last edited versions for each user who has contributed to the specified piece of content.

findContentBySpaceIdAndStatus

public List<ContentEntityObject> findContentBySpaceIdAndStatus(long spaceId,
                                                               String status,
                                                               int offset,
                                                               int count)

Description copied from interface: ContentEntityObjectDao

Retrieve content for a given space with a particular status. Results will be sorted by descending date of last modification.

Specified by:

findContentBySpaceIdAndStatus in interface ContentEntityObjectDao

Parameters:

spaceId - the id of the space

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

offset - the offset of the first item to retrieve (0-based)

count - the maximum number of items to retrieve

Returns:

the list of content matching the query

findContentBySpaceIdAndStatus

public PageResponse<ContentEntityObject> findContentBySpaceIdAndStatus(long spaceId,
                                                                       String status,
                                                                       LimitedRequest limitedRequest,
                                                                       com.google.common.base.Predicate<Page> predicate)

Description copied from interface: ContentEntityObjectDao

Retrieve content for a given space with a particular status. Results will be sorted by descending date of last modification.

Specified by:

findContentBySpaceIdAndStatus in interface ContentEntityObjectDao

Parameters:

spaceId - the id of the space

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

limitedRequest - - the start and offset of the pages to retrieve

predicate - - a predicate to filter the returned results by

Returns:

a PageResponse of ContentEntityObjects in the space with the given status

countContentBySpaceIdAndStatus

public int countContentBySpaceIdAndStatus(long spaceId,
                                          String status)

Description copied from interface: ContentEntityObjectDao

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

Specified by:

countContentBySpaceIdAndStatus in interface ContentEntityObjectDao

Parameters:

spaceId - the id of the space

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

Returns:

the number of content objects with that status in that space

findHistoricalVersionsAfterVersion

public List findHistoricalVersionsAfterVersion(long originalContentId,
                                               int version)

Specified by:

findHistoricalVersionsAfterVersion in interface ContentEntityObjectDao

findAllDraftsFor

public List<ContentEntityObject> findAllDraftsFor(long contentId)

Description copied from interface: ContentEntityObjectDao

Retrieves a list of drafts for the given content if any drafts exist.

Specified by:

findAllDraftsFor in interface ContentEntityObjectDao

Parameters:

contentId - id of the content to retrieve the draft for

Returns:

a non-null list of drafts, with 0 or more elements.

See Also:

ContentEntityObject.DRAFT

findDraftFor

public ContentEntityObject findDraftFor(long contentId)

Description copied from interface: ContentEntityObjectDao

Retrieves the draft for the given content if exists.

Specified by:

findDraftFor in interface ContentEntityObjectDao

Parameters:

contentId - id of the content to retrieve the draft for

Returns:

the draft for the given content if exists, null otherwise

See Also:

ContentEntityObject.DRAFT

getPageAndBlogPostsVersionsLastEditedByUser

public PageResponse<AbstractPage> getPageAndBlogPostsVersionsLastEditedByUser(com.atlassian.sal.api.user.UserKey userKey,
                                                                              LimitedRequest request)

Description copied from interface: ContentEntityObjectDao

Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification. Only content with a "current" status are returned.

Specified by:

getPageAndBlogPostsVersionsLastEditedByUser in interface ContentEntityObjectDao

Parameters:

userKey - the key for the user for whom to retrieve the modified content

request - the request

getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts

public PageResponse<AbstractPage> getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts(com.atlassian.sal.api.user.UserKey userKey,
                                                                                             LimitedRequest request)

Description copied from interface: ContentEntityObjectDao

Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification. Only content with "current" or "draft" status are returned.

Specified by:

getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts in interface ContentEntityObjectDao

Parameters:

userKey - the key for the user for whom to retrieve the modified content

request - the request

findUnpublishedContentWithUserContributions

public List<ContentEntityObject> findUnpublishedContentWithUserContributions(String username)

Description copied from interface: ContentEntityObjectDao

Retrives the drafts for the given User

Specified by:

findUnpublishedContentWithUserContributions in interface ContentEntityObjectDao

Parameters:

username - the owner of the drafts

Returns:

a list of ContentEntityObject with the ContentEntityObject.DRAFT status

countAllPages

public int countAllPages()

Description copied from interface: PageDao

Counts the total number of all page entities across all spaces, including non-current pages

Specified by:

countAllPages in interface PageDao

Returns:

the number of pages

countCurrentPages

public int countCurrentPages()

Description copied from interface: PageDao

Counts the total number of current pages across all spaces

Specified by:

countCurrentPages in interface PageDao

Returns:

the number of current pages

countDraftPages

public int countDraftPages()

Description copied from interface: PageDao

Counts the number of pages that are drafts. This does not include drafts of pages that have already been published (i.e. pages with unpublished changes).

Specified by:

countDraftPages in interface PageDao

Returns:

the number of draft pages

countPagesWithUnpublishedChanges

public int countPagesWithUnpublishedChanges()

Description copied from interface: PageDao

Counts the number of published pages that have unpublished changes.

Specified by:

countPagesWithUnpublishedChanges in interface PageDao

Returns:

the number of pages with unpublished changes.

getPageCount

public long getPageCount(@Nonnull
                         String spaceKey)

Description copied from interface: PageDao

Get total number of current pages in a space

Specified by:

getPageCount in interface PageDao

Parameters:

spaceKey - the space to look for posts in

Returns:

a count number of pages