Package org.exoplatform.wiki.service.impl

Class WikiServiceImpl

java.lang.Object

org.exoplatform.wiki.service.impl.WikiServiceImpl

All Implemented Interfaces:

WikiService

public class WikiServiceImpl
extends Object
implements WikiService

Constructor Summary

Constructors

Constructor	Description
WikiServiceImpl(org.exoplatform.portal.mop.service.LayoutService layoutService, org.exoplatform.portal.config.UserACL userAcl, org.exoplatform.social.core.space.spi.SpaceService spaceService, NoteDataStorage dataStorage)

Method Summary

Modifier and Type	Method	Description
void	addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin)	Configuration
boolean	canManageWiki(String wikiType, String wikiOwner, String username)	Checks whether a user can manage a Wiki or not
Wiki	createWiki(String wikiType, String owner)	Creates a wiki with the given type and owner
String	getDefaultWikiSyntaxId()	Gets Id of a default Wiki syntax.
Wiki	getOrCreateUserWiki(String username)	Gets a user Wiki.
Map<WikiPageParams,List<WikiPageParams>>	getPageLinksMap()
List<PageWikiListener>	getPageListeners()	Gets listeners of all wiki pages that are registered into the Wiki service.
String	getSpaceNameByGroupId(String groupId)	Gets a space name by a given group Id.
Wiki	getWikiById(String wikiId)	Gets a Wiki by its Id.
Wiki	getWikiByTypeAndOwner(String wikiType, String owner)	Wiki
WikiPageParams	getWikiPageParams(BreadcrumbData data)	Gets parameters of a wiki page based on the data stored in the breadcrumb.
List<Wiki>	getWikisByType(String wikiType)	Gets all wikis of the given type
String	getWikiWebappUri()	Gets a Wiki webapp URI.
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)

Methods inherited from class java.lang.Object

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

Constructor Details

WikiServiceImpl

public WikiServiceImpl(org.exoplatform.portal.mop.service.LayoutService layoutService,
 org.exoplatform.portal.config.UserACL userAcl,
 org.exoplatform.social.core.space.spi.SpaceService spaceService,
 NoteDataStorage dataStorage)

Method Details

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.

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.

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.

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 - if an error occured

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 - if an error occured

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 - if an error occured

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 - if an error occured

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.

Returns:

Wiki created

Throws:

WikiException - if an error occured

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

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

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.

canManageWiki

public boolean canManageWiki(String wikiType,
 String wikiOwner,
 String username)

Description copied from interface: WikiService

Checks whether a user can manage a Wiki or not

Specified by:

canManageWiki in interface WikiService

Parameters:

wikiType - WikiType name

wikiOwner - Wiki owner

username - User login

Returns:

true if can manage wiki and its notes, else false