Details
-
Type:
Task
-
Status:
Resolved
-
Priority:
Blocker
-
Resolution: Fixed
-
Affects Version/s: None
-
Fix Version/s: 1.0
-
Component/s: Release Notes
-
Labels:None
-
Responsible Team:Rice Team
Description
We need to generate a list of all of the configuration parameters in Rice so that we can include them in the documentation.
The easiest way to find all of these will be to trace these back to calls to org.kuali.rice.core.Config.
In particular, the following methods on that class:
getProperty(...)
getProperties()
getBooleanProperty(...)
getPropertiesWithPrefix(...)
Ideally, most of the parameter names will be represented in some constants class (i.e. RiceConstants, KewConstants, KimConstants, etc.)
We need to put these in some form (spreadsheet or confluence page) and then send that to Innovativ. Each one should include:
parameter name
description
default value
required - indicates if the parameter is required or not (like some of the database-related configuration parameters)
module - keep in mind that some of these may be global and not specific to a module
whether the parameter is client, server or both - some configuration parameters are only used in the context of the standalone server
Issue Links
- is related to
-
KULRICE-2932
rice-config.xml for deployment of standalone server
-
Activity
Need to include common-config-defaults.xml in context, but Mylyn seems broken
Updated spreadsheet to include common-config-defaults.xml and rice-config.xml sample in ./web/src/main/config/example-config
Updated the attached spreadsheet to include the 1500+ parameters that were gathered programatically. These are on the third sheet (labeled "recoder"). The first sheet contains global variables and user-defined parameters gotten from various xml configuration files (common-config-defaults.xml and rice-config.xml). The second sheet (labeled "KEW") was a feeble attempt to complete the task of consolidating and annotating the parameters manually.
These files were parsed:
api/src/main/java/org/kuali/rice/core/util/JSTLConstants.java
api/src/main/java/org/kuali/rice/core/util/RiceConstants.java
api/src/main/java/org/kuali/rice/ken/service/KENServiceConstants.java
api/src/main/java/org/kuali/rice/kew/util/KEWConstants.java
api/src/main/java/org/kuali/rice/kim/util/KimConstants.java
api/src/main/java/org/kuali/rice/kns/service/ParameterConstants.java
api/src/main/java/org/kuali/rice/kns/util/KNSConstants.java
impl/src/main/java/org/kuali/rice/kcb/util/KCBConstants.java
impl/src/main/java/org/kuali/rice/ken/util/NotificationConstants.java
impl/src/main/java/org/kuali/rice/kew/batch/XmlConstants.java
impl/src/main/java/org/kuali/rice/kew/util/KEWPropertyConstants.java
impl/src/main/java/org/kuali/rice/kew/xml/XmlConstants.java
impl/src/main/java/org/kuali/rice/kim/util/KIMPropertyConstants.java
impl/src/main/java/org/kuali/rice/kns/authorization/AuthorizationConstants.java
impl/src/main/java/org/kuali/rice/kns/util/KNSPropertyConstants.java
impl/src/main/java/org/kuali/rice/kns/util/RiceKeyConstants.java
impl/src/main/java/org/kuali/rice/kns/web/listener/JstlConstantsInitListener.java
impl/src/main/java/org/kuali/rice/ksb/util/KSBConstants.java
kcb/src/test/java/org/kuali/rice/kcb/test/TestConstants.java
ken/src/test/java/org/kuali/rice/ken/test/TestConstants.java
kew/src/test/java/org/kuali/rice/kew/routemodule/TestRouteModuleConstants.java
kew/src/test/java/org/kuali/rice/kew/test/TestConstants.java
kns/src/test/java/org/kuali/test/KNSTestConstants.java
web/src/test/java/edu/sampleu/travel/infrastructure/Constants.java
The code used to parse the files above is in the attached tarball.
The Spring files should be parsed and added to this spreadsheet as well.
Collected all properties listed in the following files:
./impl/src/main/resources/org/kuali/rice/core/CommonSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/core/RiceDataSourceSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/core/RiceJTASpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kcb/config/KCBSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ken/config/KENSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kew/config/KEWJPASpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kew/config/KEWOJBSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kew/config/KEWSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kew/config/ServerKEWSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kim/config/KIMInterfaceSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ksb/config/KSBModuleConfigurationSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ksb/config/KSBJPASpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ksb/config/KSBOJBSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ksb/config/KSBThinClientSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kns/config/KNSSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/standalone/config/StandaloneSpringBeans.xml
./impl/src/main/resources/TestHarnessSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/ksb/config/KSBSpringBeans.xml
./impl/src/main/resources/org/kuali/rice/kim/config/KIMImplementationSpringBeans.xml
see sheet labeled Spring
Added frank and joe as watchers.
Casey, Frank is working on the install guide right now and trying to complete it by the end of the week so I'd like to get this together for them as soon as possible. I was thinking it hopefully shouldn't take you more than a couple of days to compile this list. Do you think this will be possible?