Package com.atlassian.confluence.content.persistence.hibernate

Class PluginContentHibernateDao

java.lang.Object

org.springframework.dao.support.DaoSupport

com.atlassian.confluence.core.persistence.hibernate.HibernateObjectDao<CustomContentEntityObject>

com.atlassian.confluence.core.persistence.hibernate.ConfluenceHibernateObjectDao<CustomContentEntityObject>

com.atlassian.confluence.core.persistence.hibernate.VersionedHibernateObjectDao<CustomContentEntityObject>

com.atlassian.confluence.content.persistence.hibernate.PluginContentHibernateDao

All Implemented Interfaces:

CustomContentDao, org.springframework.beans.factory.InitializingBean

public class PluginContentHibernateDao
extends VersionedHibernateObjectDao<CustomContentEntityObject>
implements CustomContentDao

Hibernate Implementation of the CustomContentDao

Nested Class Summary

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

HibernateObjectDao.Cacheability, HibernateObjectDao.HibernateOperations

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
PluginContentHibernateDao()

Method Summary

Modifier and Type	Method	Description
long	countAllByPluginModuleKeys(Collection<String> pluginModuleKeys)	Count CustomContentEntityObjects by multiple plugin module keys across all spaces.
long	countAllInSpaceByPluginModuleKeys(Collection<String> pluginModuleKeys, long spaceId)	Count CustomContentEntityObjects by multiple plugin module keys within a specific space.
long	countChildrenOfType(long parentId, String pluginModuleKey)
Iterator<CustomContentEntityObject>	findAll(String pluginContentKey)	Retrieves an iterator of CustomContentEntityObject with the specified pluginContentKey
Iterator<CustomContentEntityObject>	findAllChildren(long parentId)	Retrieves all children of the specified content.
Iterator<CustomContentEntityObject>	findAllContainedOfType(long containerContentId, String pluginContentKey)
Iterator<CustomContentEntityObject>	findAllInSpace(long spaceId)
Iterator<CustomContentEntityObject>	findAllInSpace(String pluginModuleKey, long spaceId)
Iterator<CustomContentEntityObject>	findAllInSpaceWithAttachments(long spaceId)
Iterator<CustomContentEntityObject>	findAllInSpaceWithAttachments(String pluginModuleKey, long spaceId)
Iterator<CustomContentEntityObject>	findAllWithAttachments(String pluginContentKey)	Retrieves an iterator of CustomContentEntityObject with the specified pluginContentKey.
Iterator<CustomContentEntityObject>	findByPluginModuleKeys(Collection<String> pluginModuleKeys, LimitedRequest limitedRequest)	Find CustomContentEntityObjects by multiple plugin module keys across all spaces with cursor support.
<T> List<T>	findByQuery(ContentQuery<T> contentQuery, boolean cacheable, LimitedRequest limitedRequest)
<T> Iterator<T>	findByQuery(ContentQuery<T> contentQuery, int offset, int maxResults)
Iterator<CustomContentEntityObject>	findChildrenOfType(long parentId, String pluginModuleKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder)
Iterator<CustomContentEntityObject>	findCurrentInSpace(long spaceId, String pluginModuleKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder)
Iterator<CustomContentEntityObject>	findInSpaceByPluginModuleKeys(Collection<String> pluginModuleKeys, long spaceId, LimitedRequest limitedRequest)	Find CustomContentEntityObjects by multiple plugin module keys within a specific space with cursor support.
int	findTotalInSpace(long spaceId, String pluginModuleKey)
CustomContentEntityObject	getById(long id)
Class<CustomContentEntityObject>	getPersistentClass()
protected void	publishEvent(IndexerEventListener.VisitorEvent event)
<T, R> R	query(ContentQuery<T> contentQuery, int offset, int maxResults, Function<org.hibernate.query.Query<T>,R> f)
<T> List<T>	queryForList(ContentQuery<T> contentQuery)	It is strongly recommended that the CustomContentDao.queryForList(ContentQuery, int, int) method be used in preference to this one, as this method does not apply pagination limits to the result set.
<T> List<T>	queryForList(ContentQuery<T> contentQuery, int offset, int maxResults)
void	setDatabaseCapabilities(HibernateDatabaseCapabilities databaseCapabilities)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.1
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

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

