org.opencms.setup

类 CmsSetupBean

java.lang.Object

org.opencms.setup.CmsSetupBean

所有已实现的接口:

I_CmsShellCommands

直接已知子类:

CmsUpdateBean

public class CmsSetupBean
extends java.lang.Object
implements I_CmsShellCommands

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

It is not allowed to customize this bean with methods for a specific database server setup!

Database server specific settings should be set/read using get/setDbProperty, as for example like:

 setDbProperty("oracle.defaultTablespace", value);
 

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	AS400_PROVIDER DB provider constant for as400.
static java.lang.String	COMPONENTS_PROPERTIES The name of the components properties file.
static java.lang.String	DB2_PROVIDER DB provider constant for db2.
protected static int	DEFAULT_POSITION The default component position, is missing.
static byte	DRIVER_TYPE_JPA jpa type constant.
static byte	DRIVER_TYPE_SQL jpa type constant.
static java.lang.String	FOLDER_BACKUP Folder constant name.
static java.lang.String	FOLDER_DATABASE Folder constant name.
static java.lang.String	FOLDER_LIB Folder constant name.
static java.lang.String	FOLDER_SETUP Folder constant name.
static java.lang.String	GENERIC_PROVIDER DB provider constant.
static java.lang.String	HSQLDB_PROVIDER DB provider constant for hsqldb.
static java.lang.String	HTML_MESSAGE_FILE Name of the property file containing HTML fragments for setup wizard and error dialog.
static java.lang.String	JPA_FACTOTY The jpa CmsDbContextFactory for the opencms-system.xml node: runtimeclasses -> runtimeinfo.
static java.lang.String	JPA_PROVIDER DB provider constant for jpa.
protected java.util.Map<java.lang.String,CmsModule>	m_availableModules A map with all available modules.
protected CmsObject	m_cms A CmsObject to execute shell commands.
protected java.util.List<java.lang.String>	m_installModules A list with the package names of the modules to be installed .
protected java.lang.String	m_logFile Location for log file.
protected java.lang.String	m_logsFolder Location for logs relative to the webapp folder.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	m_moduleDependencies A map with lists of dependent module package names keyed by module package names.
protected java.util.Map<java.lang.String,java.lang.String>	m_moduleFilenames A map with all available modules filenames.
protected java.lang.String	m_modulesFolder Location for module archives relative to the webapp folder.
protected int	m_newLoggingOffset The new logging offset in the workplace import thread.
protected int	m_oldLoggingOffset The lod logging offset in the workplace import thread.
protected java.lang.String	m_webAppRfsPath The absolute path to the home directory of the OpenCms webapp.
static java.lang.String	MAXDB_PROVIDER DB provider constant for maxdb.
static java.lang.String	MSSQL_PROVIDER DB provider constant for mssql.
static java.lang.String	MYSQL_PROVIDER DB provider constant for mysql.
static java.lang.String	ORACLE_PROVIDER DB provider constant for oracle.
static java.lang.String	POSTGRESQL_PROVIDER DB provider constant for postgresql.
protected static java.lang.String	PROPKEY_CHECKED Properties file key constant post fix.
protected static java.lang.String	PROPKEY_COMPONENT Properties file key constant prefix.
protected static java.lang.String	PROPKEY_COMPONENTS Properties file key constant.
protected static java.lang.String	PROPKEY_DEPENDENCIES Properties file key constant post fix.
protected static java.lang.String	PROPKEY_DESCRIPTION Properties file key constant post fix.
protected static java.lang.String	PROPKEY_JPA_SUPPORTED True if OpenCms supports a generic JPA driver implementation.
protected static java.lang.String	PROPKEY_MODULES Properties file key constant post fix.
protected static java.lang.String	PROPKEY_NAME Properties file key constant post fix.
protected static java.lang.String	PROPKEY_POSITION Properties file key constant post fix.
protected static java.lang.String	PROPKEY_SQL_SUPPORTED True if OpenCms supports a native SQL driver implementation.

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
protected void	addComponentsFromPath(java.lang.String fileName) Reads all components from the given location, a folder or a zip file.
void	backupConfiguration(java.lang.String filename, java.lang.String originalFilename) Restores the opencms.xml either to or from a backup file, depending whether the setup wizard is executed the first time (the backup does not exist) or not (the backup exists).
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	buildDepsForAllComponents() Returns a map of dependencies.
void	checkEthernetAddress() Checks the ethernet address value and generates a dummy address, if necessary.
void	clearCache() Clears the cache.
void	copyFile(java.lang.String source, java.lang.String target) Copies a given file.
java.lang.String	displayError(java.lang.String pathPrefix) Returns html code to display an error.
java.lang.String	displayErrors(java.lang.String pathPrefix) Returns html code to display the errors occurred.
java.util.Map<java.lang.String,CmsModule>	getAvailableModules() Returns a map with all available modules.
protected java.lang.String	getComponentModules(java.util.List<java.lang.String> componentIds) Returns a pipe separated list of module names for the given list of components.
CmsIdentifiableObjectContainer<CmsSetupComponent>	getComponents() Returns the components.
protected CmsParameterConfiguration	getComponentsProperties(java.lang.String location) Reads all properties from the components.properties file at the given location, a folder or a zip file.
java.lang.String	getConfigRfsPath() Returns the "config" path in the OpenCms web application.
java.lang.String	getDatabase() Returns the key of the selected database server (e.g.
java.lang.String	getDatabaseConfigPage(java.lang.String key) Returns the URI of a database config page (in step 3) for a specified database key.
java.util.List<java.lang.String>	getDatabaseLibs(java.lang.String databaseKey) Returns a list of needed jar filenames for a database server setup specified by a database key (e.g.
java.lang.String	getDatabaseName(java.lang.String databaseKey) Returns the clear text name for a database server setup specified by a database key (e.g.
java.util.Map<java.lang.String,java.util.Properties>	getDatabaseProperties() Returns a map with the database properties of *all* available database configurations keyed by their database keys (e.g.
java.util.List<java.lang.String>	getDatabases() Returns a list with they keys (e.g.
java.lang.String	getDb() Returns the database name.
java.lang.String	getDbConStrParams() Returns the JDBC connect URL parameters.
java.lang.String	getDbCreateConStr() Returns the database create statement.
java.lang.String	getDbCreatePwd() Returns the password used for database creation.
java.lang.String	getDbCreateUser() Returns the database user that is used to connect to the database.
java.lang.String	getDbDriver() Returns the database driver belonging to the database from the default configuration.
java.lang.String	getDbProperty(java.lang.String key) Returns the value for a given key from the database properties.
java.lang.String	getDbTestQuery() Returns the validation query belonging to the database from the default configuration .
java.lang.String	getDbWorkConStr() Returns a connection string.
java.lang.String	getDbWorkPwd() Returns the password of the database from the properties .
java.lang.String	getDbWorkUser() Returns the user of the database from the properties.
java.lang.String	getDefaultContentEncoding() Returns the default content encoding.
java.lang.String	getDefaultWebApplication() Returns the name of the default web application, configured in web.xml.
java.lang.String	getDisplayForModule(CmsModule module) Returns the display string for a given module.
java.util.List<java.lang.String>	getErrors() Returns the error messages.
java.lang.String	getEthernetAddress() Returns the mac ethernet address.
protected java.lang.String	getExtProperty(java.lang.String key) Returns the value for a given key from the extended properties.
java.lang.String	getFullDatabaseKey() Returns the fullDatabaseKey.
java.lang.String	getHtmlForDbSelection() Generates the HTML code for the drop down for db selection.
java.lang.String	getHtmlHelpIcon(java.lang.String id, java.lang.String pathPrefix) Returns a help image icon tag to display a help text in the setup wizard.
java.lang.String	getHtmlPart(java.lang.String part) Returns the specified HTML part of the HTML property file to create the output.
java.lang.String	getHtmlPart(java.lang.String part, java.lang.String replaceString) Returns the specified HTML part of the HTML property file to create the output.
java.lang.String	getLibFolder() Returns the path to the /WEB-INF/lib folder.
java.lang.String	getLogName() Returns the name of the log file.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getModuleDependencies() Returns a map with lists of dependent module package names keyed by module package names.
java.lang.String	getModuleFolder() Returns the absolute path to the module root folder.
java.util.List<java.lang.String>	getModulesToInstall() Returns A list with the package names of the modules to be installed.
java.lang.String	getPool() Gets the default pool.
CmsParameterConfiguration	getProperties() Returns the parameter configuration.
java.util.Map<java.lang.String,java.lang.String>	getReplacer() Returns the replacer.
java.lang.String	getServerName() Return the OpenCms server name.
javax.servlet.ServletConfig	getServletConfig() Returns the initial servlet configuration.
java.lang.String	getServletMapping() Returns the OpenCms servlet mapping, configured in web.xml.
java.util.List<java.lang.String>	getSortedDatabases() Returns a sorted list with they keys (e.g.
java.lang.String	getWebAppRfsPath() Returns the absolute path to the OpenCms home directory.
boolean	getWizardEnabled() Checks if the setup wizard is enabled.
CmsSetupWorkplaceImportThread	getWorkplaceImportThread() Returns the workplace import thread.
java.lang.String	getWorkplaceSite() Return the OpenCms workplace site.
CmsSetupXmlHelper	getXmlHelper() Returns the xml Helper object.
protected java.lang.String	htmlComponent(CmsSetupComponent component) Returns html for the given component to fill the selection list.
java.lang.String	htmlComponents() Returns the html code for component selection.
protected java.lang.String	htmlModule(CmsModule module, int pos) Returns html for the given module to fill the selection list.
java.lang.String	htmlModuleHelpDescriptions() Returns html code for the module descriptions in help ballons.
java.lang.String	htmlModules() Returns html for displaying a module selection box.
protected void	importModuleFromDefault(java.lang.String importFile) Imports a module (zipfile) from the default module directory, creating a temporary project for this.
void	importModulesFromSetupBean() Installed all modules that have been set using setInstallModules(String).
void	init(javax.servlet.jsp.PageContext pageContext) Creates a new instance of the setup Bean from a JSP page.
void	init(java.lang.String webAppRfsPath, java.lang.String servletMapping, java.lang.String defaultWebApplication) Creates a new instance of the setup Bean.
void	initHtmlParts() This method reads the properties from the htmlmsg.property file and sets the HTML part properties with the matching values.
protected void	initializeComponents(java.util.Collection<java.lang.String> modules) Initializes and validates the read components.
void	initShellCmsObject(CmsObject cms, CmsShell shell) Provides access to the shell CmsObject and the shell itself.
boolean	isAutoMode() Returns the autoMode.
java.lang.String	isChecked(java.lang.String value1, java.lang.String value2) Over simplistic helper to compare two strings to check radio buttons.
protected boolean	isImportRunning() Returns true if the import thread is currently running.
boolean	isInitialized() Returns true if this setup bean is correctly initialized.
boolean	isJpaSupported(java.lang.String dbKey) Returns true if jpa is supported for the given dbKey.
boolean	isSqlSupported(java.lang.String dbKey) Returns true if sql is supported for the given dbKey.
java.lang.String	jsComponentDependencies() Returns js code with array definition for the available component dependencies.
java.lang.String	jsComponentModules() Returns js code with array definition for the component modules.
java.lang.String	jsComponentNames() Returns js code with array definition for the available components names.
java.lang.String	jsModuleDependencies() Returns js code with array definition for the available module dependencies.
java.lang.String	jsModuleNames() Returns js code with array definition for the available module names.
void	lockWizard() Locks (i.e. disables) the setup wizard.
void	prepareStep10() Prepares step 10 of the setup wizard.
boolean	prepareStep8() Prepares step 8 of the setup wizard.
void	prepareStep8b() Prepares step 8b of the setup wizard.
void	prepareStep8bOutput(javax.servlet.jsp.JspWriter out) Generates the output for step 8b of the setup wizard.
protected void	readDatabaseConfig() Stores the properties of all available database configurations in a map keyed by their database key names (e.g.
void	saveProperties(CmsParameterConfiguration properties, java.lang.String file, boolean backup) Saves properties to specified file.
void	saveProperties(CmsParameterConfiguration properties, java.lang.String file, boolean backup, java.util.Set<java.lang.String> forceWrite) Saves properties to specified file.
void	setAutoMode(boolean autoMode) Sets the autoMode.
void	setDatabase(java.lang.String databaseKey) Sets the database drivers to the given value.
void	setDb(java.lang.String db) Sets the database name.
void	setDbConStrParams(java.lang.String value) Sets the JDBC connect URL parameters.
void	setDbCreateConStr(java.lang.String dbCreateConStr) Sets the database create statement.
void	setDbCreatePwd(java.lang.String dbCreatePwd) Sets the password used for the initial OpenCms database creation.
void	setDbCreateUser(java.lang.String dbCreateUser) Set the database user that is used to connect to the database.
void	setDbDriver(java.lang.String driver) Sets the database driver belonging to the database.
boolean	setDbParamaters(javax.servlet.http.HttpServletRequest request, java.lang.String provider) Sets the needed database parameters.
boolean	setDbParamaters(java.util.Map<java.lang.String,java.lang.String[]> request, java.lang.String provider, java.lang.String contextPath, javax.servlet.http.HttpSession session) Sets the needed database parameters.
void	setDbProperty(java.lang.String key, java.lang.String value) This method sets the value for a given key in the database properties.
void	setDbWorkConStr(java.lang.String dbWorkConStr) Sets the connection string to the database to the given value.
void	setDbWorkPwd(java.lang.String dbWorkPwd) Sets the password of the database to the given value.
void	setDbWorkUser(java.lang.String dbWorkUser) Sets the user of the database to the given value.
void	setDriverType(java.lang.String type) Sets the driver type.
void	setEthernetAddress(java.lang.String ethernetAddress) Set the mac ethernet address, required for UUID generation.
protected void	setExtProperty(java.lang.String key, java.lang.String value) This method sets the value for a given key in the extended properties.
void	setFullDatabaseKey(java.lang.String fullDatabaseKey) Sets the fullDatabaseKey.
void	setInstallModules(java.lang.String value) Sets the list with the package names of the modules to be installed.
void	setReplacer(java.util.Map<java.lang.String,java.lang.String> map) Sets the replacer.
void	setServerName(java.lang.String name) Sets the OpenCms server name.
void	setWorkplaceSite(java.lang.String newSite) Sets the OpenCms workplace 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.
java.util.List<java.lang.String>	sortModules(java.util.Collection<CmsModule> modules) Sorts the modules for display.
boolean	validateJdbc() Checks the jdbc driver.

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

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

字段详细资料

AS400_PROVIDER

public static final java.lang.String AS400_PROVIDER

DB provider constant for as400.

另请参阅:

常量字段值

COMPONENTS_PROPERTIES

public static final java.lang.String COMPONENTS_PROPERTIES

The name of the components properties file.

另请参阅:

常量字段值

DB2_PROVIDER

public static final java.lang.String DB2_PROVIDER

DB provider constant for db2.

另请参阅:

常量字段值

DRIVER_TYPE_JPA

public static final byte DRIVER_TYPE_JPA

jpa type constant.

另请参阅:

常量字段值

DRIVER_TYPE_SQL

public static final byte DRIVER_TYPE_SQL

jpa type constant.

另请参阅:

常量字段值

FOLDER_BACKUP

public static final java.lang.String FOLDER_BACKUP

Folder constant name.

FOLDER_DATABASE

public static final java.lang.String FOLDER_DATABASE

Folder constant name.

FOLDER_LIB

public static final java.lang.String FOLDER_LIB

Folder constant name.

FOLDER_SETUP

public static final java.lang.String FOLDER_SETUP

Folder constant name.

GENERIC_PROVIDER

public static final java.lang.String GENERIC_PROVIDER

DB provider constant.

另请参阅:

常量字段值

HSQLDB_PROVIDER

public static final java.lang.String HSQLDB_PROVIDER

DB provider constant for hsqldb.

另请参阅:

常量字段值

HTML_MESSAGE_FILE

public static final java.lang.String HTML_MESSAGE_FILE

Name of the property file containing HTML fragments for setup wizard and error dialog.

另请参阅:

常量字段值

JPA_FACTOTY

public static final java.lang.String JPA_FACTOTY

The jpa CmsDbContextFactory for the opencms-system.xml node: runtimeclasses -> runtimeinfo.

另请参阅:

常量字段值

JPA_PROVIDER

public static final java.lang.String JPA_PROVIDER

DB provider constant for jpa.

另请参阅:

常量字段值

MAXDB_PROVIDER

public static final java.lang.String MAXDB_PROVIDER

DB provider constant for maxdb.

另请参阅:

常量字段值

MSSQL_PROVIDER

public static final java.lang.String MSSQL_PROVIDER

DB provider constant for mssql.

另请参阅:

常量字段值

MYSQL_PROVIDER

public static final java.lang.String MYSQL_PROVIDER

DB provider constant for mysql.

另请参阅:

常量字段值

ORACLE_PROVIDER

public static final java.lang.String ORACLE_PROVIDER

DB provider constant for oracle.

另请参阅:

常量字段值

POSTGRESQL_PROVIDER

public static final java.lang.String POSTGRESQL_PROVIDER

DB provider constant for postgresql.

另请参阅:

常量字段值

DEFAULT_POSITION

protected static final int DEFAULT_POSITION

The default component position, is missing.

另请参阅:

常量字段值

PROPKEY_CHECKED

protected static final java.lang.String PROPKEY_CHECKED

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_COMPONENT

protected static final java.lang.String PROPKEY_COMPONENT

Properties file key constant prefix.

另请参阅:

常量字段值

PROPKEY_COMPONENTS

protected static final java.lang.String PROPKEY_COMPONENTS

Properties file key constant.

另请参阅:

常量字段值

PROPKEY_DEPENDENCIES

protected static final java.lang.String PROPKEY_DEPENDENCIES

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_DESCRIPTION

protected static final java.lang.String PROPKEY_DESCRIPTION

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_JPA_SUPPORTED

protected static final java.lang.String PROPKEY_JPA_SUPPORTED

True if OpenCms supports a generic JPA driver implementation.

另请参阅:

常量字段值

PROPKEY_MODULES

protected static final java.lang.String PROPKEY_MODULES

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_NAME

protected static final java.lang.String PROPKEY_NAME

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_POSITION

protected static final java.lang.String PROPKEY_POSITION

Properties file key constant post fix.

另请参阅:

常量字段值

PROPKEY_SQL_SUPPORTED

protected static final java.lang.String PROPKEY_SQL_SUPPORTED

True if OpenCms supports a native SQL driver implementation.

另请参阅:

常量字段值

m_availableModules

protected java.util.Map<java.lang.String,CmsModule> m_availableModules

A map with all available modules.

m_cms

protected CmsObject m_cms

A CmsObject to execute shell commands.

m_installModules

protected java.util.List<java.lang.String> m_installModules

A list with the package names of the modules to be installed .

m_logFile

protected java.lang.String m_logFile

Location for log file.

m_logsFolder

protected java.lang.String m_logsFolder

Location for logs relative to the webapp folder.

m_moduleDependencies

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> m_moduleDependencies

A map with lists of dependent module package names keyed by module package names.

m_moduleFilenames

protected java.util.Map<java.lang.String,java.lang.String> m_moduleFilenames

A map with all available modules filenames.

m_modulesFolder

protected java.lang.String m_modulesFolder

Location for module archives relative to the webapp folder.

m_newLoggingOffset

protected int m_newLoggingOffset

The new logging offset in the workplace import thread.

m_oldLoggingOffset

protected int m_oldLoggingOffset

The lod logging offset in the workplace import thread.

m_webAppRfsPath

protected java.lang.String m_webAppRfsPath

The absolute path to the home directory of the OpenCms webapp.

构造器详细资料

CmsSetupBean

public CmsSetupBean()

Default constructor.

方法详细资料

backupConfiguration

public void backupConfiguration(java.lang.String filename,
                       java.lang.String originalFilename)

Restores the opencms.xml either to or from a backup file, depending whether the setup wizard is executed the first time (the backup does not exist) or not (the backup exists).

参数:

filename - something like e.g. "opencms.xml"

originalFilename - the configurations real file name, e.g. "opencms.xml.ori"

buildDepsForAllComponents

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> buildDepsForAllComponents()

Returns a map of dependencies.

The component dependencies are get from the setup and module components.properties files found.

返回:

a Map of component ids as keys and a list of dependency names as values

checkEthernetAddress

public void checkEthernetAddress()

Checks the ethernet address value and generates a dummy address, if necessary.

*

clearCache

public void clearCache()

Clears the cache.

copyFile

public void copyFile(java.lang.String source,
            java.lang.String target)

Copies a given file.

参数:

source - the source file

target - the destination file

displayError

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

Returns html code to display an error.

参数:

pathPrefix - to adjust the path

返回:

html code

displayErrors

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

Returns html code to display the errors occurred.

参数:

pathPrefix - to adjust the path

返回:

html code

getAvailableModules

public java.util.Map<java.lang.String,CmsModule> getAvailableModules()

Returns a map with all available modules.

The map contains maps keyed by module package names. Each of these maps contains various information about the module such as the module name, version, description, and a list of it's dependencies. You should refer to the source code of this method to understand the data structure of the map returned by this method!

返回:

a map with all available modules

getComponents

public CmsIdentifiableObjectContainer<CmsSetupComponent> getComponents()

Returns the components.

返回:

the components

getConfigRfsPath

public java.lang.String getConfigRfsPath()

Returns the "config" path in the OpenCms web application.

返回:

the config path

getDatabase

public java.lang.String getDatabase()

Returns the key of the selected database server (e.g. "mysql", "generic" or "oracle").

返回:

the key of the selected database server (e.g. "mysql", "generic" or "oracle")

getDatabaseConfigPage

public java.lang.String getDatabaseConfigPage(java.lang.String key)

Returns the URI of a database config page (in step 3) for a specified database key.

参数:

key - the database key (e.g. "mysql", "generic" or "oracle")

返回:

the URI of a database config page

getDatabaseLibs

public java.util.List<java.lang.String> getDatabaseLibs(java.lang.String databaseKey)

Returns a list of needed jar filenames for a database server setup specified by a database key (e.g. "mysql", "generic" or "oracle").

参数:

databaseKey - a database key (e.g. "mysql", "generic" or "oracle")

返回:

a list of needed jar filenames

getDatabaseName

public java.lang.String getDatabaseName(java.lang.String databaseKey)

Returns the clear text name for a database server setup specified by a database key (e.g. "mysql", "generic" or "oracle").

参数:

databaseKey - a database key (e.g. "mysql", "generic" or "oracle")

返回:

the clear text name for a database server setup

getDatabaseProperties

public java.util.Map<java.lang.String,java.util.Properties> getDatabaseProperties()

Returns a map with the database properties of *all* available database configurations keyed by their database keys (e.g. "mysql", "generic" or "oracle").

返回:

a map with the database properties of *all* available database configurations

getDatabases

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

Returns a list with they keys (e.g. "mysql", "generic" or "oracle") of all available database server setups found in "/setup/database/".

返回:

a list with they keys (e.g. "mysql", "generic" or "oracle") of all available database server setups

getDb

public java.lang.String getDb()

Returns the database name.

返回:

the database name

getDbConStrParams

public java.lang.String getDbConStrParams()

Returns the JDBC connect URL parameters.

返回:

the JDBC connect URL parameters

getDbCreateConStr

public java.lang.String getDbCreateConStr()

Returns the database create statement.

返回:

the database create statement

getDbCreatePwd

public java.lang.String getDbCreatePwd()

Returns the password used for database creation.

返回:

the password used for database creation

getDbCreateUser

public java.lang.String getDbCreateUser()

Returns the database user that is used to connect to the database.

返回:

the database user

getDbDriver

public java.lang.String getDbDriver()

Returns the database driver belonging to the database from the default configuration.

返回:

name of the database driver

getDbProperty

public java.lang.String getDbProperty(java.lang.String key)

Returns the value for a given key from the database properties.

参数:

key - the property key

返回:

the string value for a given key

getDbTestQuery

public java.lang.String getDbTestQuery()

Returns the validation query belonging to the database from the default configuration .

返回:

query used to validate connections

getDbWorkConStr

public java.lang.String getDbWorkConStr()

Returns a connection string.

返回:

the connection string used by the OpenCms core

getDbWorkPwd

public java.lang.String getDbWorkPwd()

Returns the password of the database from the properties .

返回:

the password for the OpenCms database user

getDbWorkUser

public java.lang.String getDbWorkUser()

Returns the user of the database from the properties.

返回:

the database user used by the opencms core

getDefaultContentEncoding

public java.lang.String getDefaultContentEncoding()

Returns the default content encoding.

返回:

String

getDefaultWebApplication

public java.lang.String getDefaultWebApplication()

Returns the name of the default web application, configured in web.xml.

By default this is "ROOT".

返回:

the name of the default web application, configured in web.xml

getDisplayForModule

public java.lang.String getDisplayForModule(CmsModule module)

Returns the display string for a given module.

参数:

module - a module

返回:

the display string for the given module

getErrors

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

Returns the error messages.

返回:

a vector of error messages

getEthernetAddress

public java.lang.String getEthernetAddress()

Returns the mac ethernet address.

返回:

the mac ethernet addess

getFullDatabaseKey

public java.lang.String getFullDatabaseKey()

Returns the fullDatabaseKey.

返回:

the fullDatabaseKey

getHtmlForDbSelection

public java.lang.String getHtmlForDbSelection()

Generates the HTML code for the drop down for db selection.

返回:

the generated HTML

getHtmlHelpIcon

public java.lang.String getHtmlHelpIcon(java.lang.String id,
                               java.lang.String pathPrefix)

Returns a help image icon tag to display a help text in the setup wizard.

参数:

id - the id of the desired help div

pathPrefix - the path prefix to the image

返回:

the HTML part for the help icon or an empty String, if the part was not found

getHtmlPart

public java.lang.String getHtmlPart(java.lang.String part)

Returns the specified HTML part of the HTML property file to create the output.

参数:

part - the name of the desired part

返回:

the HTML part or an empty String, if the part was not found

getHtmlPart

public java.lang.String getHtmlPart(java.lang.String part,
                           java.lang.String replaceString)

Returns the specified HTML part of the HTML property file to create the output.

参数:

part - the name of the desired part

replaceString - String which is inserted in the found HTML part at the location of "$replace$"

返回:

the HTML part or an empty String, if the part was not found

getLibFolder

public java.lang.String getLibFolder()

Returns the path to the /WEB-INF/lib folder.

返回:

the path to the /WEB-INF/lib folder

getLogName

public java.lang.String getLogName()

Returns the name of the log file.

返回:

the name of the log file

getModuleDependencies

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getModuleDependencies()

Returns a map with lists of dependent module package names keyed by module package names.

返回:

a map with lists of dependent module package names keyed by module package names

getModuleFolder

public java.lang.String getModuleFolder()

Returns the absolute path to the module root folder.

返回:

the absolute path to the module root folder

getModulesToInstall

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

Returns A list with the package names of the modules to be installed.

返回:

A list with the package names of the modules to be installed

getPool

public java.lang.String getPool()

Gets the default pool.

返回:

name of the default pool

getProperties

public CmsParameterConfiguration getProperties()

Returns the parameter configuration.

返回:

the parameter configuration

getReplacer

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

Returns the replacer.

返回:

the replacer

getServerName

public java.lang.String getServerName()

Return the OpenCms server name.

返回:

the OpenCms server name

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Returns the initial servlet configuration.

返回:

the initial servlet configuration

getServletMapping

public java.lang.String getServletMapping()

Returns the OpenCms servlet mapping, configured in web.xml.

By default this is "/opencms/*".

返回:

the OpenCms servlet mapping, configured in web.xml

getSortedDatabases

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

Returns a sorted list with they keys (e.g. "mysql", "generic" or "oracle") of all available database server setups found in "/setup/database/" sorted by their ranking property.

返回:

a sorted list with they keys (e.g. "mysql", "generic" or "oracle") of all available database server setups

getWebAppRfsPath

public java.lang.String getWebAppRfsPath()

Returns the absolute path to the OpenCms home directory.

返回:

the path to the OpenCms home directory

getWizardEnabled

public boolean getWizardEnabled()

Checks if the setup wizard is enabled.

返回:

true if the setup wizard is enables, false otherwise

getWorkplaceImportThread

public CmsSetupWorkplaceImportThread getWorkplaceImportThread()

Returns the workplace import thread.

返回:

the workplace import thread

getWorkplaceSite

public java.lang.String getWorkplaceSite()

Return the OpenCms workplace site.

返回:

the OpenCms workplace site

getXmlHelper

public CmsSetupXmlHelper getXmlHelper()

Returns the xml Helper object.

返回:

the xml Helper object

htmlComponents

public java.lang.String htmlComponents()

Returns the html code for component selection.

返回:

html code

htmlModuleHelpDescriptions

public java.lang.String htmlModuleHelpDescriptions()

Returns html code for the module descriptions in help ballons.

返回:

html code

htmlModules

public java.lang.String htmlModules()

Returns html for displaying a module selection box.

返回:

html code

importModulesFromSetupBean

public void importModulesFromSetupBean()
                                throws java.lang.Exception

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

This method is invoked as a shell command.

抛出:

java.lang.Exception - if something goes wrong

init

public void init(javax.servlet.jsp.PageContext pageContext)

Creates a new instance of the setup Bean from a JSP page.

参数:

pageContext - the JSP's page context

init

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

Creates a new instance of the setup Bean.

参数:

webAppRfsPath - path to the OpenCms web application

servletMapping - the OpenCms servlet mapping

defaultWebApplication - the name of the default web application

initHtmlParts

public void initHtmlParts()

This method reads the properties from the htmlmsg.property file and sets the HTML part properties with the matching values.

initShellCmsObject

public void initShellCmsObject(CmsObject cms,
                      CmsShell shell)

从接口复制的说明: I_CmsShellCommands

Provides access to the shell CmsObject and the shell itself.

指定者:

initShellCmsObject 在接口中 I_CmsShellCommands

参数:

cms - the shell CmsObject

shell - the CmsShell

另请参阅:

I_CmsShellCommands.initShellCmsObject(org.opencms.file.CmsObject, org.opencms.main.CmsShell)

isAutoMode

public boolean isAutoMode()

Returns the autoMode.

返回:

the autoMode

isChecked

public java.lang.String isChecked(java.lang.String value1,
                         java.lang.String value2)

Over simplistic helper to compare two strings to check radio buttons.

参数:

value1 - the first value

value2 - the second value

返回:

"checked" if both values are equal, the empty String "" otherwise

isInitialized

public boolean isInitialized()

Returns true if this setup bean is correctly initialized.

返回:

true if this setup bean is correctly initialized

isJpaSupported

public boolean isJpaSupported(java.lang.String dbKey)

Returns true if jpa is supported for the given dbKey.

参数:

dbKey - the database key to check the jpa support for

返回:

true if jpa is supported for the given dbKey

isSqlSupported

public boolean isSqlSupported(java.lang.String dbKey)

Returns true if sql is supported for the given dbKey.

参数:

dbKey - the database key to check the sql support for

返回:

true if sql is supported for the given dbKey

jsComponentDependencies

public java.lang.String jsComponentDependencies()

Returns js code with array definition for the available component dependencies.

返回:

js code

jsComponentModules

public java.lang.String jsComponentModules()

Returns js code with array definition for the component modules.

返回:

js code

jsComponentNames

public java.lang.String jsComponentNames()

Returns js code with array definition for the available components names.

返回:

js code

jsModuleDependencies

public java.lang.String jsModuleDependencies()

Returns js code with array definition for the available module dependencies.

返回:

js code

jsModuleNames

public java.lang.String jsModuleNames()

Returns js code with array definition for the available module names.

返回:

js code

lockWizard

public void lockWizard()

Locks (i.e. disables) the setup wizard.

prepareStep10

public void prepareStep10()

Prepares step 10 of the setup wizard.

prepareStep8

public boolean prepareStep8()

Prepares step 8 of the setup wizard.

返回:

true if the workplace should be imported

prepareStep8b

public void prepareStep8b()

Prepares step 8b of the setup wizard.

prepareStep8bOutput

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

Generates the output for step 8b of the setup wizard.

参数:

out - the JSP print stream

抛出:

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

saveProperties

public void saveProperties(CmsParameterConfiguration properties,
                  java.lang.String file,
                  boolean backup)

Saves properties to specified file.

参数:

properties - the properties to be saved

file - the file to save the properties to

backup - if true, create a backupfile

saveProperties

public void saveProperties(CmsParameterConfiguration properties,
                  java.lang.String file,
                  boolean backup,
                  java.util.Set<java.lang.String> forceWrite)

Saves properties to specified file.

参数:

properties - the properties to be saved

file - the file to save the properties to

backup - if true, create a backupfile

forceWrite - the keys for the properties which should always be written, even if they don't exist in the configuration file

setAutoMode

public void setAutoMode(boolean autoMode)

Sets the autoMode.

参数:

autoMode - the autoMode to set

setDatabase

public void setDatabase(java.lang.String databaseKey)

Sets the database drivers to the given value.

参数:

databaseKey - the key of the selected database server (e.g. "mysql", "generic" or "oracle")

setDb

public void setDb(java.lang.String db)

Sets the database name.

参数:

db - the database name to set

setDbConStrParams

public void setDbConStrParams(java.lang.String value)

Sets the JDBC connect URL parameters.

参数:

value - the JDBC connect URL parameters

setDbCreateConStr

public void setDbCreateConStr(java.lang.String dbCreateConStr)

Sets the database create statement.

参数:

dbCreateConStr - the database create statement

setDbCreatePwd

public void setDbCreatePwd(java.lang.String dbCreatePwd)

Sets the password used for the initial OpenCms database creation.

This password will not be stored permanently, but used only in the setup wizard.

参数:

dbCreatePwd - the password used for the initial OpenCms database creation

setDbCreateUser

public void setDbCreateUser(java.lang.String dbCreateUser)

Set the database user that is used to connect to the database.

参数:

dbCreateUser - the user to set

setDbDriver

public void setDbDriver(java.lang.String driver)

Sets the database driver belonging to the database.

参数:

driver - name of the opencms driver

setDbParamaters

public boolean setDbParamaters(javax.servlet.http.HttpServletRequest request,
                      java.lang.String provider)

Sets the needed database parameters.

参数:

request - the http request

provider - the db provider

返回:

true if already submitted

setDbParamaters

public boolean setDbParamaters(java.util.Map<java.lang.String,java.lang.String[]> request,
                      java.lang.String provider,
                      java.lang.String contextPath,
                      javax.servlet.http.HttpSession session)

Sets the needed database parameters.

参数:

request - the http request

provider - the db provider

contextPath - the context path to use

session - the session to use or null if running outside a servlet container

返回:

true if already submitted

setDbProperty

public void setDbProperty(java.lang.String key,
                 java.lang.String value)

This method sets the value for a given key in the database properties.

参数:

key - The key of the property

value - The value of the property

setDbWorkConStr

public void setDbWorkConStr(java.lang.String dbWorkConStr)

Sets the connection string to the database to the given value.

参数:

dbWorkConStr - the connection string used by the OpenCms core

setDbWorkPwd

public void setDbWorkPwd(java.lang.String dbWorkPwd)

Sets the password of the database to the given value.

参数:

dbWorkPwd - the password for the OpenCms database user

setDbWorkUser

public void setDbWorkUser(java.lang.String dbWorkUser)

Sets the user of the database to the given value.

参数:

dbWorkUser - the database user used by the opencms core

setDriverType

public void setDriverType(java.lang.String type)

Sets the driver type.

参数:

type - the type to set

setEthernetAddress

public void setEthernetAddress(java.lang.String ethernetAddress)

Set the mac ethernet address, required for UUID generation.

参数:

ethernetAddress - the mac addess to set

setFullDatabaseKey

public void setFullDatabaseKey(java.lang.String fullDatabaseKey)

Sets the fullDatabaseKey.

参数:

fullDatabaseKey - the fullDatabaseKey to set

setInstallModules

public void setInstallModules(java.lang.String value)

Sets the list with the package names of the modules to be installed.

参数:

value - a string with the package names of the modules to be installed delimited by the pipe symbol "|"

setReplacer

public void setReplacer(java.util.Map<java.lang.String,java.lang.String> map)

Sets the replacer.

参数:

map - the replacer to set

setServerName

public void setServerName(java.lang.String name)

Sets the OpenCms server name.

参数:

name - the OpenCms server name

setWorkplaceSite

public void setWorkplaceSite(java.lang.String newSite)

Sets the OpenCms workplace site.

参数:

newSite - the OpenCms workplace site

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

另请参阅:

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

另请参阅:

I_CmsShellCommands.shellStart()

sortModules

public java.util.List<java.lang.String> sortModules(java.util.Collection<CmsModule> modules)

Sorts the modules for display.

参数:

modules - the list of CmsModule objects

返回:

a sorted list of module names

validateJdbc

public boolean validateJdbc()

Checks the jdbc driver.

返回:

true if at least one of the recommended drivers is found

addComponentsFromPath

protected void addComponentsFromPath(java.lang.String fileName)
                              throws CmsConfigurationException

Reads all components from the given location, a folder or a zip file.

参数:

fileName - the location to read the components from

抛出:

CmsConfigurationException - if something goes wrong

getComponentModules

protected java.lang.String getComponentModules(java.util.List<java.lang.String> componentIds)

Returns a pipe separated list of module names for the given list of components.

参数:

componentIds - the list of component IDs to get the modules for

返回:

a pipe separated list of module names for the given list of components

getComponentsProperties

protected CmsParameterConfiguration getComponentsProperties(java.lang.String location)
                                                     throws java.io.FileNotFoundException,
                                                            CmsConfigurationException

Reads all properties from the components.properties file at the given location, a folder or a zip file.

参数:

location - the location to read the properties from

返回:

the read properties

抛出:

java.io.FileNotFoundException - if the properties file could not be found

CmsConfigurationException - if the something else goes wrong

getExtProperty

protected java.lang.String getExtProperty(java.lang.String key)

Returns the value for a given key from the extended properties.

参数:

key - the property key

返回:

the string value for a given key

htmlComponent

protected java.lang.String htmlComponent(CmsSetupComponent component)

Returns html for the given component to fill the selection list.

参数:

component - the component to generate the code for

返回:

html code

htmlModule

protected java.lang.String htmlModule(CmsModule module,
                          int pos)

Returns html for the given module to fill the selection list.

参数:

module - the module to generate the code for

pos - the position in the list

返回:

html code

importModuleFromDefault

protected void importModuleFromDefault(java.lang.String importFile)
                                throws java.lang.Exception

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

参数:

importFile - the name of the import module located in the default module directory

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

CmsImportExportManager.importData(CmsObject, org.opencms.report.I_CmsReport, CmsImportParameters)

initializeComponents

protected void initializeComponents(java.util.Collection<java.lang.String> modules)

Initializes and validates the read components.

参数:

modules - a modifiable list of the modules to be imported

isImportRunning

protected boolean isImportRunning()

Returns true if the import thread is currently running.

返回:

true if the import thread is currently running

readDatabaseConfig

protected void readDatabaseConfig()

Stores the properties of all available database configurations in a map keyed by their database key names (e.g. "mysql", "generic" or "oracle").

setExtProperty

protected void setExtProperty(java.lang.String key,
                  java.lang.String value)

This method sets the value for a given key in the extended properties.

参数:

key - The key of the property

value - The value of the property