| 1 |
6147
|
jones
|
Appendix: Metacat Properties
|
| 2 |
|
|
============================
|
| 3 |
6857
|
jones
|
The most dynamic Metacat Properties are managed using Metacat's Configuration
|
| 4 |
|
|
Interface (see :doc:`configuration`). These properties, as well as other,
|
| 5 |
|
|
rarely modified ones can be found in the metacat.properties file. For more
|
| 6 |
|
|
information about the properties, click one of the following:
|
| 7 |
6147
|
jones
|
|
| 8 |
6857
|
jones
|
* Server Properties
|
| 9 |
|
|
* Application Properties
|
| 10 |
|
|
* Database Properties
|
| 11 |
|
|
* Authorization and Authentication Properties
|
| 12 |
|
|
* XML/EML Properties
|
| 13 |
6147
|
jones
|
|
| 14 |
6857
|
jones
|
Server Properties
|
| 15 |
|
|
-----------------
|
| 16 |
|
|
All of Metacat's server properties are managed with the form-based
|
| 17 |
|
|
configuration utility, though they can also be accessed More information on
|
| 18 |
|
|
each is included below.
|
| 19 |
6147
|
jones
|
|
| 20 |
|
|
|
| 21 |
6857
|
jones
|
Metacat Server Properties
|
| 22 |
|
|
|
| 23 |
8230
|
leinfelder
|
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 24 |
|
|
| Property | Description | Example |
|
| 25 |
|
|
+===========================+==========================================================================================+========================+
|
| 26 |
|
|
| .. _server-name: | | |
|
| 27 |
|
|
| | | |
|
| 28 |
|
|
| server.name | The network host name used to access Metacat. Note that this is not necessarily | knb.ecoinformatics.org |
|
| 29 |
|
|
| | the physical name of the server running Metacat. The host name should not | |
|
| 30 |
|
|
| | include the protocol prefix (http://). | |
|
| 31 |
|
|
| | | |
|
| 32 |
|
|
| | Default Value: localhost | |
|
| 33 |
|
|
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 34 |
|
|
| .. _server-httpPort: | | |
|
| 35 |
|
|
| | | |
|
| 36 |
|
|
| server.httpPort | The network port used to access Metacat for non-secure (standard) connections. | 80 |
|
| 37 |
|
|
| | This is usually 80 if Apache Web server is running, and 8080 if Tomcat is running alone. | |
|
| 38 |
|
|
| | | |
|
| 39 |
|
|
| | Default Value: 80 | |
|
| 40 |
|
|
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 41 |
7425
|
leinfelder
|
| .. _server-httpSSLPort: | | |
|
| 42 |
8230
|
leinfelder
|
| | | |
|
| 43 |
|
|
| server.httpSSLPort | The network port used to access Metacat for secure connections. This is usually | 443 |
|
| 44 |
|
|
| | 443 if Apache Web server is running, and 8443 if Tomcat is running alone. | |
|
| 45 |
|
|
| | | |
|
| 46 |
|
|
| | Default Value: 443 | |
|
| 47 |
|
|
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 48 |
6857
|
jones
|
|
| 49 |
|
|
Application Properties
|
| 50 |
|
|
----------------------
|
| 51 |
|
|
|
| 52 |
|
|
Metacat's application properties are described below. Properties that can only
|
| 53 |
6940
|
leinfelder
|
be edited manually in the ``metacat.properties`` file are marked. All
|
| 54 |
6857
|
jones
|
others are managed with the properties configuration utility.
|
| 55 |
|
|
|
| 56 |
8230
|
leinfelder
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 57 |
|
|
| Property | Description | Example |
|
| 58 |
|
|
+======================================+=============================================================================+===============================+
|
| 59 |
|
|
| application.metacatVersion* | The Metacat version number. It is set by the build engineer | 1.9.0 |
|
| 60 |
|
|
| | at build time. Usually, the value should never be changed. | |
|
| 61 |
|
|
| | | |
|
| 62 |
|
|
| | Default Value: X.X.X (where X.X.X is the current version of Metacat) | |
|
| 63 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 64 |
|
|
| application.metacatReleaseInfo* | Release information for display purposes. Typically the property | Release Candidate 1 |
|
| 65 |
|
|
| | is set during the release candidate cycle to let users know which | |
|
| 66 |
|
|
| | candidate they are downloading. | |
|
| 67 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 68 |
|
|
| .. _application.deployDir: | | |
|
| 69 |
|
|
| | | |
|
| 70 |
|
|
| application.deployDir | The directory where Web applications are deployed. Usually, the value | /usr/local/tomcat/webapps |
|
| 71 |
|
|
| | is a directory named "webapps" in the Tomcat installation directory. | |
|
| 72 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 73 |
|
|
| .. _application.context: | | |
|
| 74 |
|
|
| | | |
|
| 75 |
|
|
| application.context | The name of the Metacat application directory in | knb |
|
| 76 |
|
|
| | the deployment directory. This corresponds to the first part of the | |
|
| 77 |
|
|
| | WAR file name (the part before .war). Most commonly, this | |
|
| 78 |
|
|
| | is "knb", but it can be changed to other things. | |
|
| 79 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 80 |
|
|
| .. _index.context: | | |
|
| 81 |
|
|
| | | |
|
| 82 |
|
|
| index.context | The name of the Metacat index webapp in | metacat-index |
|
| 83 |
|
|
| | the deployment directory. Most commonly, this | |
|
| 84 |
|
|
| | is "metacat-index", but it can be changed if needed. | |
|
| 85 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 86 |
|
|
| .. _ui.context: | | |
|
| 87 |
|
|
| | | |
|
| 88 |
|
|
| ui.context | The name of the Metacat UI directory in | metacatui |
|
| 89 |
|
|
| | the deployment directory. Often the UI is deployed | |
|
| 90 |
|
|
| | as the ROOT webapp, in which case the property should be blank (""). | |
|
| 91 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 92 |
|
|
| .. _application.default-style: | | |
|
| 93 |
|
|
| | | |
|
| 94 |
|
|
| application.default-style | A custom Metacat Web skin usually associated with | default |
|
| 95 |
|
|
| | an organizational theme. If your organization has no | |
|
| 96 |
|
|
| | custom skin, leave the value as "default". | |
|
| 97 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 98 |
|
|
| .. _application.knbSiteURL: | | |
|
| 99 |
|
|
| | | |
|
| 100 |
|
|
| application.knbSiteURL | The main KNB website. | http://knb.ecoinformatics.org |
|
| 101 |
|
|
| | | |
|
| 102 |
|
|
| | Default Value: http://knb.ecoinformatics.org | |
|
| 103 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 104 |
|
|
| .. _application.datafilepath: | | |
|
| 105 |
|
|
| | | |
|
| 106 |
|
|
| application.datafilepath | The directory in which to store data files. The directory should | /var/metacat/data |
|
| 107 |
|
|
| | be outside the Metacat installation directories so data files will not | |
|
| 108 |
|
|
| | be lost when Metacat is upgraded. The data file directory must be | |
|
| 109 |
|
|
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
| 110 |
|
|
| | | |
|
| 111 |
|
|
| | Default Value: /var/metacat/data | |
|
| 112 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 113 |
|
|
| .. _application.inlinedatafilepath: | | |
|
| 114 |
|
|
| | | |
|
| 115 |
|
|
| application.inlinedatafilepath | The directory where inline data files will be stored. Inline | /var/metacat/inline-data |
|
| 116 |
|
|
| | data files are created from data that is embedded in EML | |
|
| 117 |
|
|
| | metadata. The directory should be outside the Metacat installation | |
|
| 118 |
|
|
| | directories so data files will not be lost when Metacat is upgraded. | |
|
| 119 |
|
|
| | For clarity of data, this should probably not be the same as | |
|
| 120 |
|
|
| | ``application.datafilepath``. The data file directory must be | |
|
| 121 |
|
|
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
| 122 |
|
|
| | | |
|
| 123 |
|
|
| | Default Value: /var/metacat/inline-data | |
|
| 124 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 125 |
|
|
| .. _application.documentfilepath: | | |
|
| 126 |
|
|
| | | |
|
| 127 |
|
|
| application.documentfilepath | The directory where metadata files will be stored. | /var/metacat/documents |
|
| 128 |
|
|
| | The directory should be outside the Metacat installation directories | |
|
| 129 |
|
|
| | so document files will not be lost when Metacat is upgraded. For | |
|
| 130 |
|
|
| | clarity of organization, this should probably not be the same as | |
|
| 131 |
|
|
| | ``application.datafilepath`` or ``application.inlinedatafilepath``. | |
|
| 132 |
|
|
| | The data file directory must be writable by the user that | |
|
| 133 |
|
|
| | starts Tomcat (and thus Metacat). | |
|
| 134 |
|
|
| | | |
|
| 135 |
|
|
| | Default Value: /var/metacat/documents | |
|
| 136 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 137 |
|
|
| .. _application.tempDir: | | |
|
| 138 |
|
|
| | | |
|
| 139 |
|
|
| application.tempDir | The directory where the Metacat data registry stores temporary | /var/metacat/temporary |
|
| 140 |
|
|
| | files. The directory should not be the same as ``application.datafilepath`` | |
|
| 141 |
|
|
| | or ``application.inlinedatafilepath`` (or any other persistent file path) | |
|
| 142 |
|
|
| | because all files in this may be purged programmatically. The temporary | |
|
| 143 |
|
|
| | file directory must be writable by the user that starts Apache. | |
|
| 144 |
|
|
| | | |
|
| 145 |
|
|
| | Default Value: /var/metacat/temporary | |
|
| 146 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 147 |
|
|
| .. _solr.homeDir: | | |
|
| 148 |
|
|
| | | |
|
| 149 |
|
|
| solr.homeDir | The directory where the Metacat index component stores the SOLR index. | /var/metacat/solr-home |
|
| 150 |
|
|
| | The directory must be writable by the user that starts Tomcat. | |
|
| 151 |
|
|
| | | |
|
| 152 |
|
|
| | Default Value: /var/metacat/solr-home | |
|
| 153 |
|
|
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 154 |
6857
|
jones
|
|
| 155 |
|
|
Database Properties
|
| 156 |
|
|
-------------------
|
| 157 |
|
|
Metacat's database properties are described next. Properties that can only be
|
| 158 |
6940
|
leinfelder
|
edited manually in the metacat.properties file are marked. All others
|
| 159 |
6857
|
jones
|
are managed with the properties configuration utility.
|
| 160 |
|
|
|
| 161 |
|
|
Metacat Database Properties
|
| 162 |
|
|
|
| 163 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 164 |
|
|
| Property | Description | Example |
|
| 165 |
|
|
+============================================+==========================================================================================================+=========================================================+
|
| 166 |
7425
|
leinfelder
|
| .. _database-connectionURI: | | |
|
| 167 |
|
|
| | | |
|
| 168 |
6857
|
jones
|
| database.connectionURI | The JDBC connection URI for the main database instance of Metacat. | ``jdbc:postgresql://yourserver.yourdomain.edu/metacat`` |
|
| 169 |
|
|
| | The URI is formatted like: ``jdbc:<database_type>:thin@<your_server_name>:1521:<metacat_database_name>`` | |
|
| 170 |
|
|
| | NOTE: You must create an empty database prior to initial Metacat configuration. | |
|
| 171 |
|
|
| | | |
|
| 172 |
|
|
| | Default Value: jdbc:postgresql://localhost/metacat | |
|
| 173 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 174 |
7425
|
leinfelder
|
| .. _database-user: | | |
|
| 175 |
|
|
| | | |
|
| 176 |
6857
|
jones
|
| database.user | The user for the main database instance of Metacat. The user must | metacat-user |
|
| 177 |
|
|
| | have already been created on the database. | |
|
| 178 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 179 |
7425
|
leinfelder
|
| .. _database-password: | | |
|
| 180 |
|
|
| | | |
|
| 181 |
6857
|
jones
|
| database.password | The password of the user for the main database instance of Metacat. | securepassword4843 |
|
| 182 |
|
|
| | The password must have already been created for the user. | |
|
| 183 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 184 |
7425
|
leinfelder
|
| .. _database-type: | | |
|
| 185 |
|
|
| | | |
|
| 186 |
6857
|
jones
|
| database.type | The type of database you are running. Currently, there are two supported | postgres |
|
| 187 |
|
|
| | types, Oracle and Postgres. | |
|
| 188 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 189 |
7425
|
leinfelder
|
| .. _database-driver: | | |
|
| 190 |
|
|
| | | |
|
| 191 |
6857
|
jones
|
| database.driver | The JDBC driver to be used to access the main database instance of Metacat. | org.postgresql.Driver |
|
| 192 |
|
|
| | There is one driver associated with each type of database. | |
|
| 193 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 194 |
7425
|
leinfelder
|
| .. _database-adapter: | | |
|
| 195 |
|
|
| | | |
|
| 196 |
6857
|
jones
|
| database.adapter | The adapter class that allows Metacat to access your database type. | edu.ucsb.nceas.dbadapter.PostgresqlAdapter |
|
| 197 |
|
|
| | There is one adapter associated with each type of database. | |
|
| 198 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 199 |
8230
|
leinfelder
|
| .. _database-scriptsuf: | | |
|
| 200 |
7425
|
leinfelder
|
| | | |
|
| 201 |
6857
|
jones
|
| database.scriptsuffix.<database_type> | The script suffix tells the system which database scripts to run | postgres.sql |
|
| 202 |
|
|
| | (postgres or oracle) when installing or updating database schema. | |
|
| 203 |
|
|
| | | |
|
| 204 |
|
|
| | Default Values: | |
|
| 205 |
|
|
| | database.scriptsuffix.postgres=postgres.sql | |
|
| 206 |
|
|
| | database.scriptsuffix.oracle=oracle.sql | |
|
| 207 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 208 |
7425
|
leinfelder
|
| .. _database-upgradeVersion: | | |
|
| 209 |
|
|
| | | |
|
| 210 |
6857
|
jones
|
| database.upgradeVersion.<database_version> | Which database scripts to run when updating database schema. There is a | upgrade-db-to-1.2 |
|
| 211 |
|
|
| | database.upgradeVersion entry for every Metacat database schema version. | |
|
| 212 |
|
|
| | Each schema version corresponds to an application version. | |
|
| 213 |
|
|
| | | |
|
| 214 |
|
|
| | Default Values: | |
|
| 215 |
|
|
| | database.upgradeVersion.0.0.0=xmltables,loaddtdschema | |
|
| 216 |
|
|
| | database.upgradeVersion.1.2.0=upgrade-db-to-1.2 | |
|
| 217 |
|
|
| | database.upgradeVersion.1.3.0=upgrade-db-to-1.3 | |
|
| 218 |
|
|
| | database.upgradeVersion.1.4.0=upgrade-db-to-1.4 | |
|
| 219 |
|
|
| | database.upgradeVersion.1.5.0=upgrade-db-to-1.5 | |
|
| 220 |
|
|
| | database.upgradeVersion.1.6.0=upgrade-db-to-1.6 | |
|
| 221 |
|
|
| | database.upgradeVersion.1.7.0=upgrade-db-to-1.7 | |
|
| 222 |
|
|
| | database.upgradeVersion.1.8.0=upgrade-db-to-1.8 | |
|
| 223 |
|
|
| | database.upgradeVersion.1.9.0=upgrade-db-to-1.9 | |
|
| 224 |
6940
|
leinfelder
|
| | database.upgradeVersion.2.0.0=upgrade-db-to-2.0 | |
|
| 225 |
6857
|
jones
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 226 |
6940
|
leinfelder
|
| database.initialConnections* | The number of initial connection that Metacat creates to the database. | 5 |
|
| 227 |
6857
|
jones
|
| | | |
|
| 228 |
|
|
| | Default Value: 5 | |
|
| 229 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 230 |
6940
|
leinfelder
|
| database.incrementConnections* | The number of connections Metacat creates when it requires | 5 |
|
| 231 |
6857
|
jones
|
| | more connections. | |
|
| 232 |
|
|
| | | |
|
| 233 |
|
|
| | Default Value: 5 | |
|
| 234 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 235 |
6940
|
leinfelder
|
| database.maximumConnections* | The maximum number of database connections Metacat can make. | 25 |
|
| 236 |
6857
|
jones
|
| | | |
|
| 237 |
|
|
| | Default Value: 200 | |
|
| 238 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 239 |
6940
|
leinfelder
|
| database.maximumConnectionAge* | The maximum time in milliseconds that a database connection can live. | 120000 |
|
| 240 |
6857
|
jones
|
| | | |
|
| 241 |
|
|
| | Default Value: 120000 | |
|
| 242 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 243 |
6940
|
leinfelder
|
| database.maximumConnectionTime* | The maximum time in milliseconds that a database connection can | 60000 |
|
| 244 |
6857
|
jones
|
| | accumulate in actual connection time. | |
|
| 245 |
|
|
| | | |
|
| 246 |
|
|
| | Default Value: 60000 | |
|
| 247 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 248 |
6940
|
leinfelder
|
| database.maximumUsageNumber* | The maximum number of times a single connection can be used. | 100 |
|
| 249 |
6857
|
jones
|
| | | |
|
| 250 |
|
|
| | Default Value: 100 | |
|
| 251 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 252 |
6940
|
leinfelder
|
| database.numberOfIndexingThreads* | The number of threads available for indexing. | 5 |
|
| 253 |
6857
|
jones
|
| | | |
|
| 254 |
|
|
| | Default Value: 5 | |
|
| 255 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 256 |
6940
|
leinfelder
|
| database.indexingTimerTaskTime* | The time in milliseconds between indexing. | 604800000 |
|
| 257 |
6857
|
jones
|
| | | |
|
| 258 |
|
|
| | Default Value: 604800000 | |
|
| 259 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 260 |
6940
|
leinfelder
|
| database.indexingInitialDelay* | The delay in milliseconds before first indexing is executed. | 3600000 |
|
| 261 |
6857
|
jones
|
| | | |
|
| 262 |
|
|
| | Default Value: 3600000 | |
|
| 263 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 264 |
6940
|
leinfelder
|
| database.maximumIndexDelay* | The time in milliseconds that an indexing thread will wait when it | 5000 |
|
| 265 |
6857
|
jones
|
| | can't get a doc id before retrying the indexing. | |
|
| 266 |
|
|
| | | |
|
| 267 |
|
|
| | Default Value: 5000 | |
|
| 268 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 269 |
6940
|
leinfelder
|
| database.runDBConnectionRecycleThread* | Determines whether the database connection pool should run a thread to | off |
|
| 270 |
6857
|
jones
|
| | recycle connections. Possible values are "on" and "off" | |
|
| 271 |
|
|
| | | |
|
| 272 |
|
|
| | Default Value: off | |
|
| 273 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 274 |
6940
|
leinfelder
|
| database.cycleTimeOfDBConnection* | The time in milliseconds between connection recycling runs. | 30000 |
|
| 275 |
6857
|
jones
|
| | | |
|
| 276 |
|
|
| | Default Value: 30000 | |
|
| 277 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 278 |
6940
|
leinfelder
|
| database.queryignoredparams* | Parameters to ignore in a structured XML query. | enableediting |
|
| 279 |
6857
|
jones
|
| | | |
|
| 280 |
|
|
| | Default Value: enableediting,foo | |
|
| 281 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 282 |
6940
|
leinfelder
|
| database.usexmlindex* | Determines whether to use XML indexes when finding | true |
|
| 283 |
6857
|
jones
|
| | documents. Possible values are true and false. | |
|
| 284 |
|
|
| | | |
|
| 285 |
|
|
| | Default Value: true | |
|
| 286 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 287 |
6940
|
leinfelder
|
| database.appResultsetSize* | Determines the number of results that can be returned to an application from a query. | 7000 |
|
| 288 |
6857
|
jones
|
| | | |
|
| 289 |
|
|
| | Default Value: 7000 | |
|
| 290 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 291 |
6940
|
leinfelder
|
| database.webResultsetSize* | Determines the number of results that can be returned to a | 7000 |
|
| 292 |
6857
|
jones
|
| | Web browser from a query. | |
|
| 293 |
|
|
| | | |
|
| 294 |
|
|
| | Default Value: 7000 | |
|
| 295 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 296 |
6940
|
leinfelder
|
| database.xmlReturnfieldCount* | If the query results of a query are returned more times | 0 |
|
| 297 |
6857
|
jones
|
| | than this value, then those results will be inserted into the xml_queryresult | |
|
| 298 |
|
|
| | table in the database. For example, if you want results for | |
|
| 299 |
|
|
| | a query to be stored in xml_queryresult only when it has been requested | |
|
| 300 |
|
|
| | 50 times, set this value to 50. | |
|
| 301 |
|
|
| | | |
|
| 302 |
|
|
| | Default Value: 0 | |
|
| 303 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 304 |
6940
|
leinfelder
|
| database.queryresultStringLength* | The max size of the query result string in the queryresult table. This | 500000 |
|
| 305 |
6857
|
jones
|
| | should be set to some number less than 4000 if an Oracle | |
|
| 306 |
|
|
| | database is being used. | |
|
| 307 |
|
|
| | | |
|
| 308 |
|
|
| | Default Value: 500000 | |
|
| 309 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 310 |
6940
|
leinfelder
|
| database.queryresultCacheSize* | The number of query results that will be cached. | 500 |
|
| 311 |
6857
|
jones
|
| | | |
|
| 312 |
|
|
| | Default Value: 500 | |
|
| 313 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 314 |
6940
|
leinfelder
|
| database.queryCacheOn* | Determines whether query caching is turned on. Possible values are "on" and "off" | on |
|
| 315 |
6857
|
jones
|
| | | |
|
| 316 |
|
|
| | Default Value: on | |
|
| 317 |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 318 |
|
|
|
| 319 |
|
|
Authorization and Authentication Properties
|
| 320 |
|
|
-------------------------------------------
|
| 321 |
|
|
Metacat's authorization and authentication properties are described in the
|
| 322 |
|
|
table below. Properties that can only be edited manually in the ``metacat.properties``
|
| 323 |
6940
|
leinfelder
|
file are marked. All others are managed with the properties configuration utility.
|
| 324 |
6857
|
jones
|
|
| 325 |
|
|
Authorization and Authentication Properties
|
| 326 |
|
|
|
| 327 |
8597
|
leinfelder
|
.. _Authentication details: ./authinterface.html
|
| 328 |
|
|
|
| 329 |
6857
|
jones
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 330 |
|
|
| Property | Description | Example |
|
| 331 |
|
|
+===================================+===============================================================================+===============================================+
|
| 332 |
7425
|
leinfelder
|
| .. _auth-class: | | |
|
| 333 |
|
|
| | | |
|
| 334 |
8517
|
tao
|
| auth.class | The class used for user authentication. Currently, both the AuthFile and | edu.ucsb.nceas.metacat.AuthLdap |
|
| 335 |
|
|
| | AuthLdap classes are included in the Metacat distribution. | |
|
| 336 |
6857
|
jones
|
| | Note: If you implement another authentication strategy by implementing a Java | |
|
| 337 |
|
|
| | class that extends the AuthInterface interface and rebuilding Metacat, | |
|
| 338 |
|
|
| | change this property to the fully qualified class name of your custom | |
|
| 339 |
|
|
| | authentication mechanism. | |
|
| 340 |
|
|
| | | |
|
| 341 |
8517
|
tao
|
| | Default Value: edu.ucsb.nceas.metacat.authentication.AuthFile | |
|
| 342 |
6857
|
jones
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 343 |
6940
|
leinfelder
|
| auth.timeoutMinutes* | The number of minutes that a user will stay logged in to Metacat | 180 |
|
| 344 |
6857
|
jones
|
| | without any activity. | |
|
| 345 |
|
|
| | | |
|
| 346 |
|
|
| | Default Value: 180 | |
|
| 347 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 348 |
7425
|
leinfelder
|
| .. _auth-administrators: | | |
|
| 349 |
|
|
| | | |
|
| 350 |
6857
|
jones
|
| auth.administrators | A colon separated list of LDAP users or groups that have administrative | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org |
|
| 351 |
|
|
| | Metacat privileges. At least one user or group must be entered when | cn=yourgroup,o=NCEAS,dc=ecoinformatics,dc=org |
|
| 352 |
|
|
| | Metacat is first installed and configured. All accounts must exist | |
|
| 353 |
|
|
| | in LDAP in order to continue with the configuration. | |
|
| 354 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 355 |
8521
|
tao
|
| .. _auth-user-management-url: | | |
|
| 356 |
|
|
| | | |
|
| 357 |
|
|
| auth.userManagementUrl | A web page provides the user management such as creating a new user and | https://identity.nceas.ucsb.edu |
|
| 358 |
|
|
| | changing password. | |
|
| 359 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 360 |
8515
|
tao
|
| .. _auth-file-path: | | |
|
| 361 |
|
|
| | | |
|
| 362 |
|
|
| auth.file.path | The absolute path of the password file which stores the username/password | /var/metacat/certs/password |
|
| 363 |
|
|
| | and users' information. This file is used for the file-based authentication | |
|
| 364 |
|
|
| | mechanism. | |
|
| 365 |
|
|
| | | |
|
| 366 |
8597
|
leinfelder
|
| | Please see the `Authentication details`_ page for more information. | |
|
| 367 |
|
|
| | | |
|
| 368 |
8515
|
tao
|
| | Default Value: /var/metacat/certs/password | |
|
| 369 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 370 |
7425
|
leinfelder
|
| .. _auth-url: | | |
|
| 371 |
|
|
| | | |
|
| 372 |
6857
|
jones
|
| auth.url | The URL of the server that Metacat should use for authentication. | ldap://ldap.ecoinformatics.org:389/ |
|
| 373 |
|
|
| | | |
|
| 374 |
|
|
| | Default Value: ldap://ldap.ecoinformatics.org:389/ | |
|
| 375 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 376 |
7425
|
leinfelder
|
| .. _auth-surl: | | |
|
| 377 |
|
|
| | | |
|
| 378 |
6857
|
jones
|
| auth.surl | The URL of the server that Metacat should use for secure authentication. | ldap://ldap.ecoinformatics.org:389/ |
|
| 379 |
|
|
| | | |
|
| 380 |
|
|
| | Default Value: ldap://ldap.ecoinformatics.org:389/ | |
|
| 381 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 382 |
7425
|
leinfelder
|
| .. _auth-base: | | |
|
| 383 |
|
|
| | | |
|
| 384 |
6857
|
jones
|
| auth.base | The base part of the distinguished name that Metacat uses for authentication. | dc=ecoinformatics,dc=org |
|
| 385 |
|
|
| | | |
|
| 386 |
|
|
| | Default Value: dc=ecoinformatics,dc=org | |
|
| 387 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 388 |
7425
|
leinfelder
|
| .. _auth-allowedSubmitters: | | |
|
| 389 |
|
|
| | | |
|
| 390 |
6857
|
jones
|
| auth.allowedSubmitters | A colon delimited list of users who should be allowed to submit documents | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org |
|
| 391 |
|
|
| | to Metacat. If no value is specified, all users will be | |
|
| 392 |
|
|
| | allowed to submit documents. | |
|
| 393 |
|
|
| | | |
|
| 394 |
|
|
| | Default Value: (none) | |
|
| 395 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 396 |
7425
|
leinfelder
|
| .. _auth-deniedSubmitters: | | |
|
| 397 |
|
|
| | | |
|
| 398 |
6857
|
jones
|
| auth.deniedSubmitters | A colon delimited list of users who should NOT be allowed to | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org |
|
| 399 |
|
|
| | submit documents. If no value is specified, all users will be allowed to | |
|
| 400 |
|
|
| | submit documents. | |
|
| 401 |
|
|
| | | |
|
| 402 |
|
|
| | Default Value: (none) | |
|
| 403 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 404 |
6940
|
leinfelder
|
| ldap.connectTimeLimit* | The time in milliseconds allowed for LDAP server connections. | 5000 |
|
| 405 |
6857
|
jones
|
| | | |
|
| 406 |
|
|
| | Default Value: 5000 | |
|
| 407 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 408 |
6940
|
leinfelder
|
| ldap.searchTimeLimit* | The time in milliseconds allowed for LDAP server searches. | 3000 |
|
| 409 |
6857
|
jones
|
| | | |
|
| 410 |
|
|
| | Default Value: 30000 | |
|
| 411 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 412 |
6940
|
leinfelder
|
| ldap.searchCountLimit* | The number of return entries allowed for LDAP server searches. | 30000 |
|
| 413 |
6857
|
jones
|
| | | |
|
| 414 |
|
|
| | Default Value: 30000 | |
|
| 415 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 416 |
6940
|
leinfelder
|
| ldap.referral* | The type of LDAP referrals to use. Possible values are "follow", | follow |
|
| 417 |
6857
|
jones
|
| | "throw" or "none". Refer to LDAP documentation for further information. | |
|
| 418 |
|
|
| | | |
|
| 419 |
|
|
| | Default Value: follow | |
|
| 420 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 421 |
6940
|
leinfelder
|
| ldap.onlySecureConnection* | Determines whether to use only a secure LDAP server. | false |
|
| 422 |
6857
|
jones
|
| | Acceptable values are "true" and "false". | |
|
| 423 |
|
|
| | | |
|
| 424 |
|
|
| | Default Value: false | |
|
| 425 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 426 |
6940
|
leinfelder
|
| ldap.onlySecureReferalsConnection*| Determines whether to only use a secure referral server. | false |
|
| 427 |
6857
|
jones
|
| | Acceptable values are "true" and "false". | |
|
| 428 |
|
|
| | | |
|
| 429 |
|
|
| | Default Value: false | |
|
| 430 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 431 |
|
|
|
| 432 |
|
|
XML/EML Properties
|
| 433 |
|
|
------------------
|
| 434 |
6940
|
leinfelder
|
Metacat's XML/EML properties are described below. These properties can only be
|
| 435 |
|
|
edited manually in the metacat.properties file.
|
| 436 |
6857
|
jones
|
|
| 437 |
|
|
XML/EML Properties
|
| 438 |
|
|
|
| 439 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 440 |
|
|
| Property | Description | Example |
|
| 441 |
|
|
+=======================+==================================================================+===================================================+
|
| 442 |
|
|
| xml.saxparser | The SAX parser used to parse XML documents. Metacat | org.apache.xerces.parsers.SAXParser |
|
| 443 |
|
|
| | requires a SAX2-compatible XML parser. | |
|
| 444 |
|
|
| | | |
|
| 445 |
|
|
| | Default Value: org.apache.xerces.parsers.SAXParser | |
|
| 446 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 447 |
|
|
| xml.eml2_0_0namespace | The namespace of EML 2.0.0 documents. | eml://ecoinformatics.org/eml-2.0.0 |
|
| 448 |
|
|
| | | |
|
| 449 |
|
|
| | Default Value: eml://ecoinformatics.org/eml-2.0.0 | |
|
| 450 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 451 |
|
|
| xml.eml2_0_1namespace | The namespace of EML 2.0.1 documents. | eml://ecoinformatics.org/eml-2.0.1 |
|
| 452 |
|
|
| | | |
|
| 453 |
|
|
| | Default Value: eml://ecoinformatics.org/eml-2.0.1 | |
|
| 454 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 455 |
|
|
| xml.eml2_1_0namespace | The namespace of EML 2.1.0 documents. | eml://ecoinformatics.org/eml-2.1.0 |
|
| 456 |
|
|
| | | |
|
| 457 |
|
|
| | Default Value: eml://ecoinformatics.org/eml-2.1.0 | |
|
| 458 |
6937
|
leinfelder
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 459 |
6857
|
jones
|
| | | |
|
| 460 |
|
|
| xml.packagedoctype | The doctype of a package file. The system will only | -//ecoinformatics.org//eml-dataset-2.0.0beta6//EN |
|
| 461 |
|
|
| | recognize documents of this type as package files. | -//ecoinformatics.org//eml-dataset-2.0.0beta4//EN |
|
| 462 |
|
|
| | See: package documentation. | |
|
| 463 |
|
|
| | | |
|
| 464 |
|
|
| | Default Value: -//ecoinformatics.org//eml-dataset-2.0.0beta6//EN | |
|
| 465 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 466 |
|
|
| xml.accessdoctype | The doctype of an access control list (ACL) file. The system | -//ecoinformatics.org//eml-access-2.0.0beta6//EN |
|
| 467 |
|
|
| | will only recognize documents of this type as | -//ecoinformatics.org//eml-access-2.0.0beta4//EN |
|
| 468 |
|
|
| | access files. See: access control documentation. | |
|
| 469 |
|
|
| | | |
|
| 470 |
|
|
| | Default Value: -//ecoinformatics.org//eml-access-2.0.0beta6//EN | |
|
| 471 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 472 |
|
|
|
| 473 |
|
|
|
| 474 |
8230
|
leinfelder
|
Data Manager Properties
|
| 475 |
|
|
------------------------
|
| 476 |
|
|
The EML Data Manager is also included for extended data-query operations. Note that this feature is still experimental.
|
| 477 |
|
|
|
| 478 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 479 |
|
|
| Property | Description | Example |
|
| 480 |
|
|
+===================================+===============================================================================+===============================================+
|
| 481 |
|
|
| .. _datamanager.server: | | |
|
| 482 |
|
|
| | | |
|
| 483 |
|
|
| datamanager.server | The server for the Datamanager library to use for temporary db storage | localhost |
|
| 484 |
|
|
| | | |
|
| 485 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 486 |
|
|
| .. _datamanager.database: | | |
|
| 487 |
|
|
| | | |
|
| 488 |
|
|
| datamanager.database | The database name for the Datamanager | datamananger |
|
| 489 |
|
|
| | | |
|
| 490 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 491 |
|
|
| .. _datamanager.user: | | |
|
| 492 |
|
|
| | | |
|
| 493 |
|
|
| datamanager.user | The username for the Datamanager DB | datamananger |
|
| 494 |
|
|
| | | |
|
| 495 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 496 |
|
|
| .. _datamanager.password: | | |
|
| 497 |
|
|
| | | |
|
| 498 |
|
|
| datamanager.password | The password for the Datamanager user | datamananger |
|
| 499 |
|
|
| | | |
|
| 500 |
|
|
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
| 501 |
|
|
|
| 502 |
|
|
|
| 503 |
|
|
Additional Properties
|
| 504 |
|
|
----------------------
|
| 505 |
|
|
Additional configuration properties are described below, though there are many more that can be manually edited in the properties file directly.
|
| 506 |
|
|
|
| 507 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 508 |
|
|
| Property | Description | Example |
|
| 509 |
|
|
+=======================+==================================================================+===================================================+
|
| 510 |
8241
|
leinfelder
|
| .. _plugin.handlers: | | |
|
| 511 |
|
|
| | | |
|
| 512 |
8230
|
leinfelder
|
| plugin.handlers | Implementations of the plugin interface: | org.example.CustomActionHandler |
|
| 513 |
|
|
| | edu.ucsb.nceas.metacat.plugin.MetacatHandlerPlugin can be listed | |
|
| 514 |
|
|
| | | |
|
| 515 |
|
|
| | Default Value: blank | |
|
| 516 |
|
|
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|