Package org.exoplatform.wiki.service.impl

Class NoteServiceImpl

java.lang.Object

org.exoplatform.wiki.service.impl.NoteServiceImpl

All Implemented Interfaces:

NoteService

public class NoteServiceImpl
extends Object
implements NoteService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATT_CACHE_NAME
static String	CACHE_NAME

Constructor Summary

Constructors

Constructor

Description

NoteServiceImpl(org.exoplatform.container.configuration.ConfigurationManager configManager, org.exoplatform.portal.config.UserACL userACL, DataStorage dataStorage, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.services.organization.OrganizationService orgService, WikiService wikiService, org.exoplatform.social.common.service.HTMLUploadImageProcessor htmlUploadImageProcessor)

Method Summary

Modifier and Type	Method	Description
boolean	canModifyNotePermission(Page currentNote, org.exoplatform.services.security.Identity currentIdentity)	Check if the given user can update the note
boolean	canPublicAndRetrictNote(Page currentNote, org.exoplatform.services.security.Identity currentIdentity)	Check if the given user can public or restrict the note
Page	createNote(Wiki noteBook, String parentNoteName, Page note, org.exoplatform.services.security.Identity userIdentity)	Create a new note in the given notebook, under the given parent note.
Page	createNote(Wiki noteBook, Page parentPage, Page note)	Create a new note in the given notebook, under the given parent note.
void	createVersionOfNote(Page note)	Creates a version of a note.
boolean	deleteNote(String noteType, String noteOwner, String noteName)	Deletes a note.
boolean	deleteNote(String noteType, String noteOwner, String noteName, org.exoplatform.services.security.Identity userIdentity)
List<BreadcrumbData>	getBreadcumb(String noteType, String noteOwner, String noteName)	Gets a list of data which is used for composing the breadcrumb.
List<Page>	getChildrenNoteOf(Page note)	Get all the children notes of a note
List<Page>	getDuplicateNotes(Page parentNote, Wiki targetNoteBook, List<Page> resultList)	Checks if a note and its children are duplicated with ones in the target NoteBook or not, then gets a list of duplicated notes if any.
Page	getNoteById(String id)	Gets a note based on its unique id.
Page	getNoteById(String id, org.exoplatform.services.security.Identity userIdentity)
Page	getNoteById(String id, org.exoplatform.services.security.Identity userIdentity, String source)
Page	getNoteByRootPermission(String noteBookType, String noteBookOwner, String noteId)
Page	getNoteOfNoteBookByName(String noteType, String noteOwner, String noteName)	Gets a note by its unique name in the noteBook.
Page	getNoteOfNoteBookByName(String noteType, String noteOwner, String noteName, org.exoplatform.services.security.Identity userIdentity)
Page	getNoteOfNoteBookByName(String noteType, String noteOwner, String noteName, org.exoplatform.services.security.Identity userIdentity, String source)
List<Page>	getNotesOfWiki(String noteType, String noteOwner)	Retrieve the all notes contained in noteBook
Map<WikiPageParams,List<WikiPageParams>>	getPageLinksMap()
Page	getParentNoteOf(Page note)	Get parent note of a note
List<String>	getPreviousNamesOfNote(Page note)	Get previous names of a note
org.exoplatform.services.cache.ExoCache<Integer,MarkupData>	getRenderingCache()
PageVersion	getVersionOfNoteByName(String versionName, Page note)	Gets a specific version by name of the given note
List<PageVersion>	getVersionsOfNote(Page note)	Gets all the versions of the given note
boolean	hasAdminNotePermission(String noteType, String owner, org.exoplatform.services.security.Identity user)	Checks if the current user has the admin permission on a note.
boolean	hasAdminSpacePermission(String noteBookType, String owner, org.exoplatform.services.security.Identity user)	Checks if the current user has the admin permission on a space or not.
boolean	hasPermissionOnNote(Page note, PermissionType permissionType, org.exoplatform.services.security.Identity user)	Checks if the given user has the permission on a note
protected void	invalidateAttachmentCache(Page note)
protected void	invalidateCache(Page page)
protected void	invalidateCachesOfPageTree(Page note)	Invalidate all caches of a page and all its descendants
boolean	isExisting(String noteBookType, String noteBookOwner, String noteId)
void	moveNote(WikiPageParams currentLocationParams, WikiPageParams newLocationParams)	Move a note
boolean	moveNote(WikiPageParams currentLocationParams, WikiPageParams newLocationParams, org.exoplatform.services.security.Identity userIdentity)	Move a note
void	postAddPage(String wikiType, String wikiOwner, String pageId, Page page)
void	postDeletePage(String wikiType, String wikiOwner, String pageId, Page page)
void	postOpenByBreadCrumb(String wikiType, String wikiOwner, String pageId, Page page)
void	postOpenByTree(String wikiType, String wikiOwner, String pageId, Page page)
void	postUpdatePage(String wikiType, String wikiOwner, String pageId, Page page, PageUpdateType wikiUpdateType)
void	removeDraftOfNote(WikiPageParams param)
boolean	renameNote(String noteType, String noteOwner, String noteName, String newName, String newTitle)	Renames a note.
void	restoreVersionOfNote(String versionName, Page note)	Restores a version of a note
void	updateNote(Page note)	Update the given note.
Page	updateNote(Page note, PageUpdateType type, org.exoplatform.services.security.Identity userIdentity)	Update the given note.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

NoteServiceImpl

public NoteServiceImpl(org.exoplatform.container.configuration.ConfigurationManager configManager,
                       org.exoplatform.portal.config.UserACL userACL,
                       DataStorage dataStorage,
                       org.exoplatform.services.cache.CacheService cacheService,
                       org.exoplatform.services.organization.OrganizationService orgService,
                       WikiService wikiService,
                       org.exoplatform.social.common.service.HTMLUploadImageProcessor htmlUploadImageProcessor)

Method Detail

getRenderingCache

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

getPageLinksMap

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

createNote

public Page createNote(Wiki noteBook,
                       String parentNoteName,
                       Page note,
                       org.exoplatform.services.security.Identity userIdentity)
                throws WikiException,
                       IllegalAccessException

Description copied from interface: NoteService

Create a new note in the given notebook, under the given parent note.

Specified by:

createNote in interface NoteService

Parameters:

noteBook - Notebook object.

parentNoteName - parent note name.

note - the note object to create.

userIdentity - user Identity.

Returns:

The new note.

Throws:

WikiException - if an error occured

IllegalAccessException - if the user don't have edit rights to the parent note

createNote

public Page createNote(Wiki noteBook,
                       Page parentPage,
                       Page note)
                throws WikiException

Description copied from interface: NoteService

Create a new note in the given notebook, under the given parent note.

Specified by:

createNote in interface NoteService

Parameters:

noteBook - Notebook object.

parentPage - parent note.

note - the note to create.

Returns:

The new note.

Throws:

WikiException - if an error occured

updateNote

public void updateNote(Page note)
                throws WikiException

Description copied from interface: NoteService

Update the given note.

Specified by:

updateNote in interface NoteService

Parameters:

note - Updated note

Throws:

WikiException - if an error occured

updateNote

public Page updateNote(Page note,
                       PageUpdateType type,
                       org.exoplatform.services.security.Identity userIdentity)
                throws WikiException,
                       IllegalAccessException,
                       org.gatein.api.EntityNotFoundException

Description copied from interface: NoteService

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

Specified by:

updateNote in interface NoteService

Parameters:

note - Updated note

type - Type of update

userIdentity - user Identity

Returns:

The updated note

Throws:

WikiException - if an error occure

IllegalAccessException - if the user don't have edit rights on the note

org.gatein.api.EntityNotFoundException - if the the note to update don't exist

deleteNote

public boolean deleteNote(String noteType,
                          String noteOwner,
                          String noteName)
                   throws WikiException

Description copied from interface: NoteService

Deletes a note.

Specified by:

deleteNote in interface NoteService

Parameters:

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

noteOwner - The NoteBook owner.

noteName - Id of the note.

Returns:

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

Throws:

WikiException - if an error occured

deleteNote

public boolean deleteNote(String noteType,
                          String noteOwner,
                          String noteName,
                          org.exoplatform.services.security.Identity userIdentity)
                   throws WikiException,
                          IllegalAccessException,
                          org.gatein.api.EntityNotFoundException

Specified by:

deleteNote in interface NoteService

Throws:

WikiException

IllegalAccessException

org.gatein.api.EntityNotFoundException

renameNote

public boolean renameNote(String noteType,
                          String noteOwner,
                          String noteName,
                          String newName,
                          String newTitle)
                   throws WikiException

Description copied from interface: NoteService

Renames a note.

Specified by:

renameNote in interface NoteService

Parameters:

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

noteOwner - The NoteBook owner.

noteName - Old name of the note.

newName - New name of the note.

newTitle - New title of the note.

Returns:

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

Throws:

WikiException - if an error occured

moveNote

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

Description copied from interface: NoteService

Move a note

Specified by:

moveNote in interface NoteService

Parameters:

currentLocationParams - The current location of the note.

newLocationParams - The new location of the note.

Throws:

WikiException - if an error occured

moveNote

public boolean moveNote(WikiPageParams currentLocationParams,
                        WikiPageParams newLocationParams,
                        org.exoplatform.services.security.Identity userIdentity)
                 throws WikiException,
                        IllegalAccessException,
                        org.gatein.api.EntityNotFoundException

Description copied from interface: NoteService

Move a note

Specified by:

moveNote in interface NoteService

Parameters:

currentLocationParams - The current location of the note.

newLocationParams - The new location of the note.

userIdentity - The user Identity to check permissions.

Returns:

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

Throws:

WikiException - if an error occured

IllegalAccessException - if the user don't have edit rights on the note

org.gatein.api.EntityNotFoundException - if the the note to move don't exist

getNoteOfNoteBookByName

public Page getNoteOfNoteBookByName(String noteType,
                                    String noteOwner,
                                    String noteName)
                             throws WikiException

Description copied from interface: NoteService

Gets a note by its unique name in the noteBook.

Specified by:

getNoteOfNoteBookByName in interface NoteService

Parameters:

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

noteOwner - The NoteBook owner.

noteName - Id of the note.

Returns:

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

Throws:

WikiException - if an error occured

getNoteOfNoteBookByName

public Page getNoteOfNoteBookByName(String noteType,
                                    String noteOwner,
                                    String noteName,
                                    org.exoplatform.services.security.Identity userIdentity,
                                    String source)
                             throws IllegalAccessException,
                                    WikiException

Specified by:

getNoteOfNoteBookByName in interface NoteService

Throws:

IllegalAccessException

WikiException

getNoteOfNoteBookByName

public Page getNoteOfNoteBookByName(String noteType,
                                    String noteOwner,
                                    String noteName,
                                    org.exoplatform.services.security.Identity userIdentity)
                             throws IllegalAccessException,
                                    WikiException

Specified by:

getNoteOfNoteBookByName in interface NoteService

Throws:

IllegalAccessException

WikiException

getNoteById

public Page getNoteById(String id)
                 throws WikiException

Description copied from interface: NoteService

Gets a note based on its unique id.

Specified by:

getNoteById in interface NoteService

Parameters:

id - Unique id of the note.

Returns:

The note.

Throws:

WikiException - if an error occured

getNoteById

public Page getNoteById(String id,
                        org.exoplatform.services.security.Identity userIdentity)
                 throws IllegalAccessException,
                        WikiException

Specified by:

getNoteById in interface NoteService

Throws:

IllegalAccessException

WikiException

getNoteById

public Page getNoteById(String id,
                        org.exoplatform.services.security.Identity userIdentity,
                        String source)
                 throws IllegalAccessException,
                        WikiException

Specified by:

getNoteById in interface NoteService

Throws:

IllegalAccessException

WikiException

getParentNoteOf

public Page getParentNoteOf(Page note)
                     throws WikiException

Description copied from interface: NoteService

Get parent note of a note

Specified by:

getParentNoteOf in interface NoteService

Parameters:

note - note.

Returns:

The list of children notes

Throws:

WikiException - if an error occured

getChildrenNoteOf

public List<Page> getChildrenNoteOf(Page note)
                             throws WikiException

Description copied from interface: NoteService

Get all the children notes of a note

Specified by:

getChildrenNoteOf in interface NoteService

Parameters:

note - note.

Returns:

The list of children notes

Throws:

WikiException - if an error occured

getBreadcumb

public List<BreadcrumbData> getBreadcumb(String noteType,
                                         String noteOwner,
                                         String noteName)
                                  throws WikiException

Description copied from interface: NoteService

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

Specified by:

getBreadcumb in interface NoteService

Parameters:

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

noteOwner - The owner.

noteName - Id of the note to which the breadcrumb points.

Returns:

The list of data.

Throws:

WikiException - if an error occured

getDuplicateNotes

public List<Page> getDuplicateNotes(Page parentNote,
                                    Wiki targetNoteBook,
                                    List<Page> resultList)
                             throws WikiException

Description copied from interface: NoteService

Checks if a note and its children are duplicated with ones in the target NoteBook or not, then gets a list of duplicated notes if any.

Specified by:

getDuplicateNotes in interface NoteService

Parameters:

parentNote - The note to check.

targetNoteBook - The target NoteBook to check.

resultList - The list of duplicated notes.

Returns:

The list of duplicated notes.

Throws:

WikiException - if an error occured

removeDraftOfNote

public void removeDraftOfNote(WikiPageParams param)
                       throws WikiException

Specified by:

removeDraftOfNote in interface NoteService

Throws:

WikiException

hasPermissionOnNote

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

Description copied from interface: NoteService

Checks if the given user has the permission on a note

Specified by:

hasPermissionOnNote in interface NoteService

Parameters:

note - the note to check

permissionType - type of permissions to chack

user - the user

Returns:

true if user has permissions on the note

Throws:

WikiException - if an error occured

hasAdminSpacePermission

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

Description copied from interface: NoteService

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

Specified by:

hasAdminSpacePermission in interface NoteService

Parameters:

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

owner - Owner of the space.

user - Identity of current user.

Returns:

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

Throws:

WikiException - if an error occured

hasAdminNotePermission

public boolean hasAdminNotePermission(String noteType,
                                      String owner,
                                      org.exoplatform.services.security.Identity user)
                               throws WikiException

Description copied from interface: NoteService

Checks if the current user has the admin permission on a note.

Specified by:

hasAdminNotePermission in interface NoteService

Parameters:

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

owner - Owner of the noteBook.

user - Identity of current user.

Returns:

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

Throws:

WikiException - if an error occured

canModifyNotePermission

public boolean canModifyNotePermission(Page currentNote,
                                       org.exoplatform.services.security.Identity currentIdentity)
                                throws WikiException

Description copied from interface: NoteService

Check if the given user can update the note

Specified by:

canModifyNotePermission in interface NoteService

Parameters:

currentNote - The note to update

currentIdentity - The identity of user user that needs to update the note

Returns:

true if the user can update the note

Throws:

WikiException - if an error occured

canPublicAndRetrictNote

public boolean canPublicAndRetrictNote(Page currentNote,
                                       org.exoplatform.services.security.Identity currentIdentity)
                                throws WikiException

Description copied from interface: NoteService

Check if the given user can public or restrict the note

Specified by:

canPublicAndRetrictNote in interface NoteService

Parameters:

currentNote - the note to chack permissions

currentIdentity - The identity of user

Returns:

true if the current user has EditNote permission or admin note or admin space

Throws:

WikiException - if an error occured

getVersionsOfNote

public List<PageVersion> getVersionsOfNote(Page note)
                                    throws WikiException

Description copied from interface: NoteService

Gets all the versions of the given note

Specified by:

getVersionsOfNote in interface NoteService

Parameters:

note - The note

Returns:

All the versions of the note

Throws:

WikiException - if an error occured

getVersionOfNoteByName

public PageVersion getVersionOfNoteByName(String versionName,
                                          Page note)
                                   throws WikiException

Description copied from interface: NoteService

Gets a specific version by name of the given note

Specified by:

getVersionOfNoteByName in interface NoteService

Parameters:

versionName - The name of the version

note - The note

Returns:

The version of the note

Throws:

WikiException - if an error occured

createVersionOfNote

public void createVersionOfNote(Page note)
                         throws WikiException

Description copied from interface: NoteService

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

Specified by:

createVersionOfNote in interface NoteService

Parameters:

note - The note

Throws:

WikiException - if an error occured

restoreVersionOfNote

public void restoreVersionOfNote(String versionName,
                                 Page note)
                          throws WikiException

Description copied from interface: NoteService

Restores a version of a note

Specified by:

restoreVersionOfNote in interface NoteService

Parameters:

versionName - The name of the version to restore

note - The note

Throws:

WikiException - if an error occured

getPreviousNamesOfNote

public List<String> getPreviousNamesOfNote(Page note)
                                    throws WikiException

Description copied from interface: NoteService

Get previous names of a note

Specified by:

getPreviousNamesOfNote in interface NoteService

Parameters:

note - The note

Returns:

List of all the previous names of the note

Throws:

WikiException - if an error occured

getNotesOfWiki

public List<Page> getNotesOfWiki(String noteType,
                                 String noteOwner)

Description copied from interface: NoteService

Retrieve the all notes contained in noteBook

Specified by:

getNotesOfWiki in interface NoteService

Parameters:

noteType - the notebook Type It can be Portal, Group, or User.

noteOwner - the notebook owner

Returns:

List of pages

isExisting

public boolean isExisting(String noteBookType,
                          String noteBookOwner,
                          String noteId)
                   throws WikiException

Specified by:

isExisting in interface NoteService

Throws:

WikiException

getNoteByRootPermission

public Page getNoteByRootPermission(String noteBookType,
                                    String noteBookOwner,
                                    String noteId)
                             throws WikiException

Specified by:

getNoteByRootPermission in interface NoteService

Throws:

WikiException

invalidateCache

protected void invalidateCache(Page page)

invalidateCachesOfPageTree

protected void invalidateCachesOfPageTree(Page note)
                                   throws WikiException

Invalidate all caches of a page and all its descendants

Parameters:

note - root page

Throws:

WikiException - if an error occured

invalidateAttachmentCache

protected void invalidateAttachmentCache(Page note)

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

postOpenByTree

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

Throws:

WikiException

postOpenByBreadCrumb

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

Throws:

WikiException