applyChildVersioningPolicy, findAllSorted, findLatestVersionsCount, findLatestVersionsIterator, findLatestVersionsIterator, findNamedQueryStringParams, remove, save

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

findNamedQueryStringParams, getContentStatusStringList, getStatusNames, scanFilteredContents, scanFilteredContents, updateModificationData

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

applyTransactionTimeout, checkDaoConfig, createHibernateTemplate, findAll, findAllSorted, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findSingleObject, getByClassId, getCountResult, getHibernateTemplate, getSessionFactory, hibernate, reIndex, save, saveEntity, saveRaw, setHibernateTemplate, setSessionFactory, 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

Constructor Details

PluginContentHibernateDao

public PluginContentHibernateDao()

Method Details

getPersistentClass

public Class<CustomContentEntityObject> getPersistentClass()

Specified by:

getPersistentClass in class HibernateObjectDao<CustomContentEntityObject>

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

setDatabaseCapabilities

@Deprecated(forRemoval=true)
public void setDatabaseCapabilities(HibernateDatabaseCapabilities databaseCapabilities)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.1

Since:

7.13.17

findByQuery

public <T> Iterator<T> findByQuery(ContentQuery<T> contentQuery,
 int offset,
 int maxResults)

Specified by:

findByQuery in interface CustomContentDao

queryForList

public <T> List<T> queryForList(ContentQuery<T> contentQuery,
 int offset,
 int maxResults)

Specified by:

queryForList in interface CustomContentDao

Since:

7.14

query

public <T,
R> R query(ContentQuery<T> contentQuery,
 int offset,
 int maxResults,
 Function<org.hibernate.query.Query<T>,R> f)

queryForList

public <T> List<T> queryForList(ContentQuery<T> contentQuery)

Description copied from interface: CustomContentDao

It is strongly recommended that the CustomContentDao.queryForList(ContentQuery, int, int) method be used in preference to this one, as this method does not apply pagination limits to the result set. This can result in excessive memory pressure. This method should only be used when the query is self-limiting, or when the size of the result set is otherwise known in advance.

Specified by:

queryForList in interface CustomContentDao

Since:

7.16

findByQuery

public <T> List<T> findByQuery(ContentQuery<T> contentQuery,
 boolean cacheable,
 LimitedRequest limitedRequest)

Specified by:

findByQuery in interface CustomContentDao

findTotalInSpace

public int findTotalInSpace(long spaceId,
 String pluginModuleKey)

Specified by:

findTotalInSpace in interface CustomContentDao

findCurrentInSpace

public Iterator<CustomContentEntityObject> findCurrentInSpace(long spaceId,
 String pluginModuleKey,
 int offset,
 int maxResults,
 CustomContentManager.SortField sortField,
 CustomContentManager.SortOrder sortOrder)

Specified by:

findCurrentInSpace in interface CustomContentDao

findAllInSpaceWithAttachments

public Iterator<CustomContentEntityObject> findAllInSpaceWithAttachments(String pluginModuleKey,
 long spaceId)

Specified by:

findAllInSpaceWithAttachments in interface CustomContentDao

findAllInSpace

public Iterator<CustomContentEntityObject> findAllInSpace(String pluginModuleKey,
 long spaceId)

Specified by:

findAllInSpace in interface CustomContentDao

findByPluginModuleKeys

public Iterator<CustomContentEntityObject> findByPluginModuleKeys(Collection<String> pluginModuleKeys,
 LimitedRequest limitedRequest)

Description copied from interface: CustomContentDao

Find CustomContentEntityObjects by multiple plugin module keys across all spaces with cursor support.

Specified by:

findByPluginModuleKeys in interface CustomContentDao

Parameters:

pluginModuleKeys - collection of plugin module keys to search for

limitedRequest - request with cursor and limit information

Returns:

iterator of matching CustomContentEntityObjects

findInSpaceByPluginModuleKeys

public Iterator<CustomContentEntityObject> findInSpaceByPluginModuleKeys(Collection<String> pluginModuleKeys,
 long spaceId,
 LimitedRequest limitedRequest)

Description copied from interface: CustomContentDao

Find CustomContentEntityObjects by multiple plugin module keys within a specific space with cursor support.

Specified by:

findInSpaceByPluginModuleKeys in interface CustomContentDao

Parameters:

pluginModuleKeys - collection of plugin module keys to search for

spaceId - the space ID to search within

limitedRequest - request with cursor and limit information

Returns:

iterator of matching CustomContentEntityObjects

findAllInSpaceWithAttachments

public Iterator<CustomContentEntityObject> findAllInSpaceWithAttachments(long spaceId)

Specified by:

findAllInSpaceWithAttachments in interface CustomContentDao

findAllInSpace

public Iterator<CustomContentEntityObject> findAllInSpace(long spaceId)

Specified by:

findAllInSpace in interface CustomContentDao

findAll

public Iterator<CustomContentEntityObject> findAll(String pluginContentKey)

Description copied from interface: CustomContentDao

Retrieves an iterator of CustomContentEntityObject with the specified pluginContentKey

Specified by:

findAll in interface CustomContentDao

Parameters:

pluginContentKey - CustomContentEntityObject with this plugin content key will be returned

Returns:

iterator of CustomContentEntityObject

findAllWithAttachments

public Iterator<CustomContentEntityObject> findAllWithAttachments(String pluginContentKey)

Description copied from interface: CustomContentDao

Retrieves an iterator of CustomContentEntityObject with the specified pluginContentKey. We are loading

Specified by:

findAllWithAttachments in interface CustomContentDao

Parameters:

pluginContentKey - CustomContentEntityObject with this plugin content key will be returned

Returns:

iterator of CustomContentEntityObject

findAllChildren

public Iterator<CustomContentEntityObject> findAllChildren(long parentId)

Description copied from interface: CustomContentDao

Retrieves all children of the specified content.

Specified by:

findAllChildren in interface CustomContentDao

Parameters:

parentId - children of this content entity will be returned

Returns:

iterator of CustomContentEntityObject

findChildrenOfType

public Iterator<CustomContentEntityObject> findChildrenOfType(long parentId,
 String pluginModuleKey,
 int offset,
 int maxResults,
 CustomContentManager.SortField sortField,
 CustomContentManager.SortOrder sortOrder)

Specified by:

findChildrenOfType in interface CustomContentDao

countChildrenOfType

public long countChildrenOfType(long parentId,
 String pluginModuleKey)

Specified by:

countChildrenOfType in interface CustomContentDao

findAllContainedOfType

public Iterator<CustomContentEntityObject> findAllContainedOfType(long containerContentId,
 String pluginContentKey)

Specified by:

findAllContainedOfType in interface CustomContentDao

countAllByPluginModuleKeys

public long countAllByPluginModuleKeys(Collection<String> pluginModuleKeys)

Description copied from interface: CustomContentDao

Count CustomContentEntityObjects by multiple plugin module keys across all spaces.

Specified by:

countAllByPluginModuleKeys in interface CustomContentDao

Parameters:

pluginModuleKeys - collection of plugin module keys to count

Returns:

total count of matching CustomContentEntityObjects

countAllInSpaceByPluginModuleKeys

public long countAllInSpaceByPluginModuleKeys(Collection<String> pluginModuleKeys,
 long spaceId)

Description copied from interface: CustomContentDao

Count CustomContentEntityObjects by multiple plugin module keys within a specific space.

Specified by:

countAllInSpaceByPluginModuleKeys in interface CustomContentDao

Parameters:

pluginModuleKeys - collection of plugin module keys to count

spaceId - the space ID to search within

Returns:

total count of matching CustomContentEntityObjects in the space

getById

public CustomContentEntityObject getById(long id)

Specified by:

getById in interface CustomContentDao

setEventPublisher

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

publishEvent

protected void publishEvent(IndexerEventListener.VisitorEvent event)

Overrides:

publishEvent in class HibernateObjectDao<CustomContentEntityObject>