com.atlassian.confluence.core.persistence.hibernate

Class ContentEntityObjectHibernateDao

java.lang.Object

org.springframework.dao.support.DaoSupport

com.atlassian.confluence.core.persistence.hibernate.HibernateObjectDao

com.atlassian.confluence.core.persistence.hibernate.VersionedHibernateObjectDao

com.atlassian.confluence.core.persistence.hibernate.ContentEntityObjectHibernateDao

All Implemented Interfaces:

ObjectDao, ContentEntityObjectDao, VersionedObjectDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

DefaultContentDao, HibernateMailDao, HibernatePageDao, HibernateUserStatusDao, PluginContentHibernateDao

public class ContentEntityObjectHibernateDao
extends VersionedHibernateObjectDao
implements ContentEntityObjectDao

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.core.persistence.hibernate.HibernateObjectDao

HibernateObjectDao.Cacheability

Field Summary

Fields

Modifier and Type	Field and Description
static long	ONE_DAY

Fields inherited from class com.atlassian.confluence.core.persistence.hibernate.VersionedHibernateObjectDao

cacheFactory, confluenceUserDao

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface bucket.core.persistence.ObjectDao

NON_CACHEABLE

Constructor Summary

Constructors

Constructor and Description
ContentEntityObjectHibernateDao()

Method Summary

Modifier and Type	Method and Description
int	countContentBySpaceIdAndStatus(long spaceId, String status) Retrieve the count of content for a given space with a particular status.
List<ContentEntityObject>	findAllDraftsFor(long contentId) Retrieves a list of drafts for the given content if any drafts exist.
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.
ContentEntityObject	findDraftFor(long contentId) Retrieves the draft for the given content if exists.
List	findHistoricalVersionsAfterVersion(long originalContentId, int version)
List	findPreviousVersions(long originalContentId)
List<ContentEntityObject>	findUnpublishedContentWithUserContributions(String username) Retrives the drafts for the given User
Iterator	getAllCurrentEntities()
protected ContentEntityObject	getByClassId(long id) Retrieve the object with a particular id from the database.
ContentEntityObject	getById(long id)
List	getContentAuthoredByUser(String username)
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.
String	getObjectType(long id)
Date	getOldestPageCreationDate() Gets the creation date of the oldest page.
PageResponse<AbstractPage>	getPageAndBlogPostsVersionsLastEditedByUser(com.atlassian.sal.api.user.UserKey userKey, LimitedRequest limitedRequest) 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.
Class	getPersistentClass()
Iterator	getRecentlyAddedEntities(String spaceKey, int maxResults)
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	getTrashedContent(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.

Methods inherited from class com.atlassian.confluence.core.persistence.hibernate.VersionedHibernateObjectDao

findAllSorted, findLatestVersionsCount, findLatestVersionsCount, findLatestVersionsIterator, findLatestVersionsIterator, findNamedQueryStringParams, findNamedQueryStringParams, save, setCacheFactory, setConfluenceUserDao, updateModificationData

Methods inherited from class com.atlassian.confluence.core.persistence.hibernate.HibernateObjectDao

applyTransactionTimeout, applyTransactionTimeout, checkDaoConfig, createHibernateTemplate, findAll, findAllSorted, findByClassIds, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findSingleObject, getCountResult, getHibernateTemplate, getSession, getSessionFactory, index, refresh, reIndex, remove, replicate, save, saveRaw, setHibernateTemplate, setIndexer, setSessionFactory, unIndex, uniqueResult

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.core.persistence.VersionedObjectDao

findLatestVersionsCount, findLatestVersionsIterator, save

Methods inherited from interface bucket.core.persistence.ObjectDao

findAll, findAllSorted, findAllSorted, findByClassIds, refresh, remove, replicate, save, saveRaw

Field Detail

ONE_DAY

public static final long ONE_DAY

See Also:

Constant Field Values

Constructor Detail

ContentEntityObjectHibernateDao

public ContentEntityObjectHibernateDao()

Method Detail

getPersistentClass

public Class getPersistentClass()

Specified by:

getPersistentClass in interface ObjectDao

getById

public ContentEntityObject getById(long id)

Specified by:

getById in interface ContentEntityObjectDao

getByClassId

protected ContentEntityObject getByClassId(long id)

Description copied from class: HibernateObjectDao

Retrieve the object with a particular id from the database. The object must be of the same class as the DAO's getPersistentClass() method returns.

Overrides:

getByClassId in class HibernateObjectDao

Parameters:

id - the id of the object to look up

Returns:

the corresponding object, or null if the object does not exist with the appropriate class and id.

getContentAuthoredByUser

public List getContentAuthoredByUser(String username)

Specified by:

getContentAuthoredByUser in interface ContentEntityObjectDao

getAllCurrentEntities

public Iterator getAllCurrentEntities()

Specified by:

getAllCurrentEntities in interface ContentEntityObjectDao

getRecentlyAddedEntities

public Iterator getRecentlyAddedEntities(String spaceKey,
                                         int maxResults)

Specified by:

getRecentlyAddedEntities in interface ContentEntityObjectDao

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

getFirstVersionBefore

public ContentEntityObject getFirstVersionBefore(long originalVersionContentId,
                                                 int version)

Specified by:

getFirstVersionBefore in interface ContentEntityObjectDao

getFirstVersionAfter

public ContentEntityObject getFirstVersionAfter(long originalVersionContentId,
                                                int version)

Specified by:

getFirstVersionAfter in interface ContentEntityObjectDao

getVersion

public ContentEntityObject getVersion(long originalVersionContentId,
                                      int version)

Specified by:

getVersion 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

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 - latest version

Returns:

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

getTrashedContent

public List getTrashedContent(String spaceKey)

Specified by:

getTrashedContent in interface ContentEntityObjectDao

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

getObjectType

public String getObjectType(long id)

Specified by:

getObjectType in interface ContentEntityObjectDao

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.

getPageAndBlogPostsVersionsLastEditedByUser

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

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

limitedRequest - the request

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

findPreviousVersions

public List findPreviousVersions(long originalContentId)

Specified by:

findPreviousVersions in interface ContentEntityObjectDao

findHistoricalVersionsAfterVersion

public List findHistoricalVersionsAfterVersion(long originalContentId,
                                               int version)

Specified by:

findHistoricalVersionsAfterVersion in interface ContentEntityObjectDao

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

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

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