org.exoplatform.wiki.jpa.migration

Class WikiMigrationSettingService

java.lang.Object

org.exoplatform.wiki.jpa.migration.WikiMigrationSettingService

public class WikiMigrationSettingService
extends Object

Created by The eXo Platform SAS Author : Thibault Clement tclement@exoplatform.com 1/26/16

Constructor Summary

Constructors

Constructor and Description
WikiMigrationSettingService(org.exoplatform.commons.api.settings.SettingService settingService)

Method Summary

Modifier and Type	Method and Description
void	addPageErrorToSetting(org.exoplatform.wiki.mow.api.Page pageMigrationError) Add a page to the "page errors" list stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list
void	addRelatedPagesToSetting(org.exoplatform.wiki.mow.api.Page relatedPage) Add a page to the list of "page with related pages" stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list
void	addWikiDeletionErrorToSetting(org.exoplatform.wiki.mow.api.Wiki wikiDeletionError) Add a wiki to the "wiki deletion errors" list stored in SettingService The list is stored as a unique string where all wiki are separated by comma See wikiToString() to check the format of a wiki in the string list
void	addWikiErrorToSetting(org.exoplatform.wiki.mow.api.Wiki wikiMigrationError) Add a wiki to the "wiki errors" list stored in SettingService The list is stored as a unique string where all wiki are separated by comma See wikiToString() to check the format of a wiki in the string list
boolean	getOrCreateOperationState(String operation) Call settingService to get the state of an operation (Migration of User wiki for instance)
Integer	getPageErrorsNumber()
String	getPageErrorsSetting() Get the "page error" list (a unique string with wiki separated by comma) See pageToString() to check the format of a page in the string list
String[]	getPagesWithRelatedPages() Get the "page with related pages" list in a String Array format
String	getRelatedPagesSetting() Get the "page with related pages" list (a unique string with wiki separated by comma) The migration of link between page is done at the end of migration and use this list See pageToString() to check the format of a page in the string list
Integer	getWikiDeletionErrorsNumber()
String	getWikiDeletionErrorsSetting() Get the "wiki deletion error" list (a unique string with wiki separated by comma) See wikiToString() to check the format of a wiki in the string list
String	getWikiErrorsSetting() Get the "wiki error" list (a unique string with wiki separated by comma) See wikiToString() to check the format of a wiki in the string list
Integer	getWikiMigrationErrorsNumber()
void	initMigrationSetting() Use the settingService to get all wiki migration setting as PLF startup.
boolean	isForceJCRDeletion() Get value (an eXo Property) that force the deletion of wiki and page even if they encounter error during migration
boolean	isForceRunMigration() Get value (an eXo Property) that force the migration to restart from the beginning
String	pageToString(org.exoplatform.wiki.mow.api.Page page) Transform a page to string to store it to the "page error" or "page with related page" String list
void	removeAllSettingValues() Remove from the SettingService all settings related to the wiki migration
void	removeSettingValue(String settingKey) Remove from the SettingService the setting with the given key
void	setForceJCRDeletion(boolean forceJCRDeletion)
void	setForceRunMigration(boolean forceRunMigration)
boolean	setOperationStatusToDefault(String operation) Set the value of the operation state to default (false)
void	setRelatedPagesToSetting(String pagesWithRelatedPagesString) Set the list of "page with related pages" stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list
void	setWikiCleanupOfTypeDone(String wikiType)
void	setWikiMigrationOfTypeDone(String wikiType)
org.exoplatform.wiki.mow.api.Page	stringToPage(String pageString)
void	updateOperationStatus(String key, Boolean status) Update in the settingService the status of an operation
String	wikiToString(org.exoplatform.wiki.mow.api.Wiki wiki) Transform a wiki to string to store it to the "wiki error" String list
String	wikiToString(org.exoplatform.wiki.mow.core.api.wiki.WikiImpl wiki) Transform a wikiImpl to string to store it to the "wiki error" String list

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiMigrationSettingService

public WikiMigrationSettingService(org.exoplatform.commons.api.settings.SettingService settingService)

Method Detail

isForceJCRDeletion

public boolean isForceJCRDeletion()

Get value (an eXo Property) that force the deletion of wiki and page even if they encounter error during migration

Returns:

setForceJCRDeletion

public void setForceJCRDeletion(boolean forceJCRDeletion)

isForceRunMigration

public boolean isForceRunMigration()

Get value (an eXo Property) that force the migration to restart from the beginning

Returns:

setForceRunMigration

public void setForceRunMigration(boolean forceRunMigration)

initMigrationSetting

public void initMigrationSetting()

Use the settingService to get all wiki migration setting as PLF startup. The settings allow to start the migration where it has been stopped before and do not re start operation already finished. If the setting doesn't exist yet (first PLF start after installation of the add-on) it is configure as false by default

getOrCreateOperationState

public boolean getOrCreateOperationState(String operation)

Call settingService to get the state of an operation (Migration of User wiki for instance)

Parameters:

operation - operation

Returns:

true if the operation already done, false if not

setOperationStatusToDefault

public boolean setOperationStatusToDefault(String operation)

Set the value of the operation state to default (false)

Parameters:

operation -

Returns:

the default value of the operation state

setWikiMigrationOfTypeDone

public void setWikiMigrationOfTypeDone(String wikiType)

setWikiCleanupOfTypeDone

public void setWikiCleanupOfTypeDone(String wikiType)

updateOperationStatus

public void updateOperationStatus(String key,
                                  Boolean status)

Update in the settingService the status of an operation

Parameters:

key - operation status

status -

removeSettingValue

public void removeSettingValue(String settingKey)

Remove from the SettingService the setting with the given key

removeAllSettingValues

public void removeAllSettingValues()

Remove from the SettingService all settings related to the wiki migration

addWikiErrorToSetting

public void addWikiErrorToSetting(org.exoplatform.wiki.mow.api.Wiki wikiMigrationError)

Add a wiki to the "wiki errors" list stored in SettingService The list is stored as a unique string where all wiki are separated by comma See wikiToString() to check the format of a wiki in the string list

Parameters:

wikiMigrationError - the wiki in error during migration

addPageErrorToSetting

public void addPageErrorToSetting(org.exoplatform.wiki.mow.api.Page pageMigrationError)

Add a page to the "page errors" list stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list

Parameters:

pageMigrationError - the page in error during migration

addWikiDeletionErrorToSetting

public void addWikiDeletionErrorToSetting(org.exoplatform.wiki.mow.api.Wiki wikiDeletionError)

Add a wiki to the "wiki deletion errors" list stored in SettingService The list is stored as a unique string where all wiki are separated by comma See wikiToString() to check the format of a wiki in the string list

Parameters:

wikiDeletionError - the wiki in error during deletion

getWikiErrorsSetting

public String getWikiErrorsSetting()

Get the "wiki error" list (a unique string with wiki separated by comma) See wikiToString() to check the format of a wiki in the string list

Returns:

a unique string containing all wiki in error separated by a comma

getPageErrorsSetting

public String getPageErrorsSetting()

Get the "page error" list (a unique string with wiki separated by comma) See pageToString() to check the format of a page in the string list

Returns:

a unique string containing all page in error separated by a comma

getWikiDeletionErrorsSetting

public String getWikiDeletionErrorsSetting()

Get the "wiki deletion error" list (a unique string with wiki separated by comma) See wikiToString() to check the format of a wiki in the string list

Returns:

a unique string containing all wiki in deletion error separated by a comma

addRelatedPagesToSetting

public void addRelatedPagesToSetting(org.exoplatform.wiki.mow.api.Page relatedPage)

Add a page to the list of "page with related pages" stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list

Parameters:

relatedPage -

getRelatedPagesSetting

public String getRelatedPagesSetting()

Get the "page with related pages" list (a unique string with wiki separated by comma) The migration of link between page is done at the end of migration and use this list See pageToString() to check the format of a page in the string list

Returns:

a unique string containing all page in error separated by a comma

getPagesWithRelatedPages

public String[] getPagesWithRelatedPages()

Get the "page with related pages" list in a String Array format

Returns:

an array of String representing a page

getWikiMigrationErrorsNumber

public Integer getWikiMigrationErrorsNumber()

Returns:

the number of wiki in error during the migration

getWikiDeletionErrorsNumber

public Integer getWikiDeletionErrorsNumber()

Returns:

the number of wiki in error during the deletion

getPageErrorsNumber

public Integer getPageErrorsNumber()

Returns:

the number of pages in error during the migration

wikiToString

public String wikiToString(org.exoplatform.wiki.mow.api.Wiki wiki)

Transform a wiki to string to store it to the "wiki error" String list

Parameters:

wiki - wiki to transform to string format

Returns:

wiki in String format: WikiType:WikiOwner

wikiToString

public String wikiToString(org.exoplatform.wiki.mow.core.api.wiki.WikiImpl wiki)

Transform a wikiImpl to string to store it to the "wiki error" String list

Parameters:

wiki - wiki to transform to string format

Returns:

wiki in String format: WikiType:WikiOwner

stringToPage

public org.exoplatform.wiki.mow.api.Page stringToPage(String pageString)

Parameters:

pageString - String to transform Page object

Returns:

pageToString

public String pageToString(org.exoplatform.wiki.mow.api.Page page)

Transform a page to string to store it to the "page error" or "page with related page" String list

Parameters:

page - page to transform to string format

Returns:

page in String format: WikiType:WikiOwner:PageId:PageName

setRelatedPagesToSetting

public void setRelatedPagesToSetting(String pagesWithRelatedPagesString)

Set the list of "page with related pages" stored in SettingService The list is stored as a unique string where all page are separated by comma See pageToString() to check the format of a page in the string list

Parameters:

pagesWithRelatedPagesString - the list of "page with related pages"