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

Class HibernateDraftDao

java.lang.Object

org.springframework.dao.support.DaoSupport

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

com.atlassian.confluence.impl.pages.persistence.dao.HibernateDraftDao

All Implemented Interfaces:

DraftDao, org.springframework.beans.factory.InitializingBean

public class HibernateDraftDao
extends HibernateObjectDao<Draft>
implements DraftDao

Database storage for drafts. Does not permit anonymous drafts (i.e. those with a null username), which should be stored in non-permanent storage like the HTTP session.

See Also:

• SessionDraftDao

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
HibernateDraftDao(org.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method	Description
int	countDrafts(ConfluenceUser creator)
List<Draft>	findAll()	Find all objects of the class provided by getPersistentClass()
List<Draft>	findByCreator(ConfluenceUser creator)	Returns the drafts stored against the given username.
protected Draft	getByClassId(long id)	Retrieve the object with a particular id from the database.
Draft	getDraft(long draftId)	Returns the draft with the given ID, or null if no draft is found with that ID.
Draft	getDraft(String pageId, ConfluenceUser creator, String draftType, String spaceKey)	Finds and returns a draft object with all the specified properties or null if none is found.
Class<Draft>	getPersistentClass()
protected void	publishEvent(IndexerEventListener.VisitorEvent event)
void	remove(Draft draft)	Remove an object from the database
void	saveOrUpdate(Draft draft)	Saves the draft.
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

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

applyTransactionTimeout, checkDaoConfig, createHibernateTemplate, findAllSorted, findAllSorted, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findSingleObject, getCountResult, getHibernateTemplate, getSessionFactory, hibernate, reIndex, save, saveEntity, saveRaw, setHibernateTemplate, setSessionFactory, uniqueResult, updateModificationData

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

HibernateDraftDao

public HibernateDraftDao(org.hibernate.SessionFactory sessionFactory)

Method Details

getPersistentClass

public Class<Draft> getPersistentClass()

Specified by:

getPersistentClass in class HibernateObjectDao<Draft>

getByClassId

protected Draft 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<Draft>

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.

saveOrUpdate

public void saveOrUpdate(Draft draft)
                  throws IllegalArgumentException

Description copied from interface: DraftDao

Saves the draft.

Specified by:

saveOrUpdate in interface DraftDao

Throws:

IllegalArgumentException - if the draft has no page ID, owner or type.

getDraft

public Draft getDraft(String pageId,
 ConfluenceUser creator,
 String draftType,
 String spaceKey)

Description copied from interface: DraftDao

Finds and returns a draft object with all the specified properties or null if none is found.

Specified by:

getDraft in interface DraftDao

Parameters:

pageId - the id of the page which this draft is associated with

creator - the owner of the draft

draftType - the type of draft, which is usually the result of calling ContentEntityObject.getType()

spaceKey - space key, if relevant for the draft. This is used to enable NEW page drafts across multiple spaces

Returns:

a draft object with all the specified properties or null if no valid draft could be found

getDraft

public Draft getDraft(long draftId)

Description copied from interface: DraftDao

Returns the draft with the given ID, or null if no draft is found with that ID.

Specified by:

getDraft in interface DraftDao

remove

public void remove(Draft draft)

Description copied from class: HibernateObjectDao

Remove an object from the database

Specified by:

remove in interface DraftDao

Overrides:

remove in class HibernateObjectDao<Draft>

Parameters:

draft - the object to remove

findByCreator

public List<Draft> findByCreator(ConfluenceUser creator)

Description copied from interface: DraftDao

Returns the drafts stored against the given username.

Specified by:

findByCreator in interface DraftDao

countDrafts

public int countDrafts(ConfluenceUser creator)

Specified by:

countDrafts in interface DraftDao

Returns:

count of number of drafts for this daos owner

findAll

public List<Draft> findAll()

Description copied from class: HibernateObjectDao

Find all objects of the class provided by getPersistentClass()

Specified by:

findAll in interface DraftDao

Overrides:

findAll in class HibernateObjectDao<Draft>

Returns:

a list of all objects of the appropriate class, or the empty list if no objects are found

setEventPublisher

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

publishEvent

protected void publishEvent(IndexerEventListener.VisitorEvent event)

Overrides:

publishEvent in class HibernateObjectDao<Draft>