org.exoplatform.wiki.service.impl

Class WikiServiceImpl

java.lang.Object

org.exoplatform.wiki.service.impl.WikiServiceImpl

All Implemented Interfaces:

WikiService, org.picocontainer.Startable

public class WikiServiceImpl
extends Object
implements WikiService, org.picocontainer.Startable

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_CACHE_NAME
static String	CACHE_NAME
static String	UPLOAD_LIMIT_PARAMETER_NAME
static String	WIKI_TYPE_DRAFT

Constructor Summary

Constructors

Constructor and Description

WikiServiceImpl(org.exoplatform.container.configuration.ConfigurationManager configManager, org.exoplatform.portal.config.UserACL userACL, DataStorage dataStorage, org.exoplatform.wiki.rendering.RenderingService renderingService, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.services.organization.OrganizationService orgService, org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method and Description
void	addAttachment(Attachment attachment, Page page)
void	addAttachmentToPage(Attachment attachment, Page page) Add the given attachment to the given page
void	addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Configuration
void	addEmotionIconsPlugin(WikiEmotionIconsPlugin plugin) Adds a Wiki emotion icons as plugin.
void	addPageLink(WikiPageParams param, WikiPageParams entity) Add a link between 2 pages
void	addRelatedPage(WikiPageParams orginaryPageParams, WikiPageParams relatedPageParams) Adds a related page to the current wiki page.
void	addUnCachedMacro(UnCachedMacroPlugin plugin) Uncache page rendering for pages containing a chosen macro
void	addWatcherToPage(String username, Page page) Add the given user as watcher of the wiki page
void	addWikiTemplatePagePlugin(WikiTemplatePagePlugin plugin) Adds a Wiki template as plugin.
boolean	canModifyPagePermission(Page currentPage, String currentUser) Check if the given user can update the page
boolean	canPublicAndRetrictPage(Page currentPage, String currentUser) Check if the given user can public or restrict the page
DraftPage	createDraftForExistPage(DraftPage draftPage, Page targetPage, String revision, long clientTime) Creates a draft page for a wiki page which is specified by a given param object.
DraftPage	createDraftForNewPage(DraftPage draftPage, Page parentPage, long clientTime) Creates a draft page for a new wiki page whose parent is specified by a given param object.
void	createEmotionIcon(EmotionIcon emotionIcon) Creates a emotion icon
Page	createPage(Wiki wiki, String parentPageName, Page page) Page
void	createTemplatePage(Wiki wiki, Template template) Template
void	createVersionOfPage(Page page) Creates a version of a page.
Wiki	createWiki(String wikiType, String owner) Creates a wiki with the given type and owner
void	deleteAttachment(String attachmentId, Page page)
void	deleteAttachmentOfPage(String attachmentId, Page page) Deletes the given attachment of the given page
boolean	deletePage(String wikiType, String wikiOwner, String pageName) Deletes a wiki page.
void	deleteTemplatePage(String wikiType, String wikiOwner, String templateName) Deletes a Wiki template.
void	deleteWatcherOfPage(String username, Page page) Delete a user as watcher of the given page
List<AttachmentWikiListener>	getAttachmentListeners() Gets attachment listeners that are registered into the Wiki service.
Attachment	getAttachmentOfPageByName(String attachmentName, Page page) Get a attachment of a the given page by name, without loading its content
Attachment	getAttachmentOfPageByName(String attachmentName, Page page, boolean loadContent) Get a attachment of a the given page by name, and allow to load the attachment content by setting loadContent to true
List<Attachment>	getAttachmentsOfPage(Page page) Attachment
List<Attachment>	getAttachmentsOfPage(Page page, boolean loadContent) Gets attachments of the given page, and allow to load their attachment content by setting loadContent to true
List<BreadcrumbData>	getBreadcumb(String wikiType, String wikiOwner, String pageId) Gets a list of data which is used for composing the breadcrumb.
List<Page>	getChildrenPageOf(Page page) Get all the children pages of a wiki page
String	getDefaultWikiSyntaxId() Gets Id of a default Wiki syntax.
DraftPage	getDraft(String draftName) Gets a draft page by its name.
org.exoplatform.commons.diff.DiffResult	getDraftChanges(DraftPage draftPage) Gets the changes between the draft page and the target page
DraftPage	getDraftOfPage(Page page) Gets a draft page of a wiki page which is specified by a given param object.
DraftPage	getDraftPageById(String id) Gets a wiki draft page based on its unique id.
List<DraftPage>	getDraftsOfUser(String username) Gets a list of draft pages belonging to a given user.
List<Page>	getDuplicatePages(Page parentPage, Wiki targetWiki, List<Page> resultList) Checks if a page and its children are duplicated with ones in the target Wiki or not, then gets a list of duplicated pages if any.
long	getEditPageLivingTime() Get the living time of edited page
EmotionIcon	getEmotionIconByName(String name) Gets an emotion icon by name
List<EmotionIcon>	getEmotionIcons() Gets all the emotion icons
Page	getExsitedOrNewDraftPageById(String wikiType, String wikiOwner, String pageId) Draft
Page	getHelpSyntaxPage(String syntaxId, boolean fullContent) Gets a Help wiki page based on a given syntax Id.
DraftPage	getLastestDraft() Gets the last created draft of a wiki page.
int	getNbOfAttachmentsOfPage(Page page) Get the number of attachment of the given page
Wiki	getOrCreateUserWiki(String username) Gets a user Wiki.
Page	getPageById(String id) Gets a wiki page based on its unique id.
Page	getPageByRootPermission(String wikiType, String wikiOwner, String pageId) Gets a wiki page regardless of the current user's permission.
Map<WikiPageParams,List<WikiPageParams>>	getPageLinksMap()
List<PageWikiListener>	getPageListeners() Gets listeners of all wiki pages that are registered into the Wiki service.
Page	getPageOfWikiByName(String wikiType, String wikiOwner, String pageName) Gets a wiki page by its unique name in the wiki.
String	getPageRenderedContent(Page page, String targetSyntax) Get renderd content of a page
List<Page>	getPagesOfWiki(String wikiType, String wikiOwner) Retrieve the all pages contained in wiki
Page	getParentPageOf(Page page) Get parent page of a wiki page
List<String>	getPreviousNamesOfPage(Page page) Get previous names of a page
Page	getRelatedPage(String wikiType, String wikiOwner, String pageId) Gets a related page of a wiki page which is specified by a given Id.
List<Page>	getRelatedPagesOfPage(Page page) Gets a list of related pages based on a given param.
org.exoplatform.services.cache.ExoCache<Integer,MarkupData>	getRenderingCache()
long	getSaveDraftSequenceTime() Gets an interval which specifies the periodical auto-saving for pages in Wiki.
String	getSpaceNameByGroupId(String groupId) Gets a space name by a given group Id.
Template	getTemplatePage(WikiPageParams params, String templateId) Gets a Wiki template.
Map<String,Template>	getTemplates(WikiPageParams params) Gets a map of wiki templates based on a given params object.
Set<String>	getUncachedMacroes()
int	getUploadLimit()
PageVersion	getVersionOfPageByName(String versionName, Page page) Gets a specific version by name of the given page
List<PageVersion>	getVersionsOfPage(Page page) Gets all the versions of the given page
List<String>	getWatchersOfPage(Page page) Watch
Wiki	getWikiById(String wikiId) Gets a Wiki by its Id.
Wiki	getWikiByTypeAndOwner(String wikiType, String owner) Wiki
List<PermissionEntry>	getWikiDefaultPermissions(String wikiType, String wikiOwner) Gets a list of Wiki default permissions.
String	getWikiNameById(String wikiId) Gets a Wiki name by its Id.
WikiPageParams	getWikiPageParams(BreadcrumbData data) Gets parameters of a wiki page based on the data stored in the breadcrumb.
List<PermissionEntry>	getWikiPermission(String wikiType, String wikiOwner) Gets a list of Wiki permissions based on its type and owner.
List<Wiki>	getWikisByType(String wikiType) Gets all wikis of the given type
String	getWikiWebappUri() Gets a Wiki webapp URI.
boolean	hasAdminPagePermission(String wikiType, String owner) Checks if the current user has the admin permission on a wiki page.
boolean	hasAdminSpacePermission(String wikiType, String owner) Checks if the current user has the admin permission on a space or not.
boolean	hasPermissionOnPage(Page page, PermissionType permissionType, org.exoplatform.services.security.Identity user) Checks if the given user has the permission on a page
boolean	hasPermissionOnWiki(Wiki wiki, PermissionType permissionType, org.exoplatform.services.security.Identity user) Check if the identity has the given permission type on a wiki
protected void	invalidateAttachmentCache(Page page)
protected void	invalidateCache(Page page)
protected void	invalidateCachesOfPageTree(Page page) Invalidate all caches of a page and all its descendants
boolean	isDraftOutDated(DraftPage draftPage) Check if a draft page is outdated
boolean	isExisting(String wikiType, String wikiOwner, String pageId) Checks if a wiki page exists or not.
boolean	movePage(WikiPageParams currentLocationParams, WikiPageParams newLocationParams) Move a wiki Page
void	postAddPage(String wikiType, String wikiOwner, String pageId, Page page)
void	postDeletePage(String wikiType, String wikiOwner, String pageId, Page page)
void	postUpdatePage(String wikiType, String wikiOwner, String pageId, Page page, PageUpdateType wikiUpdateType) Listeners
void	removeDraft(String draftName) Removes a draft page by its name.
void	removeDraftOfPage(WikiPageParams param) Removes a draft page of a wiki page which is specified by the wiki page param.
void	removeRelatedPage(WikiPageParams orginaryPageParams, WikiPageParams relatedPageParams) Removes a related page of the current wiki page.
boolean	renamePage(String wikiType, String wikiOwner, String pageName, String newName, String newTitle) Renames a wiki page.
void	restoreVersionOfPage(String versionName, Page page) Restores a version of a page
org.exoplatform.commons.utils.PageList<SearchResult>	search(WikiSearchData data) Searches in all wiki pages.
List<SpaceBean>	searchSpaces(String keyword) Spaces
List<TemplateSearchResult>	searchTemplate(TemplateSearchData data) Searches in all templates.
void	start()
void	stop()
void	updatePage(Page page, PageUpdateType updateType) Update the given page.
void	updateTemplate(Template template) Modifies an existing wiki template.
void	updateWikiPermission(String wikiType, String wikiOwner, List<PermissionEntry> permissionEntries) Adds a list of permissions to Wiki.

Methods inherited from class java.lang.Object

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

Field Detail

WIKI_TYPE_DRAFT

public static final String WIKI_TYPE_DRAFT

See Also:

Constant Field Values

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

ATT_CACHE_NAME

public static final String ATT_CACHE_NAME

See Also:

Constant Field Values

UPLOAD_LIMIT_PARAMETER_NAME

public static String UPLOAD_LIMIT_PARAMETER_NAME

Constructor Detail

WikiServiceImpl

public WikiServiceImpl(org.exoplatform.container.configuration.ConfigurationManager configManager,
                       org.exoplatform.portal.config.UserACL userACL,
                       DataStorage dataStorage,
                       org.exoplatform.wiki.rendering.RenderingService renderingService,
                       org.exoplatform.services.cache.CacheService cacheService,
                       org.exoplatform.services.organization.OrganizationService orgService,
                       org.exoplatform.container.xml.InitParams initParams)

Method Detail

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

getRenderingCache

public org.exoplatform.services.cache.ExoCache<Integer,MarkupData> getRenderingCache()

getPageLinksMap

public Map<WikiPageParams,List<WikiPageParams>> getPageLinksMap()

addComponentPlugin

public void addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Configuration

Specified by:

addComponentPlugin in interface WikiService

Parameters:

plugin - The component plugin to be registered.

addWikiTemplatePagePlugin

public void addWikiTemplatePagePlugin(WikiTemplatePagePlugin plugin)

Description copied from interface: WikiService

Adds a Wiki template as plugin.

Specified by:

addWikiTemplatePagePlugin in interface WikiService

Parameters:

plugin - The wiki template plugin to be added.

addEmotionIconsPlugin

public void addEmotionIconsPlugin(WikiEmotionIconsPlugin plugin)

Description copied from interface: WikiService

Adds a Wiki emotion icons as plugin.

Specified by:

addEmotionIconsPlugin in interface WikiService

Parameters:

plugin - The wiki emotion icons plugin to be added.

getPageListeners

public List<PageWikiListener> getPageListeners()

Description copied from interface: WikiService

Gets listeners of all wiki pages that are registered into the Wiki service.

Specified by:

getPageListeners in interface WikiService

Returns:

The list of listeners.

getAttachmentListeners

public List<AttachmentWikiListener> getAttachmentListeners()

Description copied from interface: WikiService

Gets attachment listeners that are registered into the Wiki service.

Specified by:

getAttachmentListeners in interface WikiService

Returns:

The list of attachment listeners.

getWikiWebappUri

public String getWikiWebappUri()

Description copied from interface: WikiService

Gets a Wiki webapp URI.

Specified by:

getWikiWebappUri in interface WikiService

Returns:

The Wiki webapp URI.

getDefaultWikiSyntaxId

public String getDefaultWikiSyntaxId()

Description copied from interface: WikiService

Gets Id of a default Wiki syntax.

Specified by:

getDefaultWikiSyntaxId in interface WikiService

Returns:

The Id.

getSaveDraftSequenceTime

public long getSaveDraftSequenceTime()

Description copied from interface: WikiService

Gets an interval which specifies the periodical auto-saving for pages in Wiki.

Specified by:

getSaveDraftSequenceTime in interface WikiService

Returns:

The interval. Its default value is 30 seconds.

getEditPageLivingTime

public long getEditPageLivingTime()

Description copied from interface: WikiService

Get the living time of edited page

Specified by:

getEditPageLivingTime in interface WikiService

Returns:

The living time of edited page

getWikiByTypeAndOwner

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

Wiki

Specified by:

getWikiByTypeAndOwner in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

owner - The Wiki owner.

Returns:

The Wiki.

Throws:

WikiException

getWikisByType

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

Description copied from interface: WikiService

Gets all wikis of the given type

Specified by:

getWikisByType in interface WikiService

Parameters:

wikiType - Type of wiki

Returns:

Wikis of the given type

Throws:

WikiException

getOrCreateUserWiki

public Wiki getOrCreateUserWiki(String username)
                         throws WikiException

Description copied from interface: WikiService

Gets a user Wiki. If it does not exist, the new one will be created.

Specified by:

getOrCreateUserWiki in interface WikiService

Parameters:

username - Name of the user.

Returns:

The user Wiki.

Throws:

WikiException

getWikiPermission

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

Description copied from interface: WikiService

Gets a list of Wiki permissions based on its type and owner.

Specified by:

getWikiPermission in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

Returns:

The list of Wiki permissions.

Throws:

WikiException

updateWikiPermission

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

Description copied from interface: WikiService

Adds a list of permissions to Wiki.

Specified by:

updateWikiPermission in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

permissionEntries - The list of permissions.

Throws:

WikiException

getWikiDefaultPermissions

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

Description copied from interface: WikiService

Gets a list of Wiki default permissions.

Specified by:

getWikiDefaultPermissions in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

Returns:

The list of Wiki default permissions.

Throws:

WikiException

getWikiById

public Wiki getWikiById(String wikiId)
                 throws WikiException

Description copied from interface: WikiService

Gets a Wiki by its Id.

Specified by:

getWikiById in interface WikiService

Parameters:

wikiId - The Wiki Id.

Returns:

The Wiki.

Throws:

WikiException

getWikiNameById

public String getWikiNameById(String wikiId)
                       throws WikiException

Description copied from interface: WikiService

Gets a Wiki name by its Id.

Specified by:

getWikiNameById in interface WikiService

Parameters:

wikiId - The Wiki Id.

Returns:

The Wiki name.

Throws:

WikiException

createWiki

public Wiki createWiki(String wikiType,
                       String owner)
                throws WikiException

Description copied from interface: WikiService

Creates a wiki with the given type and owner

Specified by:

createWiki in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

owner - The Wiki owner.

Throws:

WikiException

createPage

public Page createPage(Wiki wiki,
                       String parentPageName,
                       Page page)
                throws WikiException

Page

Specified by:

createPage in interface WikiService

Parameters:

wiki - It can be Portal, Group, or User.

parentPageName - Name of the parent wiki page.

Returns:

The new wiki page.

Throws:

WikiException

getPageOfWikiByName

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

Description copied from interface: WikiService

Gets a wiki page by its unique name in the wiki.

Specified by:

getPageOfWikiByName in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageName - Id of the wiki page.

Returns:

The wiki page if the current user has the read permission. Otherwise, it is "null".

Throws:

WikiException

addUnCachedMacro

public void addUnCachedMacro(UnCachedMacroPlugin plugin)

Description copied from interface: WikiService

Uncache page rendering for pages containing a chosen macro

Specified by:

addUnCachedMacro in interface WikiService

getPageById

public Page getPageById(String id)
                 throws WikiException

Description copied from interface: WikiService

Gets a wiki page based on its unique id.

Specified by:

getPageById in interface WikiService

Parameters:

id - Unique id of the wiki page.

Returns:

The wiki page.

Throws:

WikiException

getDraftPageById

public DraftPage getDraftPageById(String id)
                           throws WikiException

Description copied from interface: WikiService

Gets a wiki draft page based on its unique id.

Specified by:

getDraftPageById in interface WikiService

Parameters:

id - Unique id of the wiki page.

Returns:

The wiki draft page.

Throws:

WikiException

getPageByRootPermission

public Page getPageByRootPermission(String wikiType,
                                    String wikiOwner,
                                    String pageId)
                             throws WikiException

Description copied from interface: WikiService

Gets a wiki page regardless of the current user's permission.

Specified by:

getPageByRootPermission in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The wiki page.

Throws:

WikiException

getParentPageOf

public Page getParentPageOf(Page page)
                     throws WikiException

Description copied from interface: WikiService

Get parent page of a wiki page

Specified by:

getParentPageOf in interface WikiService

Parameters:

page - Wiki page.

Returns:

The list of children pages

Throws:

WikiException

getChildrenPageOf

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

Description copied from interface: WikiService

Get all the children pages of a wiki page

Specified by:

getChildrenPageOf in interface WikiService

Parameters:

page - Wiki page.

Returns:

The list of children pages

Throws:

WikiException

deletePage

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

Description copied from interface: WikiService

Deletes a wiki page.

Specified by:

deletePage in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageName - Id of the wiki page.

Returns:

"True" if deleting the wiki page is successful, or "false" if not.

Throws:

WikiException

renamePage

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

Description copied from interface: WikiService

Renames a wiki page.

Specified by:

renamePage in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageName - Old name of the wiki page.

newName - New name of the wiki page.

newTitle - New title of the wiki page.

Returns:

"True" if renaming the wiki page is successful, or "false" if not.

Throws:

WikiException

movePage

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

Description copied from interface: WikiService

Move a wiki Page

Specified by:

movePage in interface WikiService

Parameters:

currentLocationParams - The current location of the wiki page.

newLocationParams - The new location of the wiki page.

Returns:

"True" if moving the wiki page is successful, or "false" if not.

Throws:

WikiException

getPageRenderedContent

public String getPageRenderedContent(Page page,
                                     String targetSyntax)

Description copied from interface: WikiService

Get renderd content of a page

Specified by:

getPageRenderedContent in interface WikiService

Parameters:

page - The wiki page

targetSyntax - The syntax

Returns:

The rendered content

addPageLink

public void addPageLink(WikiPageParams param,
                        WikiPageParams entity)

Description copied from interface: WikiService

Add a link between 2 pages

Specified by:

addPageLink in interface WikiService

Parameters:

param - First page

entity - Second page

getUncachedMacroes

public Set<String> getUncachedMacroes()

invalidateCache

protected void invalidateCache(Page page)

invalidateAttachmentCache

protected void invalidateAttachmentCache(Page page)

invalidateCachesOfPageTree

protected void invalidateCachesOfPageTree(Page page)
                                   throws WikiException

Invalidate all caches of a page and all its descendants

Parameters:

page - root page

Throws:

WikiException

getRelatedPage

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

Description copied from interface: WikiService

Gets a related page of a wiki page which is specified by a given Id.

Specified by:

getRelatedPage in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The related wiki page.

Throws:

WikiException

isExisting

public boolean isExisting(String wikiType,
                          String wikiOwner,
                          String pageId)
                   throws WikiException

Description copied from interface: WikiService

Checks if a wiki page exists or not.

Specified by:

isExisting in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The returned value is "true" if the page exists, or "false" if not.

Throws:

WikiException

search

public org.exoplatform.commons.utils.PageList<SearchResult> search(WikiSearchData data)
                                                            throws WikiException

Description copied from interface: WikiService

Searches in all wiki pages.

Specified by:

search in interface WikiService

Parameters:

data - The data to search.

Returns:

Search results.

Throws:

WikiException

getHelpSyntaxPage

public Page getHelpSyntaxPage(String syntaxId,
                              boolean fullContent)
                       throws WikiException

Description copied from interface: WikiService

Gets a Help wiki page based on a given syntax Id.

Specified by:

getHelpSyntaxPage in interface WikiService

Parameters:

syntaxId - Id of the syntax.

fullContent - true to get the full help page content, false to get an excerpt

Returns:

The Help wiki page.

Throws:

WikiException

getEmotionIcons

public List<EmotionIcon> getEmotionIcons()
                                  throws WikiException

Description copied from interface: WikiService

Gets all the emotion icons

Specified by:

getEmotionIcons in interface WikiService

Returns:

All the emotion icons

Throws:

WikiException

getEmotionIconByName

public EmotionIcon getEmotionIconByName(String name)
                                 throws WikiException

Description copied from interface: WikiService

Gets an emotion icon by name

Specified by:

getEmotionIconByName in interface WikiService

Parameters:

name - The name of the emotion icon

Returns:

The emotion icon

Throws:

WikiException

getDuplicatePages

public List<Page> getDuplicatePages(Page parentPage,
                                    Wiki targetWiki,
                                    List<Page> resultList)
                             throws WikiException

Description copied from interface: WikiService

Checks if a page and its children are duplicated with ones in the target Wiki or not, then gets a list of duplicated pages if any.

Specified by:

getDuplicatePages in interface WikiService

Parameters:

parentPage - The page to check.

targetWiki - The target Wiki to check.

resultList - The list of duplicated wiki pages.

Returns:

The list of duplicated wiki pages.

Throws:

WikiException

hasPermissionOnWiki

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

Description copied from interface: WikiService

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

Specified by:

hasPermissionOnWiki in interface WikiService

Parameters:

wiki - Wiki

permissionType - Permission type to check

user - Identity of the user

Returns:

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

Throws:

WikiException

hasPermissionOnPage

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

Description copied from interface: WikiService

Checks if the given user has the permission on a page

Specified by:

hasPermissionOnPage in interface WikiService

Returns:

Throws:

WikiException

canModifyPagePermission

public boolean canModifyPagePermission(Page currentPage,
                                       String currentUser)
                                throws WikiException

Description copied from interface: WikiService

Check if the given user can update the page

Specified by:

canModifyPagePermission in interface WikiService

Parameters:

currentPage - The page to update

currentUser - The user that needs to update the page

Returns:

true if the user can update the page

Throws:

WikiException

canPublicAndRetrictPage

public boolean canPublicAndRetrictPage(Page currentPage,
                                       String currentUser)
                                throws WikiException

Description copied from interface: WikiService

Check if the given user can public or restrict the page

Specified by:

canPublicAndRetrictPage in interface WikiService

Returns:

true if the current user has EditPage permission or admin page or admin space

Throws:

WikiException

getVersionsOfPage

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

Description copied from interface: WikiService

Gets all the versions of the given page

Specified by:

getVersionsOfPage in interface WikiService

Parameters:

page - The wiki page

Returns:

All the versions of the page

Throws:

WikiException

getVersionOfPageByName

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

Description copied from interface: WikiService

Gets a specific version by name of the given page

Specified by:

getVersionOfPageByName in interface WikiService

Parameters:

versionName - The name of the version

page - The wiki page

Returns:

The version of the wiki page

Throws:

WikiException

createVersionOfPage

public void createVersionOfPage(Page page)
                         throws WikiException

Description copied from interface: WikiService

Creates a version of a page. This method only tag the current page data as a new version, it does not update the page data

Specified by:

createVersionOfPage in interface WikiService

Parameters:

page - The wiki page

Throws:

WikiException

restoreVersionOfPage

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

Description copied from interface: WikiService

Restores a version of a page

Specified by:

restoreVersionOfPage in interface WikiService

Parameters:

versionName - The name of the version to restore

page - The wiki page

Throws:

WikiException

updatePage

public void updatePage(Page page,
                       PageUpdateType updateType)
                throws WikiException

Description copied from interface: WikiService

Update the given page. This does not automatically create a new version. If a new version must be created it should be explicitly done by calling createVersionOfPage(). The second parameter is the type of update done (title only, content only, both, move, ...).

Specified by:

updatePage in interface WikiService

Parameters:

page - Updated page

updateType - Type of update

Throws:

WikiException

getPreviousNamesOfPage

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

Description copied from interface: WikiService

Get previous names of a page

Specified by:

getPreviousNamesOfPage in interface WikiService

Parameters:

page - The wiki page

Returns:

List of all the previous names of the page

Throws:

WikiException

createTemplatePage

public void createTemplatePage(Wiki wiki,
                               Template template)
                        throws WikiException

Template

Specified by:

createTemplatePage in interface WikiService

Parameters:

wiki - Wiki of the template

template - The params object which is used for creating the new Wiki template.

Throws:

WikiException

getTemplatePage

public Template getTemplatePage(WikiPageParams params,
                                String templateId)
                         throws WikiException

Description copied from interface: WikiService

Gets a Wiki template.

Specified by:

getTemplatePage in interface WikiService

Parameters:

params - The params object which is used for creating the Wiki template.

templateId - Id of the wiki template.

Returns:

The wiki template.

Throws:

WikiException

getTemplates

public Map<String,Template> getTemplates(WikiPageParams params)
                                  throws WikiException

Description copied from interface: WikiService

Gets a map of wiki templates based on a given params object.

Specified by:

getTemplates in interface WikiService

Parameters:

params - The params object which is used for getting the wiki templates.

Returns:

The map of wiki templates.

Throws:

WikiException

searchTemplate

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

Description copied from interface: WikiService

Searches in all templates.

Specified by:

searchTemplate in interface WikiService

Parameters:

data - The data to search.

Returns:

Search results.

Throws:

WikiException

updateTemplate

public void updateTemplate(Template template)
                    throws WikiException

Description copied from interface: WikiService

Modifies an existing wiki template.

Specified by:

updateTemplate in interface WikiService

Parameters:

template - The updated wiki template.

Throws:

WikiException

deleteTemplatePage

public void deleteTemplatePage(String wikiType,
                               String wikiOwner,
                               String templateName)
                        throws WikiException

Description copied from interface: WikiService

Deletes a Wiki template.

Specified by:

deleteTemplatePage in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

templateName - Name of the Wiki template.

Throws:

WikiException

addRelatedPage

public void addRelatedPage(WikiPageParams orginaryPageParams,
                           WikiPageParams relatedPageParams)
                    throws WikiException

Description copied from interface: WikiService

Adds a related page to the current wiki page.

Specified by:

addRelatedPage in interface WikiService

Parameters:

orginaryPageParams - The params object of the current wiki page.

relatedPageParams - The params object of the related page.

Throws:

WikiException

getRelatedPagesOfPage

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

Description copied from interface: WikiService

Gets a list of related pages based on a given param.

Specified by:

getRelatedPagesOfPage in interface WikiService

Parameters:

page - The wiki page.

Returns:

The list of related pages.

Throws:

WikiException

removeRelatedPage

public void removeRelatedPage(WikiPageParams orginaryPageParams,
                              WikiPageParams relatedPageParams)
                       throws WikiException

Description copied from interface: WikiService

Removes a related page of the current wiki page.

Specified by:

removeRelatedPage in interface WikiService

Parameters:

orginaryPageParams - The params object of the current wiki page.

relatedPageParams - The params object of the related page.

Throws:

WikiException

getExsitedOrNewDraftPageById

public Page getExsitedOrNewDraftPageById(String wikiType,
                                         String wikiOwner,
                                         String pageId)
                                  throws WikiException

Draft

Specified by:

getExsitedOrNewDraftPageById in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The wiki page or its draft.

Throws:

WikiException

createDraftForNewPage

public DraftPage createDraftForNewPage(DraftPage draftPage,
                                       Page parentPage,
                                       long clientTime)
                                throws WikiException

Description copied from interface: WikiService

Creates a draft page for a new wiki page whose parent is specified by a given param object.

Specified by:

createDraftForNewPage in interface WikiService

parentPage - The parent wiki page.

clientTime - The time of client when the draft page is saved.

Returns:

The draft page.

Throws:

WikiException - if the draft page cannot be created.

createDraftForExistPage

public DraftPage createDraftForExistPage(DraftPage draftPage,
                                         Page targetPage,
                                         String revision,
                                         long clientTime)
                                  throws WikiException

Description copied from interface: WikiService

Creates a draft page for a wiki page which is specified by a given param object.

Specified by:

createDraftForExistPage in interface WikiService

targetPage - The target wiki page.

revision - The revision which is used for creating the draft page. If "null", this will be the last revision.

clientTime - The time of client when the draft page is saved.

Returns:

The draft page.

Throws:

WikiException - if the draft page cannot be created.

getDraftOfPage

public DraftPage getDraftOfPage(Page page)
                         throws WikiException

Description copied from interface: WikiService

Gets a draft page of a wiki page which is specified by a given param object.

Specified by:

getDraftOfPage in interface WikiService

Parameters:

page - The wiki page.

Returns:

The draft page, or "null" if the draft page does not exist.

Throws:

WikiException

getLastestDraft

public DraftPage getLastestDraft()
                          throws WikiException

Description copied from interface: WikiService

Gets the last created draft of a wiki page.

Specified by:

getLastestDraft in interface WikiService

Returns:

The last draft.

Throws:

WikiException

getDraft

public DraftPage getDraft(String draftName)
                   throws WikiException

Description copied from interface: WikiService

Gets a draft page by its name.

Specified by:

getDraft in interface WikiService

Parameters:

draftName - Name of the draft page.

Returns:

The draft page, or "null" if it does not exist.

Throws:

WikiException

removeDraftOfPage

public void removeDraftOfPage(WikiPageParams param)
                       throws WikiException

Description copied from interface: WikiService

Removes a draft page of a wiki page which is specified by the wiki page param.

Specified by:

removeDraftOfPage in interface WikiService

Parameters:

param - The param object of the wiki page param.

Throws:

WikiException

removeDraft

public void removeDraft(String draftName)
                 throws WikiException

Description copied from interface: WikiService

Removes a draft page by its name.

Specified by:

removeDraft in interface WikiService

Parameters:

draftName - Name of the draft page.

Throws:

WikiException

getDraftsOfUser

public List<DraftPage> getDraftsOfUser(String username)
                                throws WikiException

Description copied from interface: WikiService

Gets a list of draft pages belonging to a given user.

Specified by:

getDraftsOfUser in interface WikiService

Parameters:

username - Name of the user.

Returns:

The list of draft pages.

Throws:

WikiException

isDraftOutDated

public boolean isDraftOutDated(DraftPage draftPage)
                        throws WikiException

Description copied from interface: WikiService

Check if a draft page is outdated

Specified by:

isDraftOutDated in interface WikiService

Returns:

Throws:

WikiException

getDraftChanges

public org.exoplatform.commons.diff.DiffResult getDraftChanges(DraftPage draftPage)
                                                        throws WikiException

Description copied from interface: WikiService

Gets the changes between the draft page and the target page

Specified by:

getDraftChanges in interface WikiService

Returns:

Throws:

WikiException

getAttachmentsOfPage

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

Attachment

Specified by:

getAttachmentsOfPage in interface WikiService

Parameters:

page - The wiki page

Returns:

The attachments of the page

Throws:

WikiException

getAttachmentsOfPage

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

Description copied from interface: WikiService

Gets attachments of the given page, and allow to load their attachment content by setting loadContent to true

Specified by:

getAttachmentsOfPage in interface WikiService

Parameters:

page - The wiki page

Returns:

The attachments of the page

Throws:

WikiException

getNbOfAttachmentsOfPage

public int getNbOfAttachmentsOfPage(Page page)
                             throws WikiException

Description copied from interface: WikiService

Get the number of attachment of the given page

Specified by:

getNbOfAttachmentsOfPage in interface WikiService

Parameters:

page - The wiki page

Returns:

The number of attachments of the page

Throws:

WikiException

getAttachmentOfPageByName

public Attachment getAttachmentOfPageByName(String attachmentName,
                                            Page page)
                                     throws WikiException

Description copied from interface: WikiService

Get a attachment of a the given page by name, without loading its content

Specified by:

getAttachmentOfPageByName in interface WikiService

Parameters:

attachmentName - The name of the attachment

page - The wiki page

Returns:

Throws:

WikiException

getAttachmentOfPageByName

public Attachment getAttachmentOfPageByName(String attachmentName,
                                            Page page,
                                            boolean loadContent)
                                     throws WikiException

Description copied from interface: WikiService

Get a attachment of a the given page by name, and allow to load the attachment content by setting loadContent to true

Specified by:

getAttachmentOfPageByName in interface WikiService

Parameters:

attachmentName - The name of the attachment

page - The wiki page

loadContent - true to load the attachment content

Returns:

Throws:

WikiException

addAttachmentToPage

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

Description copied from interface: WikiService

Add the given attachment to the given page

Specified by:

addAttachmentToPage in interface WikiService

Parameters:

attachment - The attachment to add

page - The wiki page

Throws:

WikiException

deleteAttachmentOfPage

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

Description copied from interface: WikiService

Deletes the given attachment of the given page

Specified by:

deleteAttachmentOfPage in interface WikiService

Parameters:

attachmentId - Id of the attachment

page - The wiki page

Throws:

WikiException

getWatchersOfPage

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

Watch

Specified by:

getWatchersOfPage in interface WikiService

Parameters:

page - The wiki page

Throws:

WikiException

addWatcherToPage

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

Description copied from interface: WikiService

Add the given user as watcher of the wiki page

Specified by:

addWatcherToPage in interface WikiService

Parameters:

username - Username of the user to add as watcher

page - The wiki page

Throws:

WikiException

deleteWatcherOfPage

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

Description copied from interface: WikiService

Delete a user as watcher of the given page

Specified by:

deleteWatcherOfPage in interface WikiService

Parameters:

username - Username of the user to delete as watcher

page - The wiki page

Throws:

WikiException

searchSpaces

public List<SpaceBean> searchSpaces(String keyword)
                             throws WikiException

Spaces

Specified by:

searchSpaces in interface WikiService

Parameters:

keyword - The keyword to search for spaces.

Returns:

The list of spaces matching with the keyword.

Throws:

WikiException

hasAdminSpacePermission

public boolean hasAdminSpacePermission(String wikiType,
                                       String owner)
                                throws WikiException

Description copied from interface: WikiService

Checks if the current user has the admin permission on a space or not.

Specified by:

hasAdminSpacePermission in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

owner - Owner of the space.

Returns:

The returned value is "true" if the current user has the admin permission on the space, or "false" if not.

Throws:

WikiException

getSpaceNameByGroupId

public String getSpaceNameByGroupId(String groupId)

Description copied from interface: WikiService

Gets a space name by a given group Id.

Specified by:

getSpaceNameByGroupId in interface WikiService

Parameters:

groupId - The group Id.

Returns:

The space name.

postUpdatePage

public void postUpdatePage(String wikiType,
                           String wikiOwner,
                           String pageId,
                           Page page,
                           PageUpdateType wikiUpdateType)
                    throws WikiException

Listeners

Throws:

WikiException

postAddPage

public void postAddPage(String wikiType,
                        String wikiOwner,
                        String pageId,
                        Page page)
                 throws WikiException

Throws:

WikiException

postDeletePage

public void postDeletePage(String wikiType,
                           String wikiOwner,
                           String pageId,
                           Page page)
                    throws WikiException

Throws:

WikiException

addAttachment

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

Throws:

WikiException

deleteAttachment

public void deleteAttachment(String attachmentId,
                             Page page)
                      throws WikiException

Throws:

WikiException

getBreadcumb

public List<BreadcrumbData> getBreadcumb(String wikiType,
                                         String wikiOwner,
                                         String pageId)
                                  throws WikiException

Description copied from interface: WikiService

Gets a list of data which is used for composing the breadcrumb.

Specified by:

getBreadcumb in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page to which the breadcrumb points.

Returns:

The list of data.

Throws:

WikiException

getWikiPageParams

public WikiPageParams getWikiPageParams(BreadcrumbData data)

Description copied from interface: WikiService

Gets parameters of a wiki page based on the data stored in the breadcrumb.

Specified by:

getWikiPageParams in interface WikiService

Parameters:

data - The data in the breadcrumb that identifies the wiki page.

Returns:

The parameters identifying the wiki page.

hasAdminPagePermission

public boolean hasAdminPagePermission(String wikiType,
                                      String owner)
                               throws WikiException

Description copied from interface: WikiService

Checks if the current user has the admin permission on a wiki page.

Specified by:

hasAdminPagePermission in interface WikiService

Parameters:

wikiType - It can be Portal, Group, or User.

owner - Owner of the wiki page.

Returns:

"True" if the current user has the admin permission on the wiki page, or "false" if not.

Throws:

WikiException

createEmotionIcon

public void createEmotionIcon(EmotionIcon emotionIcon)
                       throws WikiException

Description copied from interface: WikiService

Creates a emotion icon

Specified by:

createEmotionIcon in interface WikiService

Parameters:

emotionIcon - The emotion icon to add

Throws:

WikiException

getUploadLimit

public int getUploadLimit()

Specified by:

getUploadLimit in interface WikiService

Returns:

Upload limit for Wiki Attachment

getPagesOfWiki

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

Description copied from interface: WikiService

Retrieve the all pages contained in wiki

Specified by:

getPagesOfWiki in interface WikiService

Returns: