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

Class HibernatePageDao

java.lang.Object
org.springframework.dao.support.DaoSupport
com.atlassian.confluence.core.persistence.hibernate.HibernateObjectDao<T>
com.atlassian.confluence.core.persistence.hibernate.ConfluenceHibernateObjectDao<T>
com.atlassian.confluence.core.persistence.hibernate.VersionedHibernateObjectDao<Page>
com.atlassian.confluence.pages.persistence.dao.hibernate.HibernatePageDao
All Implemented Interfaces:
PageDaoInternal, PageDao, org.springframework.beans.factory.InitializingBean
public class HibernatePageDao extends VersionedHibernateObjectDao<Page> implements PageDaoInternal

  • Constructor Details

    • HibernatePageDao

      public HibernatePageDao()

  • Method Details

    • 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)
      Description copied from interface: PageDao
      Get the pages with the given ids.
      Specified by:
      getPagesByIds in interface PageDao

    • 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

    • 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

    • getPage

      public Page getPage(Space space, String pageTitle, boolean eagerLoadComments)

    • 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

    • 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

    • getPages

      public List<Page> getPages(@Nullable Space space, boolean currentOnly)
      Specified by:
      getPages in interface PageDao

    • getPagesWithPermissions

      public List<Page> getPagesWithPermissions(@NonNull 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 List<Page> getPages(LimitedRequest pageRequest)
      Specified by:
      getPages in interface PageDaoInternal

    • getPages

      public List<Page> getPages(Space space, LimitedRequest pageRequest)
      Specified by:
      getPages in interface PageDaoInternal

    • getBlogPosts

      public List<BlogPost> getBlogPosts(Space space, LimitedRequest limitedRequest)
      Specified by:
      getBlogPosts in interface PageDaoInternal

    • getAbstractPages

      public List<AbstractPage> getAbstractPages(Space space, List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Specified by:
      getAbstractPages in interface PageDaoInternal

    • getAbstractPages

      public List<AbstractPage> getAbstractPages(List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Specified by:
      getAbstractPages in interface PageDaoInternal

    • 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 List<AbstractPage> getAbstractPagesByTitle(String title, LimitedRequest limitedRequest)
      Specified by:
      getAbstractPagesByTitle in interface PageDaoInternal

    • getAbstractPagesByCreationDate

      public List<AbstractPage> getAbstractPagesByCreationDate(com.atlassian.core.util.DateUtils.DateRange range, LimitedRequest pageRequest)
      Specified by:
      getAbstractPagesByCreationDate in interface PageDaoInternal

    • getAbstractPages

      public List<AbstractPage> getAbstractPages(Space space, String title, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Specified by:
      getAbstractPages in interface PageDaoInternal

    • getAbstractPages

      public List<AbstractPage> getAbstractPages(String title, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Specified by:
      getAbstractPages in interface PageDaoInternal

    • getAbstractPages

      public List<AbstractPage> getAbstractPages(com.atlassian.core.util.DateUtils.DateRange range, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Specified by:
      getAbstractPages in interface PageDaoInternal

    • getPagesStartingWith

      public List<Page> getPagesStartingWith(Space space, String s)
      Specified by:
      getPagesStartingWith in interface PageDao

    • getRecentlyAddedPages

      public List<Page> getRecentlyAddedPages(int maxCount, @Nullable String spaceKey)
      Specified by:
      getRecentlyAddedPages in interface PageDao

    • getRecentlyUpdatedPages

      public List<Page> getRecentlyUpdatedPages(int maxCount, @Nullable String spaceKey)
      Specified by:
      getRecentlyUpdatedPages in interface PageDao

    • getOrphanedPages

      public List<Page> getOrphanedPages(@Nullable String spaceKey)
      Specified by:
      getOrphanedPages in interface PageDao

    • getUndefinedPages

      @Deprecated public List<Page> getUndefinedPages(@Nullable String spaceKey)
      Deprecated.
      since 6.6.0, use getUndefinedLinks(String)
      Specified by:
      getUndefinedPages in interface PageDao

    • getUndefinedLinks

      public final List<OutgoingLink> getUndefinedLinks(@Nullable String spaceKey)
      Specified by:
      getUndefinedLinks in interface PageDao

    • getUndefinedLinks

      public final List<OutgoingLink> getUndefinedLinks(@Nullable String spaceKey, LimitedRequest limitedRequest)
      Description copied from interface: PageDaoInternal
      Retrieve the undefined links in a space.
      Specified by:
      getUndefinedLinks in interface PageDaoInternal
      Parameters:
      spaceKey - space key
      Returns:
      the list of outgoing links

    • getUndefinedLinksCount

      public final long getUndefinedLinksCount(String spaceKey)
      Description copied from interface: PageDaoInternal
      Retrieve the undefined links count in a space.
      Specified by:
      getUndefinedLinksCount in interface PageDaoInternal
      Parameters:
      spaceKey - space key
      Returns:
      the count of outgoing links

    • getPermissionPages

      public List<Page> getPermissionPages(Space space)
      Specified by:
      getPermissionPages in interface PageDao

    • getPermissionPages

      public Collection<Page> getPermissionPages(Space space, LimitedRequest limitedRequest)
      Description copied from interface: PageDaoInternal
      Pagination permission pages for particular Space
      Specified by:
      getPermissionPages in interface PageDaoInternal
      Returns:
      Collection of permission pages within the request range

    • getPermissionPagesCount

      public long getPermissionPagesCount(Space space)
      Description copied from interface: PageDaoInternal
      Get total number of permission pages for particular Space
      Specified by:
      getPermissionPagesCount in interface PageDaoInternal
      Returns:
      the count

    • convertToBlogPost

      public int convertToBlogPost(ContentId id, Date currentDate)
      Description copied from interface: PageDaoInternal
      Convert the page with given id into a blogpost
      Specified by:
      convertToBlogPost in interface PageDaoInternal
      Parameters:
      id - of page to be converted
      currentDate - current Date which would be updated as the creation date for blogpost
      Returns:
      the number of rows updated in the database

    • countSpaceContentByTypedAndStatuses

      public long countSpaceContentByTypedAndStatuses(Space space, List<ContentType> contentTypes, List<ContentStatus> contentStatuses)
      Description copied from interface: PageDaoInternal
      Retrieve the latest content count of specific content type for a given space with a particular status.
      Specified by:
      countSpaceContentByTypedAndStatuses in interface PageDaoInternal
      Parameters:
      space - the space
      contentTypes - type of contents
      contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED
      Returns:
      the number of content objects with that status in that space

    • countContentByTypedAndStatuses

      public long countContentByTypedAndStatuses(List<ContentType> contentTypes, List<ContentStatus> contentStatuses)
      Description copied from interface: PageDaoInternal
      Retrieve the latest content count of specific content type for a given space with a particular status.
      Specified by:
      countContentByTypedAndStatuses in interface PageDaoInternal
      Parameters:
      contentTypes - type of contents
      contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED
      Returns:
      the number of content objects with that status in that space

    • getAuthoredPagesCountByUser

      public int getAuthoredPagesCountByUser(ConfluenceUser user)
      Specified by:
      getAuthoredPagesCountByUser in interface PageDao

    • getRecentlyAuthoredPagesByUser

      public List<Page> getRecentlyAuthoredPagesByUser(ConfluenceUser user, int maxCount)

    • getPagesCreatedOrUpdatedSinceDate

      public List<Page> getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)
      Specified by:
      getPagesCreatedOrUpdatedSinceDate in interface PageDao

    • getPersistentClass

      public Class getPersistentClass()
      Specified by:
      getPersistentClass in class HibernateObjectDao<Page>

    • 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

    • 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 pages in
      Returns:
      a count number of pages

    • getPageCount

      public long getPageCount(@NonNull String spaceKey, List<ContentStatus> statuses)
      Description copied from interface: PageDao
      Get total number of pages in a space, within any of the given statuses.
      Specified by:
      getPageCount in interface PageDao
      Parameters:
      spaceKey - the space to look for pages in
      statuses - list of statuses the pages can be in
      Returns:
      a count number of pages

    • getPageStatistics

      public Optional<PageStatisticsDTO> getPageStatistics()
      Description copied from interface: PageDao
      Fetches statistics about pages
      Specified by:
      getPageStatistics in interface PageDao
      Returns:
      a PageStatisticsDTO with information about pages such as total, current, and draft count

    • 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

    • getPageInTrash

      public List<Page> getPageInTrash(String spaceKey, String title)
      Specified by:
      getPageInTrash 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

    • countPagesInSubtree

      public int countPagesInSubtree(@NonNull Page page)
      Description copied from interface: PageDao
      Return total descendant page including input page
      Specified by:
      countPagesInSubtree in interface PageDao
      Returns:
      total page

    • 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

    • 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

    • 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... contentStatus)
      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

    • getTopLevelPages

      public List<Page> getTopLevelPages(Space space)
      Specified by:
      getTopLevelPages in interface PageDao

    • getTopLevelPages

      public List<Page> getTopLevelPages(Space space, LimitedRequest limitedRequest)
      Specified by:
      getTopLevelPages in interface PageDaoInternal

    • getChildren

      public List<Page> getChildren(Page page, LimitedRequest pageRequest)
      Specified by:
      getChildren in interface PageDaoInternal

    • getDraftChildren

      public List<Page> getDraftChildren(Page page, LimitedRequest pageRequest)
      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
      Returns:
      the paginated response of Page entities

    • getAllChildren

      public List<Page> getAllChildren(Page page, LimitedRequest pageRequest)
      Description copied from interface: PageDao
      Returns all children of a page (including drafts), limited to the pagination requested.
      Specified by:
      getAllChildren in interface PageDao
      Parameters:
      page - the page to find children for
      pageRequest - the pagination requested
      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

    • scanFilteredSpaceAbstractPages

      public List<AbstractPage> scanFilteredSpaceAbstractPages(List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Description copied from interface: PageDaoInternal
      Retrieves a page response of Abstract Page with specified content types and content statuses.
      Specified by:
      scanFilteredSpaceAbstractPages in interface PageDaoInternal
      statuses - list of content status which we are interested to fetch
      pageRequest - limit and cursor of the pages to retrieve. Cursor in pageRequest can't be null.
      Returns:
      the paginated list of pages

    • scanFilteredSpaceAbstractPages

      public List<AbstractPage> scanFilteredSpaceAbstractPages(Space space, List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest)
      Description copied from interface: PageDaoInternal
      Retrieves a page response of all Abstract Page in a Space with specified content types and content statuses.
      Specified by:
      scanFilteredSpaceAbstractPages in interface PageDaoInternal
      Parameters:
      space - the space to locate the page in
      contentTypes - content status to match
      statuses - content status to match
      pageRequest - limit and cursor of the pages to retrieve. Cursor in pageRequest can't be null.
      Returns:
      the paginated list of pages

    • getById

      public Page getById(long id)

    • setEventPublisher

      public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

    • publishEvent

      protected void publishEvent(IndexerEventListener.VisitorEvent event)
      Overrides:
      publishEvent in class HibernateObjectDao<Page>