|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.setup.CmsSetupBean
org.opencms.setup.CmsUpdateBean
public class CmsUpdateBean
A java bean as a controller for the OpenCms update wizard.
Field Summary | |
---|---|
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 lod logging offset in the database update thread. |
Fields inherited from class org.opencms.setup.CmsSetupBean |
---|
FOLDER_BACKUP, FOLDER_DATABASE, FOLDER_LIB, FOLDER_SETUP, GENERIC_PROVIDER, HTML_MESSAGE_FILE, m_availableModules, m_cms, m_installModules, m_logFile, m_logsFolder, m_moduleDependencies, m_moduleFilenames, m_modulesFolder, m_newLoggingOffset, m_oldLoggingOffset, m_webAppRfsPath, MAXDB_PROVIDER, MYSQL_PROVIDER, ORACLE_PROVIDER, POSTGRESQL_PROVIDER |
Constructor Summary | |
---|---|
CmsUpdateBean()
Default constructor. |
Method Summary | |
---|---|
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. |
java.util.Map |
getInstalledModules()
Returns a map of all previously installed modules. |
java.util.List |
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 |
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. |
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 |
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 |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FOLDER_UPDATE
protected int m_newLoggingDBOffset
protected int m_oldLoggingDBOffset
Constructor Detail |
---|
public CmsUpdateBean()
Method Detail |
---|
public java.lang.String displayError(java.lang.String pathPrefix)
displayError
in class CmsSetupBean
pathPrefix
- to adjust the path
public java.lang.String getAdminPwd()
public java.lang.String getAdminUser()
public java.util.Map getInstalledModules()
[String, CmsModuleVersion
]
objectsCmsModuleManager.getAllInstalledModules()
public java.util.List getModulesToUpdate()
public CmsUpdateDBThread getUpdateDBThread()
public java.lang.String getUpdateProject()
public java.lang.String getUpdateSite()
public java.util.List getUptodateModules()
public CmsUpdateThread getWorkplaceUpdateThread()
public java.lang.String htmlModules()
CmsSetupBean
htmlModules
in class CmsSetupBean
CmsSetupBean.htmlModules()
public void init(java.lang.String webAppRfsPath, java.lang.String servletMapping, java.lang.String defaultWebApplication)
init
in class CmsSetupBean
webAppRfsPath
- path to the OpenCms web applicationservletMapping
- the OpenCms servlet mappingdefaultWebApplication
- the name of the default web applicationpublic boolean isKeepHistory()
public void prepareUpdateStep1()
public void prepareUpdateStep1b()
public void prepareUpdateStep1bOutput(javax.servlet.jsp.JspWriter out) throws java.io.IOException
out
- the JSP print stream
java.io.IOException
- in case errors occur while writing to "out"public void prepareUpdateStep5()
public void prepareUpdateStep5b()
public void prepareUpdateStep5bOutput(javax.servlet.jsp.JspWriter out) throws java.io.IOException
out
- the JSP print stream
java.io.IOException
- in case errors occur while writing to "out"public void prepareUpdateStep6()
public void setAdminPwd(java.lang.String adminPwd)
adminPwd
- the admin Pwd to setpublic void setAdminUser(java.lang.String adminUser)
adminUser
- the admin User to setpublic void setKeepHistory(boolean keepHistory)
keepHistory
- the keep History parameter value to setpublic void setUpdateProject(java.lang.String updateProject)
updateProject
- the update Project to setpublic void setUpdateSite(java.lang.String site)
site
- the update site to setpublic void shellExit()
I_CmsShellCommands
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
in interface I_CmsShellCommands
shellExit
in class CmsSetupBean
I_CmsShellCommands.shellExit()
public void shellStart()
I_CmsShellCommands
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
in interface I_CmsShellCommands
shellStart
in class CmsSetupBean
I_CmsShellCommands.shellStart()
public void updateModulesFromUpdateBean() throws java.lang.Exception
CmsSetupBean.setInstallModules(String)
.This method is invoked as a shell command.
java.lang.Exception
- if something goes wrongpublic void updateRelations() throws java.lang.Exception
java.lang.Exception
- if something goes wrongprotected java.lang.String getAdminGroup()
protected void setAdminGroup(java.lang.String adminGroup)
adminGroup
- the admin Group to setprotected void updateModule(java.lang.String moduleName, java.lang.String importFile, I_CmsReport report) throws java.lang.Exception
moduleName
- the name of the module to replaceimportFile
- the name of the import .zip file located in the update module directoryreport
- the shell report to write the output
java.lang.Exception
- if something goes wrongCmsImportExportManager.importData(org.opencms.file.CmsObject, String, String, org.opencms.report.I_CmsReport)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |