|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--com.opencms.boot.CmsSetup
Bean with get / set methods for all properties stored in the 'opencms.properties' file. The path to the opencms home folder and its config folder can also be stored an retrieved as well as a vector containing possible error messages thrown by the setup.
| Constructor Summary | |
CmsSetup()
|
|
| Method Summary | |
boolean |
checkProperties()
This method checks the validity of the given properties and adds unset properties if possible |
String |
getAvgCacheBytes()
|
String |
getBasePath()
Returns the absolute path to the OpenCms home directory |
String |
getCacheGroup()
Returns the cache value for group |
String |
getCacheOfflineEnabled()
|
String |
getCacheOnlineProject()
Returns the cache value for online project |
String |
getCacheProject()
Returns the cache value for project |
String |
getCacheProperty()
Returns the cache value for property |
String |
getCachePropertyDef()
Returns the cache value for property def. |
String |
getCachePropertyDefVector()
Returns the cache value for property def. vector |
String |
getCacheResource()
Returns the cache value for resource |
String |
getCacheSubres()
Returns the cache value for subres |
String |
getCacheUser()
Returns the cache value for user |
String |
getCacheUserGroups()
Returns the cache value for usergroups |
String |
getConfigFolder()
Returns the path to the opencms config folder |
String |
getDb()
|
String |
getDbCreateConStr()
|
String |
getDbCreatePwd()
|
String |
getDbCreateUser()
|
String |
getDbDefaultTablespace()
Get the default tablespace when creating a new oracle user |
String |
getDbDriver()
Returns the database driver belonging to the resource broker |
String |
getDbProperty(String key)
Returns the value for a given key from the database properties. |
Properties |
getDbSetupProps()
|
String |
getDbTemporaryTablespace()
Get the temporary tablespace when creating a new oracle user |
String |
getDbWorkConStr()
Returns a conenction string |
String |
getDbWorkPwd()
Returns the password of the database from the properties |
String |
getDbWorkUser()
Returns the user of the database from the properties |
String |
getDefaultContentEncoding()
Returns the defaultContentEncoding. |
String |
getDirectoryIndexFiles()
|
String |
getDirectoryTranslationEnabled()
|
String |
getElementCache()
|
String |
getElementCacheElements()
|
String |
getElementCacheURI()
|
String |
getElementCacheVariants()
|
Vector |
getErrors()
Returns the error messages |
String |
getEthernetAddress()
Get the fictional mac ethernet address |
String |
getExportPoint(int nr)
Returns the value for exportpoint nr |
String |
getExportPointPath(int nr)
Returns the value for exportpoint path nr |
String |
getExtProperty(String key)
Returns the value for a given key from the extended properties. |
String |
getFileMaxUploadSize()
Get the maximum file upload size |
String |
getFilenameTranslationEnabled()
|
String |
getFlexCacheEnabled()
|
String |
getForceGc()
|
String |
getHistoryEnabled()
Returns the value for deleting published project parameters |
String |
getHttpStreaming()
Returns the value for http streaming |
String |
getIncreaseRate()
Returns the increase rate |
String |
getLogDateFormat()
Returns the value for the log date format |
String |
getLogFile()
Returns the value for the log file |
String |
getLogging()
Returns the value for opencms logging |
String |
getLoggingChannelModules_critical()
Indicates if channel modules_critical is enabled in the log messages |
String |
getLoggingChannelModules_debug()
Indicates if channel modules_debug is enabled in the log messages |
String |
getLoggingChannelModules_info()
Indicates if channel modules_info is enabled in the log messages |
String |
getLoggingChannelName()
Indicates if channel names are displayed in the log messages |
String |
getLoggingChannelOpencms_cache()
Indicates if channel opencms_cache is enabled in the log messages |
String |
getLoggingChannelOpencms_critical()
Indicates if channel opencms_critical is enabled in the log messages |
String |
getLoggingChannelOpencms_debug()
Indicates if channel opencms_debug is enabled in the log messages |
String |
getLoggingChannelOpencms_elementcache()
Indicates if channel opencms_elementcache is enabled in the log messages |
String |
getLoggingChannelOpencms_info()
Indicates if channel opencms_info is enabled in the log messages |
String |
getLoggingChannelOpencms_init()
Indicates if channel opencms_init is enabled in the log messages |
String |
getLoggingChannelOpencms_pool()
Indicates if channel opencms_pool is enabled in the log messages |
String |
getLoggingChannelOpencms_streaming()
Indicates if channel opencms_streaming is enabled in the log messages |
String |
getLoggingFlexCache()
|
String |
getLoggingFlexLoader()
|
String |
getLogMemory()
Indicates if memory state is displayed in the log messages |
String |
getLogQueueMaxAge()
Returns the value for the log queue maxage |
String |
getLogQueueMaxSize()
Returns the value for the log queue maxsize |
String |
getLogTimestamp()
Indicates if timestamps are displayed in the opencms logfile |
String |
getMaxAge()
Returns the max. age |
String |
getMaxCacheBytes()
|
String |
getMaxConn()
Returns the max. connections |
String |
getMaxEntries()
|
String |
getMaxEntryBytes()
|
String |
getMaxKeys()
|
String |
getMinConn()
Returns the min. connections |
source.org.apache.java.util.ExtendedProperties |
getProperties()
Returns the extended properties |
String |
getRedirect(int nr)
Returns the value for redirect nr |
String |
getRedirectLocation(int nr)
Returns the value for redirect location nr |
Hashtable |
getReplacer()
|
String |
getResourceBroker()
Gets the resource broker |
Vector |
getResourceBrokerNames()
Returns "nice display names" for all resource Brokers found in 'dbsetup.properties' |
Vector |
getResourceBrokers()
Returns all resource Brokers found in 'dbsetup.properties' |
String |
getSessionFailover()
Returns the value for session failover |
boolean |
getSetupType()
Returns the value of the setup type: standard (false), advanced (true) |
String |
getStaticExport()
|
String |
getStaticExportPath()
|
String |
getTimeout()
Returns the timeout value |
String |
getUrlPrefixExport()
|
String |
getUrlPrefixHttp()
|
String |
getUrlPrefixHttps()
|
String |
getUrlPrefixServername()
|
boolean |
getWizardEnabled()
|
void |
initProperties(String props)
This method reads the properties from the opencms.property file and sets the CmsSetup properties with the matching values. |
String |
isChecked(String value1,
String value2)
Over simplistic helper to compare two strings to check radio buttons. |
void |
lockWizard()
|
void |
setAvgCacheBytes(String value)
|
void |
setBasePath(String basePath)
Sets the path to the OpenCms home directory |
void |
setCacheGroup(String cacheGroup)
Sets the cache value for group to the given value |
void |
setCacheOfflineEnabled(String value)
|
void |
setCacheOnlineProject(String cacheOnlineProject)
Sets the cache value for online project to the given value |
void |
setCacheProject(String cacheProject)
Sets the cache value for project to the given value |
void |
setCacheProperty(String cacheProperty)
Sets the cache value for property to the given value |
void |
setCachePropertyDef(String cachePropertyDef)
Sets the cache value for property def. to the given value |
void |
setCachePropertyDefVector(String cachePropertyDefVector)
Sets the cache value for property def. vector to the given value |
void |
setCacheResource(String cacheResource)
Sets the cache value for resource to the given value |
void |
setCacheSubres(String cacheSubres)
Sets the cache value for subres to the given value |
void |
setCacheUser(String cacheUser)
Sets the cache value for user to the given value |
void |
setCacheUserGroups(String cacheUserGroups)
Sets the cache value for usergroups to the given value |
void |
setDb(String db)
|
void |
setDbCreateConStr(String dbCreateConStr)
|
void |
setDbCreatePwd(String dbCreatePwd)
|
void |
setDbCreateUser(String dbCreateUser)
|
void |
setDbDefaultTablespace(String dbDefaultTablespace)
Set the default tablespace when creating a new oracle user |
void |
setDbProperty(String key,
String value)
This method sets the value for a given key in the database properties. |
void |
setDbTemporaryTablespace(String dbTemporaryTablespace)
Set the temporary tablespace when creating a new oracle user |
void |
setDbWorkConStr(String dbWorkConStr)
Sets the connection string to the database to the given value |
void |
setDbWorkPwd(String dbWorkPwd)
Sets the password of the database to the given value |
void |
setDbWorkUser(String dbWorkUser)
Sets the user of the database to the given value |
void |
setDefaultContentEncoding(String defaultContentEncoding)
Sets the defaultContentEncoding. |
void |
setDirectoryIndexFiles(String value)
|
void |
setDirectoryTranslationEnabled(String value)
|
void |
setElementCache(String elementCache)
|
void |
setElementCacheElements(String elementCacheElements)
|
void |
setElementCacheURI(String elementCacheURI)
|
void |
setElementCacheVariants(String elementCacheVariants)
|
static void |
setErrors(String error)
Adds a new error message to the vector |
void |
setEthernetAddress(String ethernetAddress)
Set the fictional mac ethernet address |
void |
setExportPoint(String exportPoint,
int nr)
Sets the value for exportpoint nr to the given value |
void |
setExportPointPath(String exportPointPath,
int nr)
Sets the value for exportpoint path nr to the given value |
void |
setExtProperty(String key,
String value)
This method sets the value for a given key in the extended properties. |
void |
setFileMaxUploadSize(String size)
Set the maximum file upload size |
void |
setFilenameTranslationEnabled(String value)
|
void |
setFlexCacheEnabled(String value)
|
void |
setForceGc(String value)
|
void |
setHistoryEnabled(String historyEnabled)
Sets the value for deleting published project parameters to the given value |
void |
setHttpStreaming(String httpStreaming)
Sets the value for http streaming to the given value |
void |
setIncreaseRate(String increaseRate)
Sets the increase rate to the given value |
void |
setLogDateFormat(String logDateFormat)
Sets the value for the log date format to the given value |
void |
setLogFile(String logFile)
Sets the value for the log file to the given value |
void |
setLogging(String logging)
Sets the value for opencms logging to the given value |
void |
setLoggingChannelModules_critical(String loggingChannelModules_critical)
Enables/Disables channel modules_critical in the log messages |
void |
setLoggingChannelModules_debug(String loggingChannelModules_debug)
Enables/Disables channel modules_debug in the log messages |
void |
setLoggingChannelModules_info(String loggingChannelModules_info)
Enables/Disables channel modules_info in the log messages |
void |
setLoggingChannelName(String loggingChannelName)
Enables/Disables channel names in the log messages |
void |
setLoggingChannelOpencms_cache(String loggingChannelOpencms_cache)
Enables/Disables channel opencms_cache in the log messages |
void |
setLoggingChannelOpencms_critical(String loggingChannelOpencms_critical)
Enables/Disables channel opencms_critical in the log messages |
void |
setLoggingChannelOpencms_debug(String loggingChannelOpencms_debug)
Enables/Disables channel opencms_debug in the log messages |
void |
setLoggingChannelOpencms_elementcache(String loggingChannelOpencms_elementcache)
Enables/Disables channel opencms_elementcache in the log messages |
void |
setLoggingChannelOpencms_info(String loggingChannelOpencms_info)
Enables/Disables channel opencms_info in the log messages |
void |
setLoggingChannelOpencms_init(String loggingChannelOpencms_init)
Enables/Disables channel opencms_init in the log messages |
void |
setLoggingChannelOpencms_pool(String loggingChannelOpencms_pool)
Enables/Disables channel opencms_pool in the log messages |
void |
setLoggingChannelOpencms_streaming(String loggingChannelOpencms_streaming)
Enables/Disables channel opencms_streaming in the log messages |
void |
setLoggingFlexCache(String value)
|
void |
setLoggingFlexLoader(String value)
|
void |
setLogMemory(String logMemory)
Enables/Disables memory state in the log messages |
void |
setLogQueueMaxAge(String logQueueMaxAge)
Sets the value for the log queue maxage to the given value |
void |
setLogQueueMaxSize(String logQueueMaxSize)
Sets the value for the log queue maxsize to the given value |
void |
setLogTimestamp(String logTimestamp)
Enables/Disables timestamps in the opencms logfile |
void |
setMaxAge(String maxAge)
Sets the max. age to the given value |
void |
setMaxCacheBytes(String value)
|
void |
setMaxConn(String maxConn)
Sets the maximum connections to the given value |
void |
setMaxEntries(String value)
|
void |
setMaxEntryBytes(String value)
|
void |
setMaxKeys(String value)
|
void |
setMinConn(String minConn)
Sets the minimum connections to the given value |
void |
setRedirect(String redirect,
int nr)
Sets the value for redirect nr to the given value |
void |
setRedirectLocation(String redirectLocation,
int nr)
Sets the value for redirect location nr to the given value |
void |
setReplacer(Hashtable replacer)
|
void |
setResourceBroker(String resourceBroker)
Sets the resource broker to the given value |
void |
setSessionFailover(String sessionFailover)
Sets the value for session failover to the given value |
void |
setSetupType(boolean setupType)
Sets the setup type to the given value: standard (false), advanced (true) |
void |
setStaticExport(String staticExport)
|
void |
setStaticExportPath(String staticExportPath)
|
void |
setTimeout(String timeout)
Sets the timeout to the given value |
void |
setUrlPrefixExport(String urlPrefixExport)
|
void |
setUrlPrefixHttp(String urlPrefixHttp)
|
void |
setUrlPrefixHttps(String urlPrefixHttps)
|
void |
setUrlPrefixServername(String urlPrefixServername)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public CmsSetup()
| Method Detail |
public void initProperties(String props)
public boolean checkProperties()
public void setExtProperty(String key,
String value)
key - The key of the propertyvalue - The value of the propertypublic String getExtProperty(String key)
public void setDbProperty(String key,
String value)
key - The key of the propertyvalue - The value of the propertypublic String getDbProperty(String key)
public void setBasePath(String basePath)
public String getBasePath()
public void setSetupType(boolean setupType)
public boolean getSetupType()
public void setResourceBroker(String resourceBroker)
public String getResourceBroker()
public Vector getResourceBrokers()
public Vector getResourceBrokerNames()
public void setDbWorkConStr(String dbWorkConStr)
public void setDbWorkUser(String dbWorkUser)
public String getDbWorkUser()
public void setDbWorkPwd(String dbWorkPwd)
public String getDbWorkConStr()
public String getDbWorkPwd()
public source.org.apache.java.util.ExtendedProperties getProperties()
public static void setErrors(String error)
public Vector getErrors()
public String getConfigFolder()
public String getDbDriver()
public void setMinConn(String minConn)
public String getMinConn()
public void setMaxConn(String maxConn)
public String getMaxConn()
public void setIncreaseRate(String increaseRate)
public String getIncreaseRate()
public void setTimeout(String timeout)
public String getTimeout()
public void setMaxAge(String maxAge)
public String getMaxAge()
public void setCacheUser(String cacheUser)
public String getCacheUser()
public void setCacheGroup(String cacheGroup)
public String getCacheGroup()
public void setCacheUserGroups(String cacheUserGroups)
public String getCacheUserGroups()
public void setCacheProject(String cacheProject)
public String getCacheProject()
public void setCacheOnlineProject(String cacheOnlineProject)
public String getCacheOnlineProject()
public void setCacheResource(String cacheResource)
public String getCacheResource()
public void setCacheSubres(String cacheSubres)
public String getCacheSubres()
public void setCacheProperty(String cacheProperty)
public String getCacheProperty()
public void setCachePropertyDef(String cachePropertyDef)
public String getCachePropertyDef()
public void setCachePropertyDefVector(String cachePropertyDefVector)
public String getCachePropertyDefVector()
public void setSessionFailover(String sessionFailover)
public String getSessionFailover()
public void setHistoryEnabled(String historyEnabled)
public String getHistoryEnabled()
public void setHttpStreaming(String httpStreaming)
public String getHttpStreaming()
public void setExportPoint(String exportPoint,
int nr)
public String getExportPoint(int nr)
public void setExportPointPath(String exportPointPath,
int nr)
public String getExportPointPath(int nr)
public void setRedirect(String redirect,
int nr)
public String getRedirect(int nr)
public void setRedirectLocation(String redirectLocation,
int nr)
public String getRedirectLocation(int nr)
public void setLogging(String logging)
public String getLogging()
public void setLogFile(String logFile)
public String getLogFile()
public void setLogTimestamp(String logTimestamp)
public String getLogTimestamp()
public void setLogMemory(String logMemory)
public String getLogMemory()
public void setLogDateFormat(String logDateFormat)
public String getLogDateFormat()
public void setLogQueueMaxAge(String logQueueMaxAge)
public String getLogQueueMaxAge()
public void setLogQueueMaxSize(String logQueueMaxSize)
public String getLogQueueMaxSize()
public void setLoggingChannelName(String loggingChannelName)
public String getLoggingChannelName()
public void setLoggingChannelOpencms_init(String loggingChannelOpencms_init)
public String getLoggingChannelOpencms_init()
public void setLoggingChannelOpencms_debug(String loggingChannelOpencms_debug)
public String getLoggingChannelOpencms_debug()
public void setLoggingChannelOpencms_cache(String loggingChannelOpencms_cache)
public String getLoggingChannelOpencms_cache()
public void setLoggingChannelOpencms_info(String loggingChannelOpencms_info)
public String getLoggingChannelOpencms_info()
public void setLoggingChannelOpencms_pool(String loggingChannelOpencms_pool)
public String getLoggingChannelOpencms_pool()
public void setLoggingChannelOpencms_streaming(String loggingChannelOpencms_streaming)
public String getLoggingChannelOpencms_streaming()
public void setLoggingChannelOpencms_critical(String loggingChannelOpencms_critical)
public String getLoggingChannelOpencms_critical()
public void setLoggingChannelOpencms_elementcache(String loggingChannelOpencms_elementcache)
public String getLoggingChannelOpencms_elementcache()
public void setLoggingChannelModules_debug(String loggingChannelModules_debug)
public String getLoggingChannelModules_debug()
public void setLoggingChannelModules_info(String loggingChannelModules_info)
public String getLoggingChannelModules_info()
public void setLoggingChannelModules_critical(String loggingChannelModules_critical)
public String getLoggingChannelModules_critical()
public String getLoggingFlexCache()
public void setLoggingFlexCache(String value)
public String getLoggingFlexLoader()
public void setLoggingFlexLoader(String value)
public void setElementCache(String elementCache)
public String getElementCache()
public void setElementCacheURI(String elementCacheURI)
public String getElementCacheURI()
public void setElementCacheElements(String elementCacheElements)
public String getElementCacheElements()
public void setElementCacheVariants(String elementCacheVariants)
public String getElementCacheVariants()
public void setEthernetAddress(String ethernetAddress)
public String getEthernetAddress()
public void setFileMaxUploadSize(String size)
public String getFileMaxUploadSize()
public String getDbCreateConStr()
public void setDbCreateConStr(String dbCreateConStr)
public String getDbCreateUser()
public void setDbCreateUser(String dbCreateUser)
public String getDbCreatePwd()
public void setDbCreatePwd(String dbCreatePwd)
public void setDbDefaultTablespace(String dbDefaultTablespace)
public String getDbDefaultTablespace()
public void setDbTemporaryTablespace(String dbTemporaryTablespace)
public String getDbTemporaryTablespace()
public boolean getWizardEnabled()
public void lockWizard()
public Properties getDbSetupProps()
public String getDb()
public void setDb(String db)
public Hashtable getReplacer()
public void setReplacer(Hashtable replacer)
public String getStaticExport()
public void setStaticExport(String staticExport)
public String getStaticExportPath()
public void setStaticExportPath(String staticExportPath)
public String getUrlPrefixExport()
public void setUrlPrefixExport(String urlPrefixExport)
public String getUrlPrefixHttp()
public void setUrlPrefixHttp(String urlPrefixHttp)
public String getUrlPrefixHttps()
public void setUrlPrefixHttps(String urlPrefixHttps)
public String getUrlPrefixServername()
public void setUrlPrefixServername(String urlPrefixServername)
public void setFlexCacheEnabled(String value)
public String getFlexCacheEnabled()
public void setCacheOfflineEnabled(String value)
public String getCacheOfflineEnabled()
public void setForceGc(String value)
public String getForceGc()
public void setFilenameTranslationEnabled(String value)
public String getFilenameTranslationEnabled()
public void setDirectoryTranslationEnabled(String value)
public String getDirectoryTranslationEnabled()
public void setMaxCacheBytes(String value)
public String getMaxCacheBytes()
public void setAvgCacheBytes(String value)
public String getAvgCacheBytes()
public void setMaxEntryBytes(String value)
public String getMaxEntryBytes()
public void setMaxEntries(String value)
public String getMaxEntries()
public void setMaxKeys(String value)
public String getMaxKeys()
public void setDirectoryIndexFiles(String value)
public String getDirectoryIndexFiles()
public String isChecked(String value1,
String value2)
public String getDefaultContentEncoding()
public void setDefaultContentEncoding(String defaultContentEncoding)
defaultContentEncoding - The defaultContentEncoding to set
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||