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

Class HibernateDraftDao

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate.support.HibernateDaoSupport

com.atlassian.hibernate.HibernateObjectDao

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

All Implemented Interfaces:

ObjectDao, DraftDao, org.springframework.beans.factory.InitializingBean

public class HibernateDraftDao
extends HibernateObjectDao
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

Field Summary

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
HibernateDraftDao()

Method Summary

Methods

Modifier and Type	Method and Description
int	countDrafts(java.lang.String creatorName)
java.util.List<Draft>	findByCreatorName(java.lang.String creatorName) Returns the drafts stored against the given username.
java.util.List<Draft>	getAllDraftsForSpace(java.lang.String spaceKey)
protected Draft	getByClassId(long id)
Draft	getDraft(long draftId) Returns the draft with the given ID, or null if no draft is found with that ID.
Draft	getDraft(java.lang.Long pageId, java.lang.String creatorName, java.lang.String draftType, java.lang.String spaceKey) Deprecated.
Draft	getDraft(java.lang.String pageId, ConfluenceUser creator, java.lang.String draftType, java.lang.String spaceKey) Finds and returns a draft object with all the specified properties or null if none is found.
Draft	getDraft(java.lang.String pageId, java.lang.String creatorName, java.lang.String draftType, java.lang.String spaceKey) Deprecated.
java.lang.Class	getPersistentClass()
void	remove(Draft draft) Removes a draft based on its page ID, owner and type.
void	remove(long id) Remove a draft based on its ID.
void	removeAll() Removes all drafts in the data store.
void	saveOrUpdate(Draft draft) Saves the draft.
void	setConfluenceUserDao(ConfluenceUserDao confluenceUserDao)
void	updateSpaceKey(java.lang.String newSpaceKey, java.lang.String oldSpaceKey) Changes all drafts with a space key of oldSpaceKey to have newSpaceKey.

Methods inherited from class com.atlassian.hibernate.HibernateObjectDao

findAll, findAllSorted, findAllSorted, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findSingleObject, getCountResult, index, refresh, reIndex, remove, replicate, save, saveRaw, setIndexer, unIndex, uniqueResult, updateModificationData

Methods inherited from class org.springframework.orm.hibernate.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

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.pages.persistence.dao.DraftDao

findAll

Constructor Detail

HibernateDraftDao

public HibernateDraftDao()

Method Detail

getPersistentClass

public java.lang.Class getPersistentClass()

Specified by:

getPersistentClass in interface ObjectDao

getByClassId

protected Draft getByClassId(long id)

Overrides:

getByClassId in class HibernateObjectDao

saveOrUpdate

public void saveOrUpdate(Draft draft)
                  throws java.lang.IllegalArgumentException

Description copied from interface: DraftDao

Saves the draft.

Specified by:

saveOrUpdate in interface DraftDao

Throws:

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

getDraft

public Draft getDraft(java.lang.String pageId,
             ConfluenceUser creator,
             java.lang.String draftType,
             java.lang.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

@Deprecated
public Draft getDraft(java.lang.String pageId,
                        java.lang.String creatorName,
                        java.lang.String draftType,
                        java.lang.String spaceKey)

Deprecated.

Specified by:

getDraft in interface DraftDao

getDraft

@Deprecated
public Draft getDraft(java.lang.Long pageId,
                        java.lang.String creatorName,
                        java.lang.String draftType,
                        java.lang.String spaceKey)

Deprecated.

Specified by:

getDraft in interface DraftDao

getAllDraftsForSpace

public java.util.List<Draft> getAllDraftsForSpace(java.lang.String spaceKey)

Specified by:

getAllDraftsForSpace in interface DraftDao

Returns:

all the drafts in the space identified.

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 interface: DraftDao

Removes a draft based on its page ID, owner and type. Does nothing if such a draft is not found in the data store.

Specified by:

remove in interface DraftDao

See Also:

for a faster way to remove a draft when you know its ID

remove

public void remove(long id)

Description copied from interface: DraftDao

Remove a draft based on its ID. Does nothing if such a draft is not found in the data store.

Specified by:

remove in interface DraftDao

findByCreatorName

public java.util.List<Draft> findByCreatorName(java.lang.String creatorName)

Description copied from interface: DraftDao

Returns the drafts stored against the given username.

Specified by:

findByCreatorName in interface DraftDao

updateSpaceKey

public void updateSpaceKey(java.lang.String newSpaceKey,
                  java.lang.String oldSpaceKey)

Description copied from interface: DraftDao

Changes all drafts with a space key of oldSpaceKey to have newSpaceKey.

Specified by:

updateSpaceKey in interface DraftDao

Parameters:

newSpaceKey - the new space key

oldSpaceKey - the old space key

removeAll

public void removeAll()

Description copied from interface: DraftDao

Removes all drafts in the data store.

Specified by:

removeAll in interface DraftDao

countDrafts

public int countDrafts(java.lang.String creatorName)

Specified by:

countDrafts in interface DraftDao

Returns:

count of number of drafts for this daos owner

setConfluenceUserDao

public void setConfluenceUserDao(ConfluenceUserDao confluenceUserDao)