org.opencms.setup

类 CmsUpdateBean

java.lang.Object

org.opencms.setup.CmsSetupBean

org.opencms.setup.CmsUpdateBean

所有已实现的接口:

I_CmsShellCommands

public class CmsUpdateBean
extends CmsSetupBean

A java bean as a controller for the OpenCms update wizard.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	FOLDER_UPDATE name of the update folder.
protected int	m_newLoggingDBOffset The new logging offset in the database update thread.
protected int	m_oldLoggingDBOffset The old logging offset in the database update thread.

从类继承的字段 org.opencms.setup.CmsSetupBean

AS400_PROVIDER, COMPONENTS_PROPERTIES, DB2_PROVIDER, DEFAULT_POSITION, DRIVER_TYPE_JPA, DRIVER_TYPE_SQL, FOLDER_BACKUP, FOLDER_DATABASE, FOLDER_LIB, FOLDER_SETUP, GENERIC_PROVIDER, HSQLDB_PROVIDER, HTML_MESSAGE_FILE, JPA_FACTOTY, JPA_PROVIDER, m_availableModules, m_cms, m_installModules, m_logFile, m_logsFolder, m_moduleDependencies, m_moduleFilenames, m_modulesFolder, m_newLoggingOffset, m_oldLoggingOffset, m_webAppRfsPath, MAXDB_PROVIDER, MSSQL_PROVIDER, MYSQL_PROVIDER, ORACLE_PROVIDER, POSTGRESQL_PROVIDER, PROPKEY_CHECKED, PROPKEY_COMPONENT, PROPKEY_COMPONENTS, PROPKEY_DEPENDENCIES, PROPKEY_DESCRIPTION, PROPKEY_JPA_SUPPORTED, PROPKEY_MODULES, PROPKEY_NAME, PROPKEY_POSITION, PROPKEY_SQL_SUPPORTED

构造器概要

构造器

构造器和说明
CmsUpdateBean() Default constructor.

方法概要

方法

限定符和类型	方法和说明
void	addSubscriptionDriver() Adds the subscription driver to the properties.
boolean	checkOceeVersion(java.lang.String version) Compatibility check for OCEE modules.
void	createSharedFolder() Creates the shared folder if possible.
java.lang.String	displayError(java.lang.String pathPrefix) Returns html code to display an error.
protected java.lang.String	getAdminGroup() Returns the admin Group.
java.lang.String	getAdminPwd() Returns the admin Pwd.
java.lang.String	getAdminUser() Returns the admin User.
double	getDetectedVersion() Returns the detected mayor version, based on DB structure.
java.util.Map<java.lang.String,CmsModuleVersion>	getInstalledModules() Returns a map of all previously installed modules.
protected java.util.List<java.lang.String>	getModulesToDelete() Computes a list of modules which need to be removed before updating the other modules, e.g. because of resource type conflicts.
java.util.List<java.lang.String>	getModulesToUpdate() List of modules to be updated.
CmsUpdateDBThread	getUpdateDBThread() Returns the update database thread.
java.lang.String	getUpdateProject() Returns the update Project.
java.lang.String	getUpdateSite() Returns the update site.
java.util.List<java.lang.String>	getUptodateModules() Returns the modules that does not need to be updated.
CmsUpdateThread	getWorkplaceUpdateThread() Returns the workplace update thread.
java.lang.String	htmlModules() Returns html for displaying a module selection box.
void	init(java.lang.String webAppRfsPath, java.lang.String servletMapping, java.lang.String defaultWebApplication) Creates a new instance of the setup Bean.
boolean	isKeepHistory() Returns the keep History parameter value.
boolean	isNeedDbUpdate() Returns true if a DB update is needed.
void	preload() Try to preload necessary classes, to avoid ugly class loader issues caused by JARs being deleted during the update.
void	preload(java.lang.Class<?> cls) Preloads classes from the same jar file as a given class.
void	prepareUpdateStep1() Prepares step 1 of the update wizard.
void	prepareUpdateStep1b() Prepares step 1 of the update wizard.
void	prepareUpdateStep1bOutput(javax.servlet.jsp.JspWriter out) Generates the output for step 1 of the setup wizard.
void	prepareUpdateStep5() Prepares step 5 of the update wizard.
void	prepareUpdateStep5b() Prepares step 5 of the update wizard.
void	prepareUpdateStep5bOutput(javax.servlet.jsp.JspWriter out) Generates the output for the update wizard.
void	prepareUpdateStep6() Prepares step 6 of the update wizard.
protected void	removeModule(java.lang.String moduleName, I_CmsReport report) Removes a module.
protected void	setAdminGroup(java.lang.String adminGroup) Sets the admin Group.
void	setAdminPwd(java.lang.String adminPwd) Sets the admin Pwd.
void	setAdminUser(java.lang.String adminUser) Sets the admin User.
void	setDetectedVersion(double detectedVersion) Sets the detected mayor version.
void	setKeepHistory(boolean keepHistory) Sets the keep History parameter value.
void	setUpdateProject(java.lang.String updateProject) Sets the update Project.
void	setUpdateSite(java.lang.String site) Sets the update site.
void	shellExit() May be called after shell exit, can e.g. be used to ouput a goodbye message.
void	shellStart() May be called before shell startup, can e.g. be used to ouput a welcome message.
protected void	updateModule(java.lang.String moduleName, java.lang.String importFile, I_CmsReport report) Imports a module (zipfile) from the default module directory, creating a temporary project for this.
void	updateModulesFromUpdateBean() Installed all modules that have been set using CmsSetupBean.setInstallModules(String).
void	updateRelations() Fills the relations db tables during the update.

从类继承的方法 org.opencms.setup.CmsSetupBean

addComponentsFromPath, backupConfiguration, buildDepsForAllComponents, checkEthernetAddress, clearCache, copyFile, displayErrors, getAvailableModules, getComponentModules, getComponents, getComponentsProperties, getConfigRfsPath, getDatabase, getDatabaseConfigPage, getDatabaseLibs, getDatabaseName, getDatabaseProperties, getDatabases, getDb, getDbConStrParams, getDbCreateConStr, getDbCreatePwd, getDbCreateUser, getDbDriver, getDbProperty, getDbTestQuery, getDbWorkConStr, getDbWorkPwd, getDbWorkUser, getDefaultContentEncoding, getDefaultWebApplication, getDisplayForModule, getErrors, getEthernetAddress, getExtProperty, getFullDatabaseKey, getHtmlForDbSelection, getHtmlHelpIcon, getHtmlPart, getHtmlPart, getLibFolder, getLogName, getModuleDependencies, getModuleFolder, getModulesToInstall, getPool, getProperties, getReplacer, getServerName, getServletConfig, getServletMapping, getSortedDatabases, getWebAppRfsPath, getWizardEnabled, getWorkplaceImportThread, getWorkplaceSite, getXmlHelper, htmlComponent, htmlComponents, htmlModule, htmlModuleHelpDescriptions, importModuleFromDefault, importModulesFromSetupBean, init, initHtmlParts, initializeComponents, initShellCmsObject, isAutoMode, isChecked, isImportRunning, isInitialized, isJpaSupported, isSqlSupported, jsComponentDependencies, jsComponentModules, jsComponentNames, jsModuleDependencies, jsModuleNames, lockWizard, prepareStep10, prepareStep8, prepareStep8b, prepareStep8bOutput, readDatabaseConfig, saveProperties, saveProperties, setAutoMode, setDatabase, setDb, setDbConStrParams, setDbCreateConStr, setDbCreatePwd, setDbCreateUser, setDbDriver, setDbParamaters, setDbParamaters, setDbProperty, setDbWorkConStr, setDbWorkPwd, setDbWorkUser, setDriverType, setEthernetAddress, setExtProperty, setFullDatabaseKey, setInstallModules, setReplacer, setServerName, setWorkplaceSite, sortModules, validateJdbc

从类继承的方法 java.lang.Object

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

字段详细资料

FOLDER_UPDATE

public static final java.lang.String FOLDER_UPDATE

name of the update folder.

m_newLoggingDBOffset

protected int m_newLoggingDBOffset

The new logging offset in the database update thread.

m_oldLoggingDBOffset

protected int m_oldLoggingDBOffset

The old logging offset in the database update thread.

构造器详细资料

CmsUpdateBean

public CmsUpdateBean()

Default constructor.

方法详细资料

addSubscriptionDriver

public void addSubscriptionDriver()

Adds the subscription driver to the properties.

checkOceeVersion

public boolean checkOceeVersion(java.lang.String version)

Compatibility check for OCEE modules.

参数:

version - the opencms version

返回:

false if OCEE is present but not compatible with opencms version

createSharedFolder

public void createSharedFolder()
                        throws java.lang.Exception

Creates the shared folder if possible.

抛出:

java.lang.Exception - if something goes wrong

displayError

public java.lang.String displayError(java.lang.String pathPrefix)

Returns html code to display an error.

覆盖:

displayError 在类中 CmsSetupBean

参数:

pathPrefix - to adjust the path

返回:

html code

getAdminPwd

public java.lang.String getAdminPwd()

Returns the admin Pwd.

返回:

the admin Pwd

getAdminUser

public java.lang.String getAdminUser()

Returns the admin User.

返回:

the admin User

getDetectedVersion

public double getDetectedVersion()

Returns the detected mayor version, based on DB structure.

返回:

the detected mayor version

getInstalledModules

public java.util.Map<java.lang.String,CmsModuleVersion> getInstalledModules()

Returns a map of all previously installed modules.

返回:

a map of [String, CmsModuleVersion] objects

另请参阅:

CmsModuleManager.getAllInstalledModules()

getModulesToUpdate

public java.util.List<java.lang.String> getModulesToUpdate()

List of modules to be updated.

返回:

a list of module names

getUpdateDBThread

public CmsUpdateDBThread getUpdateDBThread()

Returns the update database thread.

返回:

the update database thread

getUpdateProject

public java.lang.String getUpdateProject()

Returns the update Project.

返回:

the update Project

getUpdateSite

public java.lang.String getUpdateSite()

Returns the update site.

返回:

the update site

getUptodateModules

public java.util.List<java.lang.String> getUptodateModules()

Returns the modules that does not need to be updated.

返回:

a list of module names

getWorkplaceUpdateThread

public CmsUpdateThread getWorkplaceUpdateThread()

Returns the workplace update thread.

返回:

the workplace update thread

htmlModules

public java.lang.String htmlModules()

从类复制的说明: CmsSetupBean

Returns html for displaying a module selection box.

覆盖:

htmlModules 在类中 CmsSetupBean

返回:

html code

另请参阅:

CmsSetupBean.htmlModules()

init

public void init(java.lang.String webAppRfsPath,
        java.lang.String servletMapping,
        java.lang.String defaultWebApplication)

Creates a new instance of the setup Bean.

覆盖:

init 在类中 CmsSetupBean

参数:

webAppRfsPath - path to the OpenCms web application

servletMapping - the OpenCms servlet mapping

defaultWebApplication - the name of the default web application

isKeepHistory

public boolean isKeepHistory()

Returns the keep History parameter value.

返回:

the keep History parameter value

isNeedDbUpdate

public boolean isNeedDbUpdate()

Returns true if a DB update is needed.

返回:

true if a DB update is needed

preload

public void preload()

Try to preload necessary classes, to avoid ugly class loader issues caused by JARs being deleted during the update.

preload

public void preload(java.lang.Class<?> cls)

Preloads classes from the same jar file as a given class.

参数:

cls - the class for which the classes from the same jar file should be loaded

prepareUpdateStep1

public void prepareUpdateStep1()

Prepares step 1 of the update wizard.

prepareUpdateStep1b

public void prepareUpdateStep1b()

Prepares step 1 of the update wizard.

prepareUpdateStep1bOutput

public void prepareUpdateStep1bOutput(javax.servlet.jsp.JspWriter out)
                               throws java.io.IOException

Generates the output for step 1 of the setup wizard.

参数:

out - the JSP print stream

抛出:

java.io.IOException - in case errors occur while writing to "out"

prepareUpdateStep5

public void prepareUpdateStep5()

Prepares step 5 of the update wizard.

prepareUpdateStep5b

public void prepareUpdateStep5b()

Prepares step 5 of the update wizard.

prepareUpdateStep5bOutput

public void prepareUpdateStep5bOutput(javax.servlet.jsp.JspWriter out)
                               throws java.io.IOException

Generates the output for the update wizard.

参数:

out - the JSP print stream

抛出:

java.io.IOException - in case errors occur while writing to "out"

prepareUpdateStep6

public void prepareUpdateStep6()

Prepares step 6 of the update wizard.

setAdminPwd

public void setAdminPwd(java.lang.String adminPwd)

Sets the admin Pwd.

参数:

adminPwd - the admin Pwd to set

setAdminUser

public void setAdminUser(java.lang.String adminUser)

Sets the admin User.

参数:

adminUser - the admin User to set

setDetectedVersion

public void setDetectedVersion(double detectedVersion)

Sets the detected mayor version.

参数:

detectedVersion - the value to set

setKeepHistory

public void setKeepHistory(boolean keepHistory)

Sets the keep History parameter value.

参数:

keepHistory - the keep History parameter value to set

setUpdateProject

public void setUpdateProject(java.lang.String updateProject)

Sets the update Project.

参数:

updateProject - the update Project to set

setUpdateSite

public void setUpdateSite(java.lang.String site)

Sets the update site.

参数:

site - the update site to set

shellExit

public void shellExit()

从接口复制的说明: I_CmsShellCommands

May be called after shell exit, can e.g. be used to ouput a goodbye message.

Please note: This method is not guaranteed to be called. For a shell that has more then one shell command object initialized, only the exit method of one of thouse will be called.

指定者:

shellExit 在接口中 I_CmsShellCommands

覆盖:

shellExit 在类中 CmsSetupBean

另请参阅:

I_CmsShellCommands.shellExit()

shellStart

public void shellStart()

从接口复制的说明: I_CmsShellCommands

May be called before shell startup, can e.g. be used to ouput a welcome message.

Please note: This method is not guaranteed to be called. For a shell that has more then one shell command object initialized, only the start method of one of thouse will be called.

指定者:

shellStart 在接口中 I_CmsShellCommands

覆盖:

shellStart 在类中 CmsSetupBean

另请参阅:

I_CmsShellCommands.shellStart()

updateModulesFromUpdateBean

public void updateModulesFromUpdateBean()
                                 throws java.lang.Exception

Installed all modules that have been set using CmsSetupBean.setInstallModules(String).

This method is invoked as a shell command.

抛出:

java.lang.Exception - if something goes wrong

updateRelations

public void updateRelations()
                     throws java.lang.Exception

Fills the relations db tables during the update.

抛出:

java.lang.Exception - if something goes wrong

getAdminGroup

protected java.lang.String getAdminGroup()

Returns the admin Group.

返回:

the admin Group

getModulesToDelete

protected java.util.List<java.lang.String> getModulesToDelete()

Computes a list of modules which need to be removed before updating the other modules, e.g. because of resource type conflicts.

返回:

the list of names of modules which need to be removed

removeModule

protected void removeModule(java.lang.String moduleName,
                I_CmsReport report)
                     throws CmsException

Removes a module.

参数:

moduleName - the name of the module to remove

report - the report to write to

抛出:

CmsException

setAdminGroup

protected void setAdminGroup(java.lang.String adminGroup)

Sets the admin Group.

参数:

adminGroup - the admin Group to set

updateModule

protected void updateModule(java.lang.String moduleName,
                java.lang.String importFile,
                I_CmsReport report)
                     throws java.lang.Exception

Imports a module (zipfile) from the default module directory, creating a temporary project for this.

参数:

moduleName - the name of the module to replace

importFile - the name of the import .zip file located in the update module directory

report - the shell report to write the output

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

CmsImportExportManager.importData(org.opencms.file.CmsObject, I_CmsReport, org.opencms.importexport.CmsImportParameters)