Castor uses a configuration file for environmental properties that are - shared across all the Castor sub systems. The configuration file is - specified as a Java properties file with the name castor.properties.
++ Castor uses a configuration file for environmental properties that are + shared across all the Castor sub systems. The configuration file is + specified as a Java properties file with the name castor.properties. +
-The Castor JAR includes a default configuration file. A configuration - file in the Java library directory (e.g. /jdk1.2/lib) can be used to - override the default configuration file with system wide properties. - In addition, a configuration file can be placed in the classpath and - will override both the system wide properties and default - configuration.
++ The Castor JAR includes a default configuration file. A configuration + file in the Java library directory (e.g. /jdk1.2/lib) can be + used to override the default configuration file with system-wide + properties. In addition, a configuration file can be placed in the + classpath and will override both the system wide properties and + Castor-default configuration. +
-When running the provided examples, Castor will use the configuration - file located in the examples directory which specifies additional - debugging information and pretty printing of all produced XML - documents.
++ When running the provided examples, Castor will use the configuration + file located in the examples directory which specifies additional + debugging information as well as pretty printing of all produced XML + documents. +
-The following properties are currently supported in the configuration - file:
++ The following properties are currently supported in the configuration + file: +
+
- # Defines the default XML parser to be used by castor
- # The parser must implement org.xml.sax.Parser
- #
- org.exolab.castor.parser=org.apache.xerces.parsers.SAXParser
+# THE CASTOR PROPERTIES FILE
+# This file specifies values for Castor run-time which may be configured
+# by the user.
+# $Id$
- # Defines the (default) XML serializer factory to use by Castor,
- # which must implement org.exolab.castor.xml.SerializerFactory;
- # default is org.exolab.castor.xml.XercesXMLSerializerFactory
- org.exolab.castor.xml.serializer.factory=org.exolab.castor.xml.XercesXMLSerializerFactory
+# This section defines Backwards compatibility switches.
+#
+# Hashtable/Map default mapping.
+# For backward compatibility with 0.9.5.2 and earlier.
+#
+#org.exolab.castor.xml.saveMapKeys=false
- # True if all documents should be indented on output by default
- #
- org.exolab.castor.indent=false
+# Defines the default XML parser to be used by Castor.
+# The parser must implement org.xml.sax.Parser.
+#
+org.exolab.castor.parser=org.apache.xerces.parsers.SAXParser
- # True if all documents should be validated on input by default
- #
- org.exolab.castor.validation=true
+# Defines the (default) XML serializer factory to use by Castor, which must
+# implement org.exolab.castor.xml.SerializerFactory;
+# Default is org.exolab.castor.xml.XercesXMLSerializerFactory
+org.exolab.castor.xml.serializer.factory=org.exolab.castor.xml.XercesXMLSerializerFactory
- # Comma separated list of SAX 2 features that should be enabled
- # for the default parser
- #
- org.exolab.castor.sax.features=
+# Defines the NodeType for use with Java primitive types (int, long, boolean,
+# etc). This value is only used by the Introspector. Valid values are either
+# "attribute" or "element". By default, all primitives are marshaled as
+# attributes. Uncomment the following line to change the NodeType to element.
+#
+#org.exolab.castor.xml.introspector.primitive.nodetype=element
- # Comma separated list of SAX 2 features that should be disabled
- # for the default parser
- #
- org.exolab.castor.sax.features-to-disable=
+# Defines the Naming "style" or conventions to use when creating XML names
+# from Java class or field names.
+# Valid values are as follows:
+# -----------------------------------------------------------------
+# lower (default) | All names are lowercase with hyphens
+# | separating words.
+# |
+# | Example: personInfo = person-info
+# -----------------------------------------------------------------
+# mixed | All names are mixed case, with Uppercase
+# | character as the first letter of a new word.
+# |
+# | Example: personInfo = personInfo
+# | Example: FooBar = fooBar
+# -----------------------------------------------------------------
+# {Any ClassName} | Any Class which implements
+# | org.exolab.castor.xml.XMLNaming
+# -----------------------------------------------------------------
+#
+# By default, all names are treated as the "lower" option. To preserve the
+# Java mixed-case conventions, uncomment the following line.
+#
+#org.exolab.castor.xml.naming=mixed
- # True if should produce verbose messages
- #
- org.exolab.castor.debug=false
+###############################
+# REGULAR EXPRESSION EVALUATORS
+#
+# Defines the Regular Expression Evaluator to be used by Castor.
+# The evaluator must implement org.exolab.castor.util.RegExpEvaluator.
+#
+# Uncomment the following to basically suppress Regular expressions evaluation:
+#org.exolab.castor.regexp=org.exolab.castor.xml.util.AlwaysTrueRegExpEvaluator
+#
+# An implementation which uses the Jakarta RegExp library:
+#org.exolab.castor.regexp=org.exolab.castor.util.JakartaRegExpEvaluator
+#
+# An implementation which uses the Jakarta ORO library:
+org.exolab.castor.regexp=org.exolab.castor.util.JakartaOroEvaluator
- # List of collection handlers for Java 1.1 and Java 1.2 run-times
- #
- org.exolab.castor.mapping.collections=\
- org.exolab.castor.mapping.loader.J1CollectionHandlers,\
- org.exolab.castor.mapping.loader.J2CollectionHandlers
+# True if all documents should be indented on output by default.
+# Defaults to false.
+#
+#org.exolab.castor.indent=true
- # List of persistence factories for the supported database servers
- #
- org.exolab.castor.jdo.engines=\
- org.exolab.castor.jdo.drivers.OracleFactory,\
- org.exolab.castor.jdo.drivers.PostgreSQLFactory,\
- org.exolab.castor.jdo.drivers.SybaseFactory,\
- org.exolab.castor.jdo.drivers.SQLServerFactory,\
- org.exolab.castor.jdo.drivers.DB2Factory,\
- org.exolab.castor.jdo.drivers.GenericFactory
+# True if xml documents should be validated by the SAX Parser
+# Defaults to false.
+#
+org.exolab.castor.parser.validation=false
- # List of key generator factories
- #
- org.exolab.castor.jdo.keyGeneratorFactories=\
- org.exolab.castor.jdo.keygen.MaxKeyGeneratorFactory,\
- org.exolab.castor.jdo.keygen.HighLowKeyGeneratorFactory,\
- org.exolab.castor.jdo.keygen.IdentityKeyGeneratorFactory,\
- org.exolab.castor.jdo.keygen.SequenceKeyGeneratorFactory,\
- org.exolab.castor.jdo.keygen.UUIDKeyGeneratorFactory
+# True for parser to support Namespaces.
+# Defaults to false.
+#
+org.exolab.castor.parser.namespaces=false
- # Collection handlers for the source code generator
- #
- org.exolab.castor.builder.type.j2=\
- org.exolab.castor.builder.FieldInfoFactoryJ2
- org.exolab.castor.builder.type.j1=\
- org.exolab.castor.builder.FieldInfoFactory
- org.exolab.castor.builder.type.odmg=\
- org.exolab.castor.builder.FieldInfoFactoryODMG30
+# True if all documents should be validated by the marshaling framework
+# Defaults to true.
+#
+org.exolab.castor.marshalling.validation=true
- # Default time zone to apply to dates/times fetched from database fields, if not
- # already part of the data. Specify same format as in java.util.TimeZone.getTimeZone, or
- # an empty string to use the computer's local time zone. Please see
- # http://de.wikipedia.org/wiki/Zeitzone for detailed information about time zones.
- #
- org.exolab.castor.jdo.defaultTimeZone=
- #org.exolab.castor.jdo.defaultTimeZone=GMT-8:00
+# Comma separated list of SAX 2 features that should be enabled for the
+# default parser.
+#
+#org.exolab.castor.sax.features=
- #
- # List of TxSynchronizeable implementations
- #
- #org.exolab.castor.persist.TxSynchronizable=
+# Comma separated list of SAX 2 features that should be disabled for the
+# default parser.
+#
+#org.exolab.castor.sax.features-to-disable
- #
- # True if JDBC proxy classes should be used to enable more detailed logging output of SQL
- # statements; false otherwise (logging will be turned off completely).
- #
- org.exolab.castor.perists.useProxies=true
+# True if debugging output should be generated.
+# Defaults to false.
+#
+org.exolab.castor.debug=false
- #
- # List of available cache implementations; please expand this list to add
- # any custom performance caches.
- #
- org.castor.cache.Factories=\
- org.castor.cache.simple.NoCacheFactory,\
- org.castor.cache.simple.TimeLimitedFactory,\
- org.castor.cache.simple.CountLimitedFactory,\
- org.castor.cache.simple.UnlimitedFactory,\
- org.castor.cache.distributed.FKCacheFactory,\
- org.castor.cache.distributed.JcsCacheFactory,\
- org.castor.cache.distributed.JCacheFactory,\
- org.castor.cache.distributed.CoherenceCacheFactory,\
- org.castor.cache.distributed.OsCacheFactory,\
- org.castor.cache.hashbelt.FIFOHashbeltFactory,\
- org.castor.cache.hashbelt.LRUHashbeltFactory,\
- org.castor.cache.distributed.EHCacheFactory
+# List of collection handlers for Java 1.1 and Java 1.2 run-times:
+#
+org.exolab.castor.mapping.collections=\
+ org.exolab.castor.mapping.loader.J1CollectionHandlers,\
+ org.exolab.castor.mapping.loader.J2CollectionHandlers
- #
- # List of supported TransactionManagerFactory implementations; please expand
- # this list to add any custom transaction manager fatories.
- #
- org.castor.transactionmanager.Factories=\
- org.castor.transactionmanager.LocalTransactionManagerFactory,\
- org.castor.transactionmanager.JNDIENCTransactionManagerFactory,\
- org.castor.transactionmanager.JOTMTransactionManagerFactory,\
- org.castor.transactionmanager.WebSphereTransactionManagerFactory,\
- org.castor.transactionmanager.WebSphere5TransactionManagerFactory,\
- org.castor.transactionmanager.WebSphere51TransactionManagerFactory
-
- #
- # Shell the TransactionManager be initialized at registration or lazily when
- # requested for the first time? Defaults to false.
- #
- org.castor.transactionmanager.InitializeAtRegistration=false
-
-
-