Package org.exoplatform.wiki.jpa

Class JPADataStorage

java.lang.Object

org.exoplatform.wiki.jpa.JPADataStorage

All Implemented Interfaces:

DataStorage

public class JPADataStorage
extends Object
implements DataStorage

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com 9/8/15

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WIKI_FILES_NAMESPACE_DESCRIPTION
static final String	WIKI_FILES_NAMESPACE_NAME
static final String	WIKI_TYPE_DRAFT

Constructor Summary

Constructors

Constructor	Description
JPADataStorage(WikiDAO wikiDAO, PageDAO pageDAO, PageAttachmentDAO pageAttachmentDAO, DraftPageAttachmentDAO draftPageAttachmentDAO, DraftPageDAO draftPageDAO, PageVersionDAO pageVersionDAO, PageMoveDAO pageMoveDAO, TemplateDAO templateDAO, org.exoplatform.commons.file.services.FileService fileService, org.exoplatform.portal.config.UserACL userACL)

Method Summary

Modifier and Type	Method	Description
void	addAttachmentToPage(Attachment attachment, Page page)
PageVersion	addPageVersion(Page page, String userName)	Creates a new page version
void	addRelatedPage(Page page, Page relatedPage)
void	addWatcherToPage(String username, Page page)
DraftPage	createDraftPageForUser(DraftPage draftPage, String username)	Creates a new draft note
Page	createPage(Wiki wiki, Page parentPage, Page page)
Wiki	createWiki(Wiki wiki)
void	deleteAttachmentOfPage(String attachmentName, Page page)
void	deleteAttachmentsOfDraftPage(DraftPageEntity page)
void	deleteAttachmentsOfDraftPage(DraftPage draftPage)	Delete attachments of target draft page
void	deleteDraftById(String id)	Deletes a draft note by its technical id.
void	deleteDraftByName(String draftPageName)
void	deleteDraftOfPage(Page page)
void	deleteDraftOfPage(Page page, String lang)
void	deleteOrphanDraftPagesByParentPage(long parentPageId)	Remove all children drafts of a parent page without existing target
void	deletePage(String wikiType, String wikiOwner, String pageName)
void	deleteVersionsByNoteIdAndLang(Long noteId, String lang)	Deletes a list of versions of note by language.
void	deleteWatcherOfPage(String username, Page page)
PageEntity	fetchPageEntity(Page page)	Fecth Page Entity from a Page domain object
List<Attachment>	getAttachmentsOfPage(Page page)
List<Attachment>	getAttachmentsOfPage(Page page, boolean loadContent)
List<Page>	getChildrenPageOf(Page page, boolean withDrafts, boolean withChild)	Get children notes and draft notes of page
DraftPage	getDraft(WikiPageParams wikiPageParams)
DraftPage	getDraftOfPageByLang(Page page, String lang)
DraftPage	getDraftPageById(String id)
List<DraftPage>	getDraftsOfPage(Long pageId)
List<DraftPage>	getDraftsOfWiki(String wikiOwner, String wikiType)	Gets draft pages of a given wiki
Page	getExsitedOrNewDraftPageById(String wikiType, String wikiOwner, String pageName, String username)
Page	getHelpSyntaxPage(String syntaxId, boolean fullContent, List<org.exoplatform.container.xml.ValuesParam> syntaxHelpParams, org.exoplatform.container.configuration.ConfigurationManager configurationManager)	Deprecated.
List<PageHistory>	getHistoryOfPage(Page page)
DraftPage	getLatestDraftOfPage(Page targetPage)	Returns latest draft of given page.
DraftPage	getLatestDraftPageByTargetPageAndLang(Long targetPageId, String lang)	Retrieves latest draft of a specific page by target page id and content language
List<String>	getPageAvailableTranslationLanguages(Long pageId)	Retrieves list of available translations languages of a page
Page	getPageById(String id)	Get a wiki page by its unique id
List<PageHistory>	getPageHistoryVersionsByPageIdAndLang(Long pageId, String lang)	Retrieves list of page versions by page id and lang
Page	getPageOfWikiByName(String wikiType, String wikiOwner, String pageName)	Get a wiki page by its unique name in the wiki
List<Page>	getPagesOfWiki(String wikiType, String wikiOwner)	Retrieve the all pages contained in wiki
PageVersion	getPageVersionById(long versionId)	Gets page version by its given id
Page	getParentPageOf(Page page)
List<String>	getPreviousNamesOfPage(Page page)
PageVersion	getPublishedVersionByPageIdAndLang(Long pageId, String lang)	Retrieves the published note page version by its id and content language
Page	getRelatedPage(String wikiType, String wikiOwner, String pageName)
List<Page>	getRelatedPagesOfPage(Page page)
List<PageVersion>	getVersionsOfPage(Page page)
List<String>	getWatchersOfPage(Page page)
Wiki	getWikiByTypeAndOwner(String wikiType, String wikiOwner)
List<PermissionEntry>	getWikiPermission(String wikiType, String wikiOwner)
List<Wiki>	getWikisByType(String wikiType)
boolean	hasAdminPagePermission(String wikiType, String owner, org.exoplatform.services.security.Identity identity)
boolean	hasAdminSpacePermission(String wikiType, String owner, org.exoplatform.services.security.Identity identity)
boolean	hasChildren(long noteId)	Check if the given note page has children or not
boolean	hasDrafts(long noteId)	Check if the given note page has drafts or not
boolean	hasPermissionOnPage(Page page, PermissionType permissionType, org.exoplatform.services.security.Identity identity)	Check if the identity has the given permission type on a page
boolean	hasPermissionOnWiki(Wiki wiki, PermissionType permissionType, org.exoplatform.services.security.Identity identity)	Check if the identity has the given permission type on a wiki
void	movePage(WikiPageParams currentLocationParams, WikiPageParams newLocationParams)
void	removeRelatedPage(Page page, Page relatedPage)
void	renamePage(String wikiType, String wikiOwner, String pageName, String newName, String newTitle)
PageVersion	restoreVersionOfPage(String versionName, Page page)	Restore a note from given version
org.exoplatform.commons.utils.PageList<SearchResult>	search(WikiSearchData wikiSearchData)
List<TemplateSearchResult>	searchTemplate(TemplateSearchData templateSearchData)
DraftPage	updateDraftPageForUser(DraftPage draftPage, String username)	Updates a draft note
Page	updatePage(Page page)
void	updateWikiPermission(String wikiType, String wikiOwner, List<PermissionEntry> permissionEntries)

Methods inherited from class java.lang.Object

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

Field Details

WIKI_TYPE_DRAFT

public static final String WIKI_TYPE_DRAFT

See Also:

• Constant Field Values

WIKI_FILES_NAMESPACE_NAME

public static final String WIKI_FILES_NAMESPACE_NAME

See Also:

• Constant Field Values

WIKI_FILES_NAMESPACE_DESCRIPTION

public static final String WIKI_FILES_NAMESPACE_DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

JPADataStorage

public JPADataStorage(WikiDAO wikiDAO,
 PageDAO pageDAO,
 PageAttachmentDAO pageAttachmentDAO,
 DraftPageAttachmentDAO draftPageAttachmentDAO,
 DraftPageDAO draftPageDAO,
 PageVersionDAO pageVersionDAO,
 PageMoveDAO pageMoveDAO,
 TemplateDAO templateDAO,
 org.exoplatform.commons.file.services.FileService fileService,
 org.exoplatform.portal.config.UserACL userACL)

Method Details

search

public org.exoplatform.commons.utils.PageList<SearchResult> search(WikiSearchData wikiSearchData)

Specified by:

search in interface DataStorage

getWikiByTypeAndOwner

public Wiki getWikiByTypeAndOwner(String wikiType,
 String wikiOwner)
                           throws WikiException

Specified by:

getWikiByTypeAndOwner in interface DataStorage

Throws:

WikiException

getWikisByType

public List<Wiki> getWikisByType(String wikiType)
                          throws WikiException

Specified by:

getWikisByType in interface DataStorage

Throws:

WikiException

createWiki

public Wiki createWiki(Wiki wiki)
                throws WikiException

Specified by:

createWiki in interface DataStorage

Throws:

WikiException

createPage

public Page createPage(Wiki wiki,
 Page parentPage,
 Page page)
                throws WikiException

Specified by:

createPage in interface DataStorage

Throws:

WikiException

getPageOfWikiByName

public Page getPageOfWikiByName(String wikiType,
 String wikiOwner,
 String pageName)
                         throws WikiException

Description copied from interface: DataStorage

Get a wiki page by its unique name in the wiki

Specified by:

getPageOfWikiByName in interface DataStorage

Parameters:

wikiType - The wiki type

wikiOwner - The wiki owner

pageName - The unique name of the page in the wiki

Returns:

The wiki page

Throws:

WikiException - if an error occured

getPageById

public Page getPageById(String id)
                 throws WikiException

Description copied from interface: DataStorage

Get a wiki page by its unique id

Specified by:

getPageById in interface DataStorage

Parameters:

id - The unique id of wiki page

Returns:

The wiki page

Throws:

WikiException - if an error occured

getDraftPageById

public DraftPage getDraftPageById(String id)
                           throws WikiException

Specified by:

getDraftPageById in interface DataStorage

Throws:

WikiException

getParentPageOf

public Page getParentPageOf(Page page)
                     throws WikiException

Specified by:

getParentPageOf in interface DataStorage

Throws:

WikiException

getChildrenPageOf

public List<Page> getChildrenPageOf(Page page,
 boolean withDrafts,
 boolean withChild)
                             throws WikiException

Description copied from interface: DataStorage

Get children notes and draft notes of page

Specified by:

getChildrenPageOf in interface DataStorage

Parameters:

page - the target page to retrieve its children

withDrafts - if set to true returns the children notes and draft notes,

withChild - Check if note has child

Returns:

children notes of page

Throws:

WikiException

hasChildren

public boolean hasChildren(long noteId)

Description copied from interface: DataStorage

Check if the given note page has children or not

Specified by:

hasChildren in interface DataStorage

Parameters:

noteId - note page id

Returns:

true if the given note page has children and false if not

hasDrafts

public boolean hasDrafts(long noteId)

Description copied from interface: DataStorage

Check if the given note page has drafts or not

Specified by:

hasDrafts in interface DataStorage

Parameters:

noteId - note page id

Returns:

true if the given note page has drafts and false if not

deletePage

public void deletePage(String wikiType,
 String wikiOwner,
 String pageName)
                throws WikiException

Specified by:

deletePage in interface DataStorage

Throws:

WikiException

deleteDraftOfPage

public void deleteDraftOfPage(Page page)
                       throws WikiException

Specified by:

deleteDraftOfPage in interface DataStorage

Throws:

WikiException

deleteAttachmentsOfDraftPage

public void deleteAttachmentsOfDraftPage(DraftPage draftPage)

Description copied from interface: DataStorage

Delete attachments of target draft page

Specified by:

deleteAttachmentsOfDraftPage in interface DataStorage

Parameters:

draftPage - target draft page

deleteDraftOfPage

public void deleteDraftOfPage(Page page,
 String lang)
                       throws WikiException

Specified by:

deleteDraftOfPage in interface DataStorage

Throws:

WikiException

deleteDraftByName

public void deleteDraftByName(String draftPageName)
                       throws WikiException

Specified by:

deleteDraftByName in interface DataStorage

Throws:

WikiException

deleteDraftById

public void deleteDraftById(String id)
                     throws WikiException

Description copied from interface: DataStorage

Deletes a draft note by its technical id.

Specified by:

deleteDraftById in interface DataStorage

Parameters:

id - Id of the draft note.

Throws:

WikiException - if an error occured

renamePage

public void renamePage(String wikiType,
 String wikiOwner,
 String pageName,
 String newName,
 String newTitle)
                throws WikiException

Specified by:

renamePage in interface DataStorage

Throws:

WikiException

movePage

public void movePage(WikiPageParams currentLocationParams,
 WikiPageParams newLocationParams)
              throws WikiException

Specified by:

movePage in interface DataStorage

Throws:

WikiException

getWikiPermission

public List<PermissionEntry> getWikiPermission(String wikiType,
 String wikiOwner)
                                        throws WikiException

Specified by:

getWikiPermission in interface DataStorage

Throws:

WikiException

updateWikiPermission

public void updateWikiPermission(String wikiType,
 String wikiOwner,
 List<PermissionEntry> permissionEntries)
                          throws WikiException

Specified by:

updateWikiPermission in interface DataStorage

Throws:

WikiException

getRelatedPagesOfPage

public List<Page> getRelatedPagesOfPage(Page page)
                                 throws WikiException

Specified by:

getRelatedPagesOfPage in interface DataStorage

Throws:

WikiException

getRelatedPage

public Page getRelatedPage(String wikiType,
 String wikiOwner,
 String pageName)
                    throws WikiException

Specified by:

getRelatedPage in interface DataStorage

Throws:

WikiException

addRelatedPage

public void addRelatedPage(Page page,
 Page relatedPage)
                    throws WikiException

Specified by:

addRelatedPage in interface DataStorage

Throws:

WikiException

getPagesOfWiki

public List<Page> getPagesOfWiki(String wikiType,
 String wikiOwner)

Description copied from interface: DataStorage

Retrieve the all pages contained in wiki

Specified by:

getPagesOfWiki in interface DataStorage

Parameters:

wikiType - the wiki type

wikiOwner - the wiki owner

Returns:

the List pf pages of the wiki

removeRelatedPage

public void removeRelatedPage(Page page,
 Page relatedPage)
                       throws WikiException

Specified by:

removeRelatedPage in interface DataStorage

Throws:

WikiException

getExsitedOrNewDraftPageById

public Page getExsitedOrNewDraftPageById(String wikiType,
 String wikiOwner,
 String pageName,
 String username)
                                  throws WikiException

Specified by:

getExsitedOrNewDraftPageById in interface DataStorage

Throws:

WikiException

getDraftOfPageByLang

public DraftPage getDraftOfPageByLang(Page page,
 String lang)
                               throws WikiException

Specified by:

getDraftOfPageByLang in interface DataStorage

Throws:

WikiException

getDraftsOfPage

public List<DraftPage> getDraftsOfPage(Long pageId)

Specified by:

getDraftsOfPage in interface DataStorage

getDraft

public DraftPage getDraft(WikiPageParams wikiPageParams)
                   throws WikiException

Specified by:

getDraft in interface DataStorage

Throws:

WikiException

getLatestDraftOfPage

public DraftPage getLatestDraftOfPage(Page targetPage)

Description copied from interface: DataStorage

Returns latest draft of given page.

Specified by:

getLatestDraftOfPage in interface DataStorage

Parameters:

targetPage -

Returns:

latest draft of the given target page

createDraftPageForUser

public DraftPage createDraftPageForUser(DraftPage draftPage,
 String username)
                                 throws WikiException

Description copied from interface: DataStorage

Creates a new draft note

Specified by:

createDraftPageForUser in interface DataStorage

Parameters:

draftPage - The draft note to be created

username - Author name

Returns:

Created draft note

Throws:

WikiException

updateDraftPageForUser

public DraftPage updateDraftPageForUser(DraftPage draftPage,
 String username)
                                 throws WikiException

Description copied from interface: DataStorage

Updates a draft note

Specified by:

updateDraftPageForUser in interface DataStorage

Parameters:

draftPage - The draft note to be updated

username -

Returns:

Updated draft note

Throws:

WikiException

searchTemplate

public List<TemplateSearchResult> searchTemplate(TemplateSearchData templateSearchData)
                                          throws WikiException

Specified by:

searchTemplate in interface DataStorage

Throws:

WikiException

getAttachmentsOfPage

public List<Attachment> getAttachmentsOfPage(Page page)
                                      throws WikiException

Specified by:

getAttachmentsOfPage in interface DataStorage

Throws:

WikiException

getAttachmentsOfPage

public List<Attachment> getAttachmentsOfPage(Page page,
 boolean loadContent)
                                      throws WikiException

Specified by:

getAttachmentsOfPage in interface DataStorage

Throws:

WikiException

addAttachmentToPage

public void addAttachmentToPage(Attachment attachment,
 Page page)
                         throws WikiException

Specified by:

addAttachmentToPage in interface DataStorage

Throws:

WikiException

deleteAttachmentOfPage

public void deleteAttachmentOfPage(String attachmentName,
 Page page)
                            throws WikiException

Specified by:

deleteAttachmentOfPage in interface DataStorage

Throws:

WikiException

getHelpSyntaxPage

@Deprecated
public Page getHelpSyntaxPage(String syntaxId,
 boolean fullContent,
 List<org.exoplatform.container.xml.ValuesParam> syntaxHelpParams,
 org.exoplatform.container.configuration.ConfigurationManager configurationManager)
                       throws WikiException

Deprecated.

Specified by:

getHelpSyntaxPage in interface DataStorage

Throws:

WikiException

hasPermissionOnPage

public boolean hasPermissionOnPage(Page page,
 PermissionType permissionType,
 org.exoplatform.services.security.Identity identity)
                            throws WikiException

Description copied from interface: DataStorage

Check if the identity has the given permission type on a page

Specified by:

hasPermissionOnPage in interface DataStorage

Parameters:

page - Page

permissionType - Permission type to check

identity - Identity of the user

Returns:

true if the user has the given permission type on the page

Throws:

WikiException - if an error occured

hasPermissionOnWiki

public boolean hasPermissionOnWiki(Wiki wiki,
 PermissionType permissionType,
 org.exoplatform.services.security.Identity identity)
                            throws WikiException

Description copied from interface: DataStorage

Check if the identity has the given permission type on a wiki

Specified by:

hasPermissionOnWiki in interface DataStorage

Parameters:

wiki - Wiki

permissionType - Permission type to check

identity - Identity of the user

Returns:

true if the user has the given permission type on the wiki

Throws:

WikiException - if an error occured

hasAdminSpacePermission

public boolean hasAdminSpacePermission(String wikiType,
 String owner,
 org.exoplatform.services.security.Identity identity)
                                throws WikiException

Specified by:

hasAdminSpacePermission in interface DataStorage

Throws:

WikiException

hasAdminPagePermission

public boolean hasAdminPagePermission(String wikiType,
 String owner,
 org.exoplatform.services.security.Identity identity)
                               throws WikiException

Specified by:

hasAdminPagePermission in interface DataStorage

Throws:

WikiException

getVersionsOfPage

public List<PageVersion> getVersionsOfPage(Page page)
                                    throws WikiException

Specified by:

getVersionsOfPage in interface DataStorage

Throws:

WikiException

getHistoryOfPage

public List<PageHistory> getHistoryOfPage(Page page)
                                   throws WikiException

Specified by:

getHistoryOfPage in interface DataStorage

Throws:

WikiException

addPageVersion

public PageVersion addPageVersion(Page page,
 String userName)
                           throws WikiException

Description copied from interface: DataStorage

Creates a new page version

Specified by:

addPageVersion in interface DataStorage

Parameters:

page - target note page

userName - current username

Returns:

PageVersion

Throws:

WikiException

restoreVersionOfPage

public PageVersion restoreVersionOfPage(String versionName,
 Page page)
                                 throws WikiException

Description copied from interface: DataStorage

Restore a note from given version

Specified by:

restoreVersionOfPage in interface DataStorage

Parameters:

versionName - version name

page - target note page

Returns:

PageVersion

Throws:

WikiException

updatePage

public Page updatePage(Page page)
                throws WikiException

Specified by:

updatePage in interface DataStorage

Throws:

WikiException

getPreviousNamesOfPage

public List<String> getPreviousNamesOfPage(Page page)
                                    throws WikiException

Specified by:

getPreviousNamesOfPage in interface DataStorage

Throws:

WikiException

getWatchersOfPage

public List<String> getWatchersOfPage(Page page)
                               throws WikiException

Specified by:

getWatchersOfPage in interface DataStorage

Throws:

WikiException

addWatcherToPage

public void addWatcherToPage(String username,
 Page page)
                      throws WikiException

Specified by:

addWatcherToPage in interface DataStorage

Throws:

WikiException

deleteWatcherOfPage

public void deleteWatcherOfPage(String username,
 Page page)
                         throws WikiException

Specified by:

deleteWatcherOfPage in interface DataStorage

Throws:

WikiException

deleteAttachmentsOfDraftPage

public void deleteAttachmentsOfDraftPage(DraftPageEntity page)

fetchPageEntity

public PageEntity fetchPageEntity(Page page)

Fecth Page Entity from a Page domain object

Parameters:

page - The page domain object

Returns:

The page entity

getPageHistoryVersionsByPageIdAndLang

public List<PageHistory> getPageHistoryVersionsByPageIdAndLang(Long pageId,
 String lang)

Retrieves list of page versions by page id and lang

Specified by:

getPageHistoryVersionsByPageIdAndLang in interface DataStorage

Parameters:

pageId - page id

lang - content language

Returns:

List of PageHistory

getLatestDraftPageByTargetPageAndLang

public DraftPage getLatestDraftPageByTargetPageAndLang(Long targetPageId,
 String lang)

Retrieves latest draft of a specific page by target page id and content language

Specified by:

getLatestDraftPageByTargetPageAndLang in interface DataStorage

Parameters:

targetPageId - target page id

lang - content language

Returns:

DraftPage

getPublishedVersionByPageIdAndLang

public PageVersion getPublishedVersionByPageIdAndLang(Long pageId,
 String lang)

Retrieves the published note page version by its id and content language

Specified by:

getPublishedVersionByPageIdAndLang in interface DataStorage

Parameters:

pageId - page id

lang - content language

Returns:

PageVersion

getPageAvailableTranslationLanguages

public List<String> getPageAvailableTranslationLanguages(Long pageId)

Retrieves list of available translations languages of a page

Specified by:

getPageAvailableTranslationLanguages in interface DataStorage

Parameters:

pageId - page id

Returns:

List of String

deleteVersionsByNoteIdAndLang

public void deleteVersionsByNoteIdAndLang(Long noteId,
 String lang)
                                   throws WikiException

Deletes a list of versions of note by language.

Specified by:

deleteVersionsByNoteIdAndLang in interface DataStorage

Parameters:

noteId - Id of the note.

lang - language.

Throws:

WikiException - if an error occured

deleteOrphanDraftPagesByParentPage

public void deleteOrphanDraftPagesByParentPage(long parentPageId)

Remove all children drafts of a parent page without existing target

Specified by:

deleteOrphanDraftPagesByParentPage in interface DataStorage

Parameters:

parentPageId - Note parent page id

getPageVersionById

public PageVersion getPageVersionById(long versionId)

Gets page version by its given id

Specified by:

getPageVersionById in interface DataStorage

Parameters:

versionId - page version id

Returns:

PageVersion

getDraftsOfWiki

public List<DraftPage> getDraftsOfWiki(String wikiOwner,
 String wikiType)

Gets draft pages of a given wiki

Specified by:

getDraftsOfWiki in interface DataStorage

Parameters:

wikiOwner - wiki owner

wikiType - wiki type

Returns:

List of DraftPage