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

Interface PageDao

All Known Subinterfaces:
PageDaoInternal
All Known Implementing Classes:
HibernatePageDao
@Deprecated(forRemoval=true) public interface PageDao
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7 use PageDaoInternal

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    countAllPages()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Counts the total number of all page entities across all spaces, including non-current pages
    int
    countCurrentPages()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Counts the total number of current pages across all spaces
    int
    countDraftPages()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Counts the number of pages that are drafts.
    int
    countPagesInSubtree(@NonNull Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return total descendant page including input page
    int
    countPagesWithUnpublishedChanges()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Counts the number of published pages that have unpublished changes.
    List<AbstractPage>
    findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String blogTitle, Space space, int maxResultCount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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<ContentPermissionSummary>
    findContentPermissionSummaryByIds(Collection<Long> ids)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get Content creator for bulk permission checking
    List<AbstractPage>
    findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String pageTitle, Space space, int maxResultCount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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>
    getAllChildren(Page page, LimitedRequest pageRequest)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns all children of a page (including drafts), limited to the pagination requested.
    Map<Long,List<Long>>
    getAncestorsFor(Collection<Long> ids)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the list page ids of the ancestors of the given page ids.
    int
    getAuthoredPagesCountByUser(ConfluenceUser user)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Long>
    getChildrenIds(Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds the ids of all children pages of the given page
    List<Long>
    getChildrenIds(Page page, List<ContentStatus> statuses)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds the ids of all children pages of the given page
    int
    getCommentCountOnPage(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Count the number of comments on the passed in page.
    List<Long>
    getDescendantIds(Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds the ids of all descendant pages of the given page
    List<Long>
    getDescendantIds(Page page, ContentStatus... statuses)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds the ids of all descendant pages of the given page
    List<Page>
    getDescendants(Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds all descendant pages (recursive) of the given page
    List<String>
    getDescendantTitles(Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds all descendant titles of the given page
    List<Page>
    getDraftChildren(Page page, LimitedRequest pageRequest)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the children of a page which have a status of DRAFT, limited to the pagination requested.
    Integer
    getMaxSiblingPosition(Page page)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the highest position value of all the page's siblings.
    List<Page>
    getOrphanedPages(@Nullable String spaceKey)
    Deprecated.
    since 7.0.0, no replacement
    Page
    getPage(Space space, String pageTitle)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the page by space and title.
    Page
    getPageById(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the page with the given id.
    Page
    getPageByIdWithComments(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the page with the given id, and perform an eager load of the comments and their children.
    long
    getPageCount(@NonNull String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get total number of current pages in a space
    long
    getPageCount(@NonNull String spaceKey, List<ContentStatus> statuses)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get total number of pages in a space, within any of the given statuses.
    Collection<Long>
    getPageIds(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the ids of all pages (current and historical) in the given space.
    List<Page>
    getPageInTrash(String spaceKey, String title)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getPages(@Nullable Space space, boolean currentOnly)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getPagesByIds(Iterable<Long> ids)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the pages with the given ids.
    List<Page>
    getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getPagesStartingWith(Space space, String s)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<PageStatisticsDTO>
    getPageStatistics()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Fetches statistics about pages
    List<Page>
    getPagesWithPermissions(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get all current pages in a space and eagerly fetch permissions at the same time.
    Page
    getPageWithComments(Space space, String pageTitle)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the page by space and title, and perform an eager load of the comments and their children.
    List<Page>
    getPermissionPages(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getRecentlyAddedPages(int maxCount, @Nullable String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getRecentlyUpdatedPages(int maxCount, @Nullable String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getTopLevelPages(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<OutgoingLink>
    getUndefinedLinks(@Nullable String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Page>
    getUndefinedPages(@Nullable String spaceKey)
    Deprecated.
    since 6.6.0, use getUndefinedLinks(String)

  • Method Details

    • getPageById

      Page getPageById(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the page with the given id.
      Parameters:
      id - of the page to load
      Returns:
      the page with the given id, or null if no such page exists

    • getPagesByIds

      List<Page> getPagesByIds(Iterable<Long> ids)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the pages with the given ids.
      Since:
      4.2

    • getPageByIdWithComments

      Page getPageByIdWithComments(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      Parameters:
      id - of the page to load
      Returns:
      the page with the given id, or null if no such page exists

    • getCommentCountOnPage

      int getCommentCountOnPage(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Count the number of comments on the passed in page.

    • getPage

      Page getPage(Space space, String pageTitle)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the page by space and title.
      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

      Page getPageWithComments(Space space, String pageTitle)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      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

      List<Page> getPages(@Nullable Space space, boolean currentOnly)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPagesWithPermissions

      List<Page> getPagesWithPermissions(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      Returns:
      a list of all the current pages in a space
      Since:
      6.1.3

    • getPagesStartingWith

      List<Page> getPagesStartingWith(Space space, String s)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRecentlyAddedPages

      List<Page> getRecentlyAddedPages(int maxCount, @Nullable String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRecentlyUpdatedPages

      List<Page> getRecentlyUpdatedPages(int maxCount, @Nullable String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getOrphanedPages

      @Deprecated List<Page> getOrphanedPages(@Nullable String spaceKey)
      Deprecated.
      since 7.0.0, no replacement

      This should be removed as the result of this ticket https://jira.atlassian.com/browse/CONFSRVDEV-10111

    • getUndefinedPages

      @Deprecated List<Page> getUndefinedPages(@Nullable String spaceKey)
      Deprecated.
      since 6.6.0, use getUndefinedLinks(String)

    • getUndefinedLinks

      List<OutgoingLink> getUndefinedLinks(@Nullable String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since:
      6.6.0

    • getPermissionPages

      List<Page> getPermissionPages(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getAuthoredPagesCountByUser

      int getAuthoredPagesCountByUser(ConfluenceUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since:
      9.0

    • getPagesCreatedOrUpdatedSinceDate

      List<Page> getPagesCreatedOrUpdatedSinceDate(Date previousLoginDate)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • findPagesWithCurrentOrHistoricalTitleInPermittedSpace

      List<AbstractPage> findPagesWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder, String pageTitle, Space space, int maxResultCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Parameters:
      pageTitle - title of a page in a previous version.
      space - Space to search. Must not be null.
      maxResultCount - maximum pages to return
      Since:
      5.9

    • findBlogsWithCurrentOrHistoricalTitleInPermittedSpace

      List<AbstractPage> findBlogsWithCurrentOrHistoricalTitleInPermittedSpace(SpacePermissionQueryBuilder permissionQueryBuilder, String blogTitle, Space space, int maxResultCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      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
      Since:
      5.9

    • findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept

      List<AbstractPage> findBlogsWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String blogTitle, Space space, int maxResultCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Parameters:
      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
      Since:
      5.9

    • findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept

      List<AbstractPage> findPagesWithCurrentOrHistoricalTitleInAllPermittedSpacesExcept(SpacePermissionQueryBuilder permissionQueryBuilder, String pageTitle, Space space, int maxResultCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      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
      Since:
      5.9

    • findContentPermissionSummaryByIds

      List<ContentPermissionSummary> findContentPermissionSummaryByIds(Collection<Long> ids)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Content creator for bulk permission checking
      Parameters:
      ids - of Content
      Returns:
      list contain information for permission checking
      Since:
      6.0

    • countCurrentPages

      int countCurrentPages()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Counts the total number of current pages across all spaces
      Returns:
      the number of current pages
      Since:
      5.9

    • countDraftPages

      int countDraftPages()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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).
      Returns:
      the number of draft pages
      Since:
      6.3.1

    • countPagesWithUnpublishedChanges

      int countPagesWithUnpublishedChanges()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Counts the number of published pages that have unpublished changes.
      Returns:
      the number of pages with unpublished changes.
      Since:
      6.3.1

    • countAllPages

      int countAllPages()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Counts the total number of all page entities across all spaces, including non-current pages
      Returns:
      the number of pages
      Since:
      5.9

    • getPageStatistics

      Optional<PageStatisticsDTO> getPageStatistics()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Fetches statistics about pages
      Returns:
      a PageStatisticsDTO with information about pages such as total, current, and draft count
      Since:
      6.11.0

    • getPageCount

      long getPageCount(@NonNull String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get total number of current pages in a space
      Parameters:
      spaceKey - the space to look for pages in
      Returns:
      a count number of pages
      Since:
      6.1.3

    • getPageCount

      long getPageCount(@NonNull String spaceKey, List<ContentStatus> statuses)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get total number of pages in a space, within any of the given statuses.
      Parameters:
      spaceKey - the space to look for pages in
      statuses - list of statuses the pages can be in
      Returns:
      a count number of pages
      Since:
      7.14.0

    • getPageInTrash

      List<Page> getPageInTrash(String spaceKey, String title)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getAncestorsFor

      Map<Long,List<Long>> getAncestorsFor(Collection<Long> ids)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list page ids of the ancestors of the given page ids.
      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
      Since:
      6.0

    • getDescendants

      List<Page> getDescendants(Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds all descendant pages (recursive) of the given page
      Returns:
      List of descendant pages

    • getDescendantTitles

      List<String> getDescendantTitles(Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds all descendant titles of the given page
      Returns:
      List of descendant titles

    • getDescendantIds

      List<Long> getDescendantIds(Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds the ids of all descendant pages of the given page
      Returns:
      List of page ids

    • getChildrenIds

      List<Long> getChildrenIds(Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds the ids of all children pages of the given page
      Returns:
      List of page ids

    • getDescendantIds

      List<Long> getDescendantIds(Page page, ContentStatus... statuses)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds the ids of all descendant pages of the given page
      Parameters:
      page -
      Returns:
      List of page ids

    • getChildrenIds

      List<Long> getChildrenIds(Page page, List<ContentStatus> statuses)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds the ids of all children pages of the given page
      Parameters:
      page -
      Returns:
      List of page ids

    • countPagesInSubtree

      int countPagesInSubtree(@NonNull Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return total descendant page including input page
      Returns:
      total page

    • getTopLevelPages

      List<Page> getTopLevelPages(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDraftChildren

      List<Page> getDraftChildren(Page page, LimitedRequest pageRequest)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Parameters:
      page - the page to find children for
      pageRequest - the pagination requested
      Returns:
      the paginated response of Page entities

    • getAllChildren

      List<Page> getAllChildren(Page page, LimitedRequest pageRequest)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns all children of a page (including drafts), limited to the pagination requested.
      Parameters:
      page - the page to find children for
      pageRequest - the pagination requested
      Returns:
      the paginated response of Page entities
      Since:
      6.7.1

    • getMaxSiblingPosition

      Integer getMaxSiblingPosition(Page page)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      Parameters:
      page - The page whose siblings from which to get the max position
      Returns:
      The highest position value of all the page's siblings
      Since:
      3.5.12

    • getPageIds

      Collection<Long> getPageIds(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the ids of all pages (current and historical) in the given space.
      Parameters:
      space - space to retrieve page ids from, can not be null.
      Returns:
      a Collection of ids for pages.
      Since:
      4.2