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.

Constructor Summary

CachingPageDao(PageDao delegateDao, PageIdCache pageIdCache)

Method Summary

int	countContentBySpaceIdAndStatus(long spaceId, String status) Retrieve the count of content for a given space with a particular status.
List	findAll() Find all objects currently persisted of a particular type.
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>	findBlogsWithHistoricalTitleInPermittedSpace(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.
List<ContentEntityObject>	findContentBySpaceIdAndStatus(long spaceId, String status, int offset, int count) Retrieve content for a given space with a particular status.
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<Page>	findPagesWithHistoricalTitle(String pageTitle)
List<AbstractPage>	findPagesWithHistoricalTitleInAllPermittedSpacesExcept(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>	findPagesWithHistoricalTitleInPermittedSpace(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	findPreviousVersions(long originalContentId)
Iterator	getAllCurrentEntities()
int	getAuthoredPagesCountByUser(String username)
ContentEntityObject	getById(long id)
int	getCommentCountOnPage(long id) Count the number of comments on the passed in page.
List	getContentAuthoredByUser(String username)
List<Long>	getDescendentIds(Page page)
List<Page>	getDescendents(Page page)
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.
List	getLockedContentBySpace(String spaceKey)
Integer	getMaxSiblingPosition(Page page) Gets the highest position value of all the page's siblings.
String	getObjectType(long id)
List<Page>	getOrphanedPages(String spaceKey)
Page	getPage(Space space, String pageTitle) Get the page by space and title.
Page	getPage(String spaceKey, String pageTitle) Deprecated.
Page	getPage(String spaceKey, String pageTitle, boolean eagerLoadComments) Deprecated.
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.
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)
List<Page>	getPages(Space space, boolean currentOnly)
Collection<Page>	getPagesByIds(Collection<Long> ids) Get the pages with the given ids.
List<Page>	getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)
List<Page>	getPagesStartingWith(Space space, String s)
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)
List	getTrashedContent(String spaceKey)
List<Page>	getUndefinedPages(String spaceKey)
ContentEntityObject	getVersion(long originalVersionContentId, int version)
List<VersionHistorySummary>	getVersionHistorySummary(long originalContentId)
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	removeFromPageKeyCache(String spaceKey, String pageTitle) Deprecated.
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

public CachingPageDao(PageDao delegateDao,
                      PageIdCache pageIdCache)

Method Detail

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

removeFromPageKeyCache

@Deprecated
public void removeFromPageKeyCache(String spaceKey,
                                              String pageTitle)

Deprecated.

Specified by:

removeFromPageKeyCache in interface PageDao

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

public List findAll()

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type.

Specified by:

findAll in interface ObjectDao

findAllSorted

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

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.

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

findPagesWithHistoricalTitleInPermittedSpace

public List<AbstractPage> findPagesWithHistoricalTitleInPermittedSpace(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:

findPagesWithHistoricalTitleInPermittedSpace in interface PageDao

Parameters:

pageTitle - title of a page in a previous version.

space - Space to search. Must not be null.

maxResultCount - maximum pages to return

findBlogsWithHistoricalTitleInPermittedSpace

public List<AbstractPage> findBlogsWithHistoricalTitleInPermittedSpace(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:

findBlogsWithHistoricalTitleInPermittedSpace in interface PageDao

Parameters:

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

findPagesWithHistoricalTitleInAllPermittedSpacesExcept

public List<AbstractPage> findPagesWithHistoricalTitleInAllPermittedSpacesExcept(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:

findPagesWithHistoricalTitleInAllPermittedSpacesExcept in interface PageDao

Parameters:

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

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

getDescendentIds

public List<Long> getDescendentIds(Page page)

Specified by:

getDescendentIds in interface PageDao

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

getLockedContentBySpace

public List getLockedContentBySpace(String spaceKey)

Specified by:

getLockedContentBySpace 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 Collection<Page> getPagesByIds(Collection<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

getPages

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

Specified by:

getPages in interface PageDao

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

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.

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

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

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

getPage

@Deprecated
public Page getPage(String spaceKey,
                               String pageTitle,
                               boolean eagerLoadComments)

Deprecated.

Description copied from interface: PageDao

Get the page by space key 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:

getPage in interface PageDao

Parameters:

spaceKey - to match with

pageTitle - to match with

eagerLoadComments - true if comments should be loaded eagerly

Returns:

the page

getPage

@Deprecated
public Page getPage(String spaceKey,
                               String pageTitle)

Deprecated.

Specified by:

getPage in interface PageDao

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

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