Package com.atlassian.confluence.content.render.xhtml.migration.macro

Class MacroMigrationService

java.lang.Object

com.atlassian.confluence.content.render.xhtml.migration.macro.MacroMigrationService

public class MacroMigrationService
extends Object

Provides a way to find and migrate pages with the unmigrated wiki markup macro.

Constructor Summary

Constructors

Constructor	Description
MacroMigrationService(XhtmlWikiMarkupMacroMigrator migrator, SearchManager searchManager, ContentDao contentDao, LongRunningTaskManager longRunningTaskManager, org.springframework.transaction.PlatformTransactionManager platformTransactionManager, com.atlassian.bandana.BandanaManager bandanaManager, ConfluenceIndexer indexer)

Method Summary

Modifier and Type	Method	Description
SearchResults	findPagesWithUnmigratedMacros(int maxResults)
LongRunningTaskId	getLastMigrationId()
boolean	isAdminTaskIgnored()
boolean	isMigrating()
boolean	isMigrationRequired()
@Nullable LongRunningTaskId	migrateAll()	Attempt to migrate all instances of the unmigrated wiki markup macro to the new xhtml format.
void	setAdminTaskIgnored(boolean ignoreIt)
void	updateMigrationRequired()

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroMigrationService

public MacroMigrationService(XhtmlWikiMarkupMacroMigrator migrator,
                             SearchManager searchManager,
                             ContentDao contentDao,
                             LongRunningTaskManager longRunningTaskManager,
                             org.springframework.transaction.PlatformTransactionManager platformTransactionManager,
                             com.atlassian.bandana.BandanaManager bandanaManager,
                             ConfluenceIndexer indexer)

Method Detail

migrateAll

public @Nullable LongRunningTaskId migrateAll()
                                       throws InvalidSearchException

Attempt to migrate all instances of the unmigrated wiki markup macro to the new xhtml format. Updates the migration required field, setting it to false.

Throws:

InvalidSearchException

isMigrating

public boolean isMigrating()

getLastMigrationId

public LongRunningTaskId getLastMigrationId()

findPagesWithUnmigratedMacros

public SearchResults findPagesWithUnmigratedMacros(int maxResults)
                                            throws InvalidSearchException

Throws:

InvalidSearchException

updateMigrationRequired

public void updateMigrationRequired()

isMigrationRequired

public boolean isMigrationRequired()

setAdminTaskIgnored

public void setAdminTaskIgnored(boolean ignoreIt)

isAdminTaskIgnored

public boolean isAdminTaskIgnored()