Revision 6940
Added by ben leinfelder about 13 years ago
| docs/user/metacat/source/metacat-properties.rst | ||
|---|---|---|
| 44 | 44 |
---------------------- |
| 45 | 45 |
|
| 46 | 46 |
Metacat's application properties are described below. Properties that can only |
| 47 |
be edited manually in the ``metacat.properties`` file are highlighted. All
|
|
| 47 |
be edited manually in the ``metacat.properties`` file are marked. All
|
|
| 48 | 48 |
others are managed with the properties configuration utility. |
| 49 | 49 |
|
| 50 | 50 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 51 | 51 |
| Property | Description | Example | |
| 52 | 52 |
+================================+=============================================================================+===============================+ |
| 53 |
| application.metacatVersion | The Metacat version number. It is set by the build engineer | 1.9.0 |
|
|
| 53 |
| application.metacatVersion* | The Metacat version number. It is set by the build engineer | 1.9.0 |
|
|
| 54 | 54 |
| | at build time. Usually, the value should never be changed. | | |
| 55 | 55 |
| | | | |
| 56 | 56 |
| | Default Value: X.X.X (where X.X.X is the current version of Metacat) | | |
| 57 | 57 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 58 |
| application.metacatReleaseInfo | Release information for display purposes. Typically the property | Release Candidate 1 |
|
|
| 58 |
| application.metacatReleaseInfo*| Release information for display purposes. Typically the property | Release Candidate 1 |
|
|
| 59 | 59 |
| | is set during the release candidate cycle to let users know which | | |
| 60 | 60 |
| | candidate they are downloading. | | |
| 61 | 61 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| ... | ... | |
| 114 | 114 |
Database Properties |
| 115 | 115 |
------------------- |
| 116 | 116 |
Metacat's database properties are described next. Properties that can only be |
| 117 |
edited manually in the metacat.properties file are highlighted. All others
|
|
| 117 |
edited manually in the metacat.properties file are marked. All others
|
|
| 118 | 118 |
are managed with the properties configuration utility. |
| 119 | 119 |
|
| 120 | 120 |
Metacat Database Properties |
| ... | ... | |
| 164 | 164 |
| | database.upgradeVersion.1.7.0=upgrade-db-to-1.7 | | |
| 165 | 165 |
| | database.upgradeVersion.1.8.0=upgrade-db-to-1.8 | | |
| 166 | 166 |
| | database.upgradeVersion.1.9.0=upgrade-db-to-1.9 | | |
| 167 |
| | database.upgradeVersion.2.0.0=upgrade-db-to-2.0 | | |
|
| 167 | 168 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 168 |
| database.initialConnections | The number of initial connection that Metacat creates to the database. | 5 |
|
|
| 169 |
| database.initialConnections* | The number of initial connection that Metacat creates to the database. | 5 |
|
|
| 169 | 170 |
| | | | |
| 170 | 171 |
| | Default Value: 5 | | |
| 171 | 172 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 172 |
| database.incrementConnections | The number of connections Metacat creates when it requires | 5 |
|
|
| 173 |
| database.incrementConnections* | The number of connections Metacat creates when it requires | 5 |
|
|
| 173 | 174 |
| | more connections. | | |
| 174 | 175 |
| | | | |
| 175 | 176 |
| | Default Value: 5 | | |
| 176 | 177 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 177 |
| database.maximumConnections | The maximum number of database connections Metacat can make. | 25 |
|
|
| 178 |
| database.maximumConnections* | The maximum number of database connections Metacat can make. | 25 |
|
|
| 178 | 179 |
| | | | |
| 179 | 180 |
| | Default Value: 200 | | |
| 180 | 181 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 181 |
| database.maximumConnectionAge | The maximum time in milliseconds that a database connection can live. | 120000 |
|
|
| 182 |
| database.maximumConnectionAge* | The maximum time in milliseconds that a database connection can live. | 120000 |
|
|
| 182 | 183 |
| | | | |
| 183 | 184 |
| | Default Value: 120000 | | |
| 184 | 185 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 185 |
| database.maximumConnectionTime | The maximum time in milliseconds that a database connection can | 60000 |
|
|
| 186 |
| database.maximumConnectionTime* | The maximum time in milliseconds that a database connection can | 60000 |
|
|
| 186 | 187 |
| | accumulate in actual connection time. | | |
| 187 | 188 |
| | | | |
| 188 | 189 |
| | Default Value: 60000 | | |
| 189 | 190 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 190 |
| database.maximumUsageNumber | The maximum number of times a single connection can be used. | 100 |
|
|
| 191 |
| database.maximumUsageNumber* | The maximum number of times a single connection can be used. | 100 |
|
|
| 191 | 192 |
| | | | |
| 192 | 193 |
| | Default Value: 100 | | |
| 193 | 194 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 194 |
| database.numberOfIndexingThreads | The number of threads available for indexing. | 5 |
|
|
| 195 |
| database.numberOfIndexingThreads* | The number of threads available for indexing. | 5 |
|
|
| 195 | 196 |
| | | | |
| 196 | 197 |
| | Default Value: 5 | | |
| 197 | 198 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 198 |
| database.indexingTimerTaskTime | The time in milliseconds between indexing. | 604800000 |
|
|
| 199 |
| database.indexingTimerTaskTime* | The time in milliseconds between indexing. | 604800000 |
|
|
| 199 | 200 |
| | | | |
| 200 | 201 |
| | Default Value: 604800000 | | |
| 201 | 202 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 202 |
| database.indexingInitialDelay | The delay in milliseconds before first indexing is executed. | 3600000 |
|
|
| 203 |
| database.indexingInitialDelay* | The delay in milliseconds before first indexing is executed. | 3600000 |
|
|
| 203 | 204 |
| | | | |
| 204 | 205 |
| | Default Value: 3600000 | | |
| 205 | 206 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 206 |
| database.maximumIndexDelay | The time in milliseconds that an indexing thread will wait when it | 5000 |
|
|
| 207 |
| database.maximumIndexDelay* | The time in milliseconds that an indexing thread will wait when it | 5000 |
|
|
| 207 | 208 |
| | can't get a doc id before retrying the indexing. | | |
| 208 | 209 |
| | | | |
| 209 | 210 |
| | Default Value: 5000 | | |
| 210 | 211 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 211 |
| database.runDBConnectionRecycleThread | Determines whether the database connection pool should run a thread to | off |
|
|
| 212 |
| database.runDBConnectionRecycleThread* | Determines whether the database connection pool should run a thread to | off |
|
|
| 212 | 213 |
| | recycle connections. Possible values are "on" and "off" | | |
| 213 | 214 |
| | | | |
| 214 | 215 |
| | Default Value: off | | |
| 215 | 216 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 216 |
| database.cycleTimeOfDBConnection | The time in milliseconds between connection recycling runs. | 30000 |
|
|
| 217 |
| database.cycleTimeOfDBConnection* | The time in milliseconds between connection recycling runs. | 30000 |
|
|
| 217 | 218 |
| | | | |
| 218 | 219 |
| | Default Value: 30000 | | |
| 219 | 220 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 220 |
| database.queryignoredparams | Parameters to ignore in a structured XML query. | enableediting |
|
|
| 221 |
| database.queryignoredparams* | Parameters to ignore in a structured XML query. | enableediting |
|
|
| 221 | 222 |
| | | | |
| 222 | 223 |
| | Default Value: enableediting,foo | | |
| 223 | 224 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 224 |
| database.usexmlindex | Determines whether to use XML indexes when finding | true |
|
|
| 225 |
| database.usexmlindex* | Determines whether to use XML indexes when finding | true |
|
|
| 225 | 226 |
| | documents. Possible values are true and false. | | |
| 226 | 227 |
| | | | |
| 227 | 228 |
| | Default Value: true | | |
| 228 | 229 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 229 |
| database.appResultsetSize | Determines the number of results that can be returned to an application from a query. | 7000 |
|
|
| 230 |
| database.appResultsetSize* | Determines the number of results that can be returned to an application from a query. | 7000 |
|
|
| 230 | 231 |
| | | | |
| 231 | 232 |
| | Default Value: 7000 | | |
| 232 | 233 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 233 |
| database.webResultsetSize | Determines the number of results that can be returned to a | 7000 |
|
|
| 234 |
| database.webResultsetSize* | Determines the number of results that can be returned to a | 7000 |
|
|
| 234 | 235 |
| | Web browser from a query. | | |
| 235 | 236 |
| | | | |
| 236 | 237 |
| | Default Value: 7000 | | |
| 237 | 238 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 238 |
| database.xmlReturnfieldCount | If the query results of a query are returned more times | 0 |
|
|
| 239 |
| database.xmlReturnfieldCount* | If the query results of a query are returned more times | 0 |
|
|
| 239 | 240 |
| | than this value, then those results will be inserted into the xml_queryresult | | |
| 240 | 241 |
| | table in the database. For example, if you want results for | | |
| 241 | 242 |
| | a query to be stored in xml_queryresult only when it has been requested | | |
| ... | ... | |
| 243 | 244 |
| | | | |
| 244 | 245 |
| | Default Value: 0 | | |
| 245 | 246 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 246 |
| database.queryresultStringLength | The max size of the query result string in the queryresult table. This | 500000 |
|
|
| 247 |
| database.queryresultStringLength* | The max size of the query result string in the queryresult table. This | 500000 |
|
|
| 247 | 248 |
| | should be set to some number less than 4000 if an Oracle | | |
| 248 | 249 |
| | database is being used. | | |
| 249 | 250 |
| | | | |
| 250 | 251 |
| | Default Value: 500000 | | |
| 251 | 252 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 252 |
| database.queryresultCacheSize | The number of query results that will be cached. | 500 |
|
|
| 253 |
| database.queryresultCacheSize* | The number of query results that will be cached. | 500 |
|
|
| 253 | 254 |
| | | | |
| 254 | 255 |
| | Default Value: 500 | | |
| 255 | 256 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 256 |
| database.queryCacheOn | Determines whether query caching is turned on. Possible values are "on" and "off" | on |
|
|
| 257 |
| database.queryCacheOn* | Determines whether query caching is turned on. Possible values are "on" and "off" | on |
|
|
| 257 | 258 |
| | | | |
| 258 | 259 |
| | Default Value: on | | |
| 259 | 260 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| ... | ... | |
| 262 | 263 |
------------------------------------------- |
| 263 | 264 |
Metacat's authorization and authentication properties are described in the |
| 264 | 265 |
table below. Properties that can only be edited manually in the ``metacat.properties`` |
| 265 |
file are highlighted. All others are managed with the properties configuration utility.
|
|
| 266 |
file are marked. All others are managed with the properties configuration utility.
|
|
| 266 | 267 |
|
| 267 | 268 |
Authorization and Authentication Properties |
| 268 | 269 |
|
| ... | ... | |
| 278 | 279 |
| | | | |
| 279 | 280 |
| | Default Value: edu.ucsb.nceas.metacat.AuthLdap | | |
| 280 | 281 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 281 |
| auth.timeoutMinutes | The number of minutes that a user will stay logged in to Metacat | 180 |
|
|
| 282 |
| auth.timeoutMinutes* | The number of minutes that a user will stay logged in to Metacat | 180 |
|
|
| 282 | 283 |
| | without any activity. | | |
| 283 | 284 |
| | | | |
| 284 | 285 |
| | Default Value: 180 | | |
| ... | ... | |
| 312 | 313 |
| | | | |
| 313 | 314 |
| | Default Value: (none) | | |
| 314 | 315 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 315 |
| ldap.connectTimeLimit | The time in milliseconds allowed for LDAP server connections. | 5000 |
|
|
| 316 |
| ldap.connectTimeLimit* | The time in milliseconds allowed for LDAP server connections. | 5000 |
|
|
| 316 | 317 |
| | | | |
| 317 | 318 |
| | Default Value: 5000 | | |
| 318 | 319 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 319 |
| ldap.searchTimeLimit | The time in milliseconds allowed for LDAP server searches. | 3000 |
|
|
| 320 |
| ldap.searchTimeLimit* | The time in milliseconds allowed for LDAP server searches. | 3000 |
|
|
| 320 | 321 |
| | | | |
| 321 | 322 |
| | Default Value: 30000 | | |
| 322 | 323 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 323 |
| ldap.searchCountLimit | The number of return entries allowed for LDAP server searches. | 30000 |
|
|
| 324 |
| ldap.searchCountLimit* | The number of return entries allowed for LDAP server searches. | 30000 |
|
|
| 324 | 325 |
| | | | |
| 325 | 326 |
| | Default Value: 30000 | | |
| 326 | 327 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 327 |
| ldap.referral | The type of LDAP referrals to use. Possible values are "follow", | follow |
|
|
| 328 |
| ldap.referral* | The type of LDAP referrals to use. Possible values are "follow", | follow |
|
|
| 328 | 329 |
| | "throw" or "none". Refer to LDAP documentation for further information. | | |
| 329 | 330 |
| | | | |
| 330 | 331 |
| | Default Value: follow | | |
| 331 | 332 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 332 |
| ldap.onlySecureConnection | Determines whether to use only a secure LDAP server. | false |
|
|
| 333 |
| ldap.onlySecureConnection* | Determines whether to use only a secure LDAP server. | false |
|
|
| 333 | 334 |
| | Acceptable values are "true" and "false". | | |
| 334 | 335 |
| | | | |
| 335 | 336 |
| | Default Value: false | | |
| 336 | 337 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 337 |
| ldap.onlySecureReferalsConnection | Determines whether to only use a secure referral server. | false |
|
|
| 338 |
| ldap.onlySecureReferalsConnection*| Determines whether to only use a secure referral server. | false |
|
|
| 338 | 339 |
| | Acceptable values are "true" and "false". | | |
| 339 | 340 |
| | | | |
| 340 | 341 |
| | Default Value: false | | |
| ... | ... | |
| 342 | 343 |
|
| 343 | 344 |
XML/EML Properties |
| 344 | 345 |
------------------ |
| 345 |
Metacat's XML/EML properties are described ibelow. Properties that can only be
|
|
| 346 |
edited manually in the metacat.properties file are highlighted.
|
|
| 346 |
Metacat's XML/EML properties are described below. These properties can only be
|
|
| 347 |
edited manually in the metacat.properties file. |
|
| 347 | 348 |
|
| 348 | 349 |
XML/EML Properties |
| 349 | 350 |
|
Also available in: Unified diff
marked the properties that are only editable manually in metacat.properties
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5516