Changes between Initial Version and Version 1 of ReferenceMaterials/ColdSpringXmlReference/ModelGlueConfiguration

Timestamp:

04/15/09 19:43:31 (17 years ago)

Author:

trac (IP: 127.0.0.1)

Comment:

--

ReferenceMaterials/ColdSpringXmlReference/ModelGlueConfiguration

@@ +1 @@
+[[PageOutline]]
+
+= Model-Glue Configuration Setting Definitions =
+
+In your !ColdSpring.xml file, the modelGlueConfiguration bean defines environment parameters for the instance of Model-Glue framework that runs the application.
+
+Changing these parameters alters the behavior of the framework.
+
+This document explains each setting and its behavior.
+
+== Debug ==
+
+Debug can be set to TRUE or FALSE.
+
+Setting to TRUE will cause the Model-Glue debugging trace to be displayed at the bottom of every page.
+
+== !DefaultCacheTimeout ==
+
+The default cache timeout variable for controller-based caching.
+
+== !DefaultExceptionHandler ==
+
+The name of an event handler tag to run in the event of an exception.
+
+When an exception is detected, a new value named "exception" is added to the viewstate containing the cfcatch structure from the exception.
+
+== !DefaultScaffolds ==
+
+The list of scaffold types to generate when no TYPE attribute is specified for a given scaffold tag.
+
+== !DefaultTemplate ==
+
+The name of the .CFM file that all requests use. Defaults to "index.cfm".
+
+== !EventValue ==
+
+The name of the URL variable that contains the event handler tag to execute.
+
+Defaults to "event."
+
+If changed to "do," the url "index.cfm?do=somePage" would execute the "somePage" event handler.
+
+== !GeneratedViewMapping ==
+
+The directory in which to put all view .CFM templates generated via scaffold tags.
+
+== Reload ==
+
+The reload setting can be set to TRUE or FALSE.
+
+When TRUE, the application will re-read the !ModelGlue.xml, !ColdSpring.xml and Reactor.xml files on each request, reloading the framework and using any changes made to these files.
+
+When FALSE, the application will not reload the framework or detect changes to these files.
+
+It is imperative that any application deployed in a production environment have reload set to FALSE.
+
+== !ReloadKey ==
+
+The name of the URL variable used to force reloading of the framework. When a URL variable by this name is added to the query string with a value matching RELOADPASSWORD's setting, the framework will reload regardless of its RELOAD setting value.
+
+This can be used to force the framework to reload in a production environment.
+
+Using the default values for RELOADKEY and RELOADPASSWORD, this would be done by appending ?init=true to the URL.
+
+== !ReloadPassword ==
+
+The value of the URL variable named by the RELOADKEY setting. When a URL variable by this name is added to the query string with a value matching RELOADPASSWORD's setting, the framework will reload regardless of its RELOAD setting value.
+
+This can be used to force the framework to reload in a production environment.
+
+Using the default values for RELOADKEY and RELOADPASSWORD, this would be done by appending ?init=true to the URL.
+
+== Rescaffold ==
+
+Rescaffold may be set to TRUE or FALSE.
+
+Generating scaffolds in a processor-intensive process. As more scaffolds are added, the framework may be slow to respond when the RELOAD setting is set to TRUE. By setting RESCAFFOLD to FALSE, changes to !ModelGlue.xml, !ColdSpring.xml, and Reactor.xml will be detected, but scaffolds will not be re-generated, and changes to scaffold tags will not be detected.
+
+== !StatePrecedence ==
+
+Possible values are FORM and URL.
+
+Model-Glue combines all values from FORM and URL into a single structure called the viewstate. If STATEPRECEDENCE is set to FORM, FORM variables will overwrite like-named URL variables. If set to URL, the opposite will occur.
+
+== !ViewMappings ==
+
+The list of directories in which .CFM templates to use as views will be found. The list is searched in order.