<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>17. Appendix: Metacat Properties &mdash; Metacat 2.6.0 documentation</title>
    <link rel="stylesheet" href="_static/bootstrap.min.css" type="text/css" />
    <link rel="stylesheet" href="_static/font-awesome/css/font-awesome.min.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/metacatui.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2.6.0',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Metacat 2.6.0 documentation" href="index.html" />
    <link rel="prev" title="16. Enabling Web Searches: Sitemaps" href="sitemaps.html" />
    <link rel="next" title="18. Appendix: Development Issues" href="development.html" /> 
  </head>
  <body>
  <div id="metacatDocs">
	  <div class="banner">
	      <a href="index.html"><img class="logo" src="_static/metacat-logo-white.png" /></a>
	      <a href="index.html"><h1 class="title">Metacat: Metadata and Data Management Server</h1></a>
	      <img class="logo-right" src="_static/nceas-logo-white.png" />
	  </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right">
        <span id="searchbox" style="display: none;">
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="18" />
              <input type="submit" value="Go" class="icon-search"/>
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>
        </span>
        </li>
        <script type="text/javascript">$('#searchbox').show(0);</script>
        <li class="right">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a>
           </li>
        <li class="right">
          <a href="development.html" title="18. Appendix: Development Issues"
             accesskey="N">next</a>
           </li>
        <li class="right">
          <a href="sitemaps.html" title="16. Enabling Web Searches: Sitemaps"
             accesskey="P">previous</a>
           </li>
        <li class="breadcrumb first"><a href="index.html">Metacat 2.6.0 documentation</a> &raquo;</li> 
      </ul>
      
    </div>

	
    <div class="document">
     	 <div class="documentwrapper">
	        <div class="bodywrapper">
	          <div class="body">
	            
  <div class="section" id="appendix-metacat-properties">
<h1>17. Appendix: Metacat Properties<a class="headerlink" href="#appendix-metacat-properties" title="Permalink to this headline">¶</a></h1>
<p>The most dynamic Metacat Properties are managed using Metacat&#8217;s Configuration
Interface (see <a class="reference internal" href="configuration.html"><em>Configuring Metacat</em></a>). These properties, as well as other,
rarely modified ones can be found in the metacat.properties file. For more
information about the properties, click one of the following:</p>
<ul class="simple">
<li>Server Properties</li>
<li>Application Properties</li>
<li>Database Properties</li>
<li>Authorization and Authentication Properties</li>
<li>XML/EML Properties</li>
</ul>
<div class="section" id="server-properties">
<h2>17.1. Server Properties<a class="headerlink" href="#server-properties" title="Permalink to this headline">¶</a></h2>
<p>All of Metacat&#8217;s server properties are managed with the form-based
configuration utility, though they can also be accessed More information on
each is included below.</p>
<p>Metacat Server Properties</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="64%" />
<col width="17%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="server-name">server.name</p>
</td>
<td><p class="first">The network host name used to access Metacat. Note that this is not necessarily
the physical name of the server running Metacat. The host name should not
include the protocol prefix (<a class="reference external" href="http://">http://</a>).</p>
<p class="last">Default Value: localhost</p>
</td>
<td>knb.ecoinformatics.org</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="server-httpport">server.httpPort</p>
</td>
<td><p class="first">The network port used to access Metacat for non-secure (standard) connections.
This is usually 80 if Apache Web server is running, and 8080 if Tomcat is running alone.</p>
<p class="last">Default Value: 80</p>
</td>
<td>80</td>
</tr>
<tr class="row-even"><td><p class="first last" id="server-httpsslport">server.httpSSLPort</p>
</td>
<td><p class="first">The network port used to access Metacat for secure connections. This is usually
443 if Apache Web server is running, and 8443 if Tomcat is running alone.</p>
<p class="last">Default Value: 443</p>
</td>
<td>443</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="application-properties">
<h2>17.2. Application Properties<a class="headerlink" href="#application-properties" title="Permalink to this headline">¶</a></h2>
<p>Metacat&#8217;s application properties are described below. Properties that can only
be edited manually in the <code class="docutils literal"><span class="pre">metacat.properties</span></code> file are marked. All
others are managed with the properties configuration utility.</p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="53%" />
<col width="21%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>application.metacatVersion*</td>
<td><p class="first">The Metacat version number. It is set by the build engineer
at build time. Usually, the value should never be changed.</p>
<p class="last">Default Value: X.X.X (where X.X.X is the current version of Metacat)</p>
</td>
<td>1.9.0</td>
</tr>
<tr class="row-odd"><td>application.metacatReleaseInfo*</td>
<td>Release information for display purposes. Typically the property
is set during the release candidate cycle to let users know which
candidate they are downloading.</td>
<td>Release Candidate 1</td>
</tr>
<tr class="row-even"><td><p class="first last" id="application-deploydir">application.deployDir</p>
</td>
<td>The directory where Web applications are deployed. Usually, the value
is a directory named &#8220;webapps&#8221; in the Tomcat installation directory.</td>
<td>/usr/local/tomcat/webapps</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="application-context">application.context</p>
</td>
<td>The name of the Metacat application directory in
the deployment directory. This corresponds to the first part of the
WAR file name (the part before .war). Most commonly, this
is &#8220;knb&#8221;, but it can be changed to other things.</td>
<td>knb</td>
</tr>
<tr class="row-even"><td><p class="first last" id="index-context">index.context</p>
</td>
<td>The name of the Metacat index webapp in
the deployment directory. Most commonly, this
is &#8220;metacat-index&#8221;, but it can be changed if needed.</td>
<td>metacat-index</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="ui-context">ui.context</p>
</td>
<td>The name of the Metacat UI directory in
the deployment directory. Often the UI is deployed
as the ROOT webapp, in which case the property should be blank (&#8220;&#8221;).</td>
<td>metacatui</td>
</tr>
<tr class="row-even"><td><p class="first last" id="application-default-style">application.default-style</p>
</td>
<td>A custom Metacat Web skin usually associated with
an organizational theme. If your organization has no
custom skin, leave the value as &#8220;default&#8221;.</td>
<td>default</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="application-knbsiteurl">application.knbSiteURL</p>
</td>
<td><p class="first">The main KNB website.</p>
<p class="last">Default Value: <a class="reference external" href="http://knb.ecoinformatics.org">http://knb.ecoinformatics.org</a></p>
</td>
<td><a class="reference external" href="http://knb.ecoinformatics.org">http://knb.ecoinformatics.org</a></td>
</tr>
<tr class="row-even"><td><p class="first last" id="application-datafilepath">application.datafilepath</p>
</td>
<td><p class="first">The directory in which to store data files. The directory should
be outside the Metacat installation directories so data files will not
be lost when Metacat is upgraded. The data file directory must be
writable by the user that starts Tomcat (and thus Metacat).</p>
<p class="last">Default Value: /var/metacat/data</p>
</td>
<td>/var/metacat/data</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="application-inlinedatafilepath">application.inlinedatafilepath</p>
</td>
<td><p class="first">The directory where inline data files will be stored. Inline
data files are created from data that is embedded in EML
metadata. The directory should be outside the Metacat installation
directories so data files will not be lost when Metacat is upgraded.
For clarity of data, this should probably not be the same as
<code class="docutils literal"><span class="pre">application.datafilepath</span></code>. The data file directory must be
writable by the user that starts Tomcat (and thus Metacat).</p>
<p class="last">Default Value: /var/metacat/inline-data</p>
</td>
<td>/var/metacat/inline-data</td>
</tr>
<tr class="row-even"><td><p class="first last" id="application-documentfilepath">application.documentfilepath</p>
</td>
<td><p class="first">The directory where metadata files will be stored.
The directory should be outside the Metacat installation directories
so document files will not be lost when Metacat is upgraded. For
clarity of organization, this should probably not be the same as
<code class="docutils literal"><span class="pre">application.datafilepath</span></code> or <code class="docutils literal"><span class="pre">application.inlinedatafilepath</span></code>.
The data file directory must be writable by the user that
starts Tomcat (and thus Metacat).</p>
<p class="last">Default Value: /var/metacat/documents</p>
</td>
<td>/var/metacat/documents</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="application-tempdir">application.tempDir</p>
</td>
<td><p class="first">The directory where the Metacat data registry stores temporary
files. The directory should not be the same as <code class="docutils literal"><span class="pre">application.datafilepath</span></code>
or <code class="docutils literal"><span class="pre">application.inlinedatafilepath</span></code> (or any other persistent file path)
because all files in this may be purged programmatically. The temporary
file directory must be writable by the user that starts Apache.</p>
<p class="last">Default Value: /var/metacat/temporary</p>
</td>
<td>/var/metacat/temporary</td>
</tr>
<tr class="row-even"><td><p class="first last" id="solr-homedir">solr.homeDir</p>
</td>
<td><p class="first">The directory where the Metacat index component stores the SOLR index.
The directory must be writable by the user that starts Tomcat.</p>
<p class="last">Default Value: /var/metacat/solr-home</p>
</td>
<td>/var/metacat/solr-home</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="database-properties">
<h2>17.3. Database Properties<a class="headerlink" href="#database-properties" title="Permalink to this headline">¶</a></h2>
<p>Metacat&#8217;s database properties are described next. Properties that can only be
edited manually in the metacat.properties file are marked. All others
are managed with the properties configuration utility.</p>
<p>Metacat Database Properties</p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="51%" />
<col width="28%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="database-connectionuri">database.connectionURI</p>
</td>
<td><p class="first">The JDBC connection URI for the main database instance of Metacat.
The URI is formatted like: <code class="docutils literal"><span class="pre">jdbc:&lt;database_type&gt;:thin&#64;&lt;your_server_name&gt;:1521:&lt;metacat_database_name&gt;</span></code>
NOTE: You must create an empty database prior to initial Metacat configuration.</p>
<p class="last">Default Value: <a class="reference external" href="jdbc:postgresql://localhost/metacat">jdbc:postgresql://localhost/metacat</a></p>
</td>
<td><code class="docutils literal"><span class="pre">jdbc:postgresql://yourserver.yourdomain.edu/metacat</span></code></td>
</tr>
<tr class="row-odd"><td><p class="first last" id="database-user">database.user</p>
</td>
<td>The user for the main database instance of Metacat. The user must
have already been created on the database.</td>
<td>metacat-user</td>
</tr>
<tr class="row-even"><td><p class="first last" id="database-password">database.password</p>
</td>
<td>The password of the user for the main database instance of Metacat.
The password must have already been created for the user.</td>
<td>securepassword4843</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="database-type">database.type</p>
</td>
<td>The type of database you are running. Currently, there are two supported
types, Oracle and Postgres.</td>
<td>postgres</td>
</tr>
<tr class="row-even"><td><p class="first last" id="database-driver">database.driver</p>
</td>
<td>The JDBC driver to be used to access the main database instance of Metacat.
There is one driver associated with each type of database.</td>
<td>org.postgresql.Driver</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="database-adapter">database.adapter</p>
</td>
<td>The adapter class that allows Metacat to access your database type.
There is one adapter associated with each type of database.</td>
<td>edu.ucsb.nceas.dbadapter.PostgresqlAdapter</td>
</tr>
<tr class="row-even"><td><p class="first last" id="database-scriptsuf">database.scriptsuffix.&lt;database_type&gt;</p>
</td>
<td><p class="first">The script suffix tells the system which database scripts to run
(postgres or oracle) when installing or updating database schema.</p>
<p class="last">Default Values:
database.scriptsuffix.postgres=postgres.sql
database.scriptsuffix.oracle=oracle.sql</p>
</td>
<td>postgres.sql</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="database-upgradeversion">database.upgradeVersion.&lt;database_version&gt;</p>
</td>
<td><p class="first">Which database scripts to run when updating database schema. There is a
database.upgradeVersion entry for every Metacat database schema version.
Each schema version corresponds to an application version.</p>
<p class="last">Default Values:
database.upgradeVersion.0.0.0=xmltables,loaddtdschema
database.upgradeVersion.1.2.0=upgrade-db-to-1.2
database.upgradeVersion.1.3.0=upgrade-db-to-1.3
database.upgradeVersion.1.4.0=upgrade-db-to-1.4
database.upgradeVersion.1.5.0=upgrade-db-to-1.5
database.upgradeVersion.1.6.0=upgrade-db-to-1.6
database.upgradeVersion.1.7.0=upgrade-db-to-1.7
database.upgradeVersion.1.8.0=upgrade-db-to-1.8
database.upgradeVersion.1.9.0=upgrade-db-to-1.9
database.upgradeVersion.2.0.0=upgrade-db-to-2.0</p>
</td>
<td>upgrade-db-to-1.2</td>
</tr>
<tr class="row-even"><td>database.initialConnections*</td>
<td><p class="first">The number of initial connection that Metacat creates to the database.</p>
<p class="last">Default Value: 5</p>
</td>
<td>5</td>
</tr>
<tr class="row-odd"><td>database.incrementConnections*</td>
<td><p class="first">The number of connections Metacat creates when it requires
more connections.</p>
<p class="last">Default Value: 5</p>
</td>
<td>5</td>
</tr>
<tr class="row-even"><td>database.maximumConnections*</td>
<td><p class="first">The maximum number of database connections Metacat can make.</p>
<p class="last">Default Value: 200</p>
</td>
<td>25</td>
</tr>
<tr class="row-odd"><td>database.maximumConnectionAge*</td>
<td><p class="first">The maximum time in milliseconds that a database connection can live.</p>
<p class="last">Default Value: 120000</p>
</td>
<td>120000</td>
</tr>
<tr class="row-even"><td>database.maximumConnectionTime*</td>
<td><p class="first">The maximum time in milliseconds that a database connection can
accumulate in actual connection time.</p>
<p class="last">Default Value: 60000</p>
</td>
<td>60000</td>
</tr>
<tr class="row-odd"><td>database.maximumUsageNumber*</td>
<td><p class="first">The maximum number of times a single connection can be used.</p>
<p class="last">Default Value: 100</p>
</td>
<td>100</td>
</tr>
<tr class="row-even"><td>database.numberOfIndexingThreads*</td>
<td><p class="first">The number of threads available for indexing.</p>
<p class="last">Default Value: 5</p>
</td>
<td>5</td>
</tr>
<tr class="row-odd"><td>database.indexingTimerTaskTime*</td>
<td><p class="first">The time in milliseconds between indexing.</p>
<p class="last">Default Value: 604800000</p>
</td>
<td>604800000</td>
</tr>
<tr class="row-even"><td>database.indexingInitialDelay*</td>
<td><p class="first">The delay in milliseconds before first indexing is executed.</p>
<p class="last">Default Value: 3600000</p>
</td>
<td>3600000</td>
</tr>
<tr class="row-odd"><td>database.maximumIndexDelay*</td>
<td><p class="first">The time in milliseconds that an indexing thread will wait when it
can&#8217;t get a doc id before retrying the indexing.</p>
<p class="last">Default Value: 5000</p>
</td>
<td>5000</td>
</tr>
<tr class="row-even"><td>database.runDBConnectionRecycleThread*</td>
<td><p class="first">Determines whether the database connection pool should run a thread to
recycle connections. Possible values are &#8220;on&#8221; and &#8220;off&#8221;</p>
<p class="last">Default Value: off</p>
</td>
<td>off</td>
</tr>
<tr class="row-odd"><td>database.cycleTimeOfDBConnection*</td>
<td><p class="first">The time in milliseconds between connection recycling runs.</p>
<p class="last">Default Value: 30000</p>
</td>
<td>30000</td>
</tr>
<tr class="row-even"><td>database.queryignoredparams*</td>
<td><p class="first">Parameters to ignore in a structured XML query.</p>
<p class="last">Default Value: enableediting,foo</p>
</td>
<td>enableediting</td>
</tr>
<tr class="row-odd"><td>database.usexmlindex*</td>
<td><p class="first">Determines whether to use XML indexes when finding
documents. Possible values are true and false.</p>
<p class="last">Default Value: true</p>
</td>
<td>true</td>
</tr>
<tr class="row-even"><td>database.appResultsetSize*</td>
<td><p class="first">Determines the number of results that can be returned to an application from a query.</p>
<p class="last">Default Value: 7000</p>
</td>
<td>7000</td>
</tr>
<tr class="row-odd"><td>database.webResultsetSize*</td>
<td><p class="first">Determines the number of results that can be returned to a
Web browser from a query.</p>
<p class="last">Default Value: 7000</p>
</td>
<td>7000</td>
</tr>
<tr class="row-even"><td>database.xmlReturnfieldCount*</td>
<td><p class="first">If the query results of a query are returned more times
than this value, then those results will be inserted into the xml_queryresult
table in the database. For example, if you want results for
a query to be stored in xml_queryresult only when it has been requested
50 times, set this value to 50.</p>
<p class="last">Default Value: 0</p>
</td>
<td>0</td>
</tr>
<tr class="row-odd"><td>database.queryresultStringLength*</td>
<td><p class="first">The max size of the query result string in the queryresult table. This
should be set to some number less than 4000 if an Oracle
database is being used.</p>
<p class="last">Default Value: 500000</p>
</td>
<td>500000</td>
</tr>
<tr class="row-even"><td>database.queryresultCacheSize*</td>
<td><p class="first">The number of query results that will be cached.</p>
<p class="last">Default Value: 500</p>
</td>
<td>500</td>
</tr>
<tr class="row-odd"><td>database.queryCacheOn*</td>
<td><p class="first">Determines whether query caching is turned on. Possible values are &#8220;on&#8221; and &#8220;off&#8221;</p>
<p class="last">Default Value: on</p>
</td>
<td>on</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="authorization-and-authentication-properties">
<h2>17.4. Authorization and Authentication Properties<a class="headerlink" href="#authorization-and-authentication-properties" title="Permalink to this headline">¶</a></h2>
<p>Metacat&#8217;s authorization and authentication properties are described in the
table below. Properties that can only be edited manually in the <code class="docutils literal"><span class="pre">metacat.properties</span></code>
file are marked. All others are managed with the properties configuration utility.</p>
<p>Authorization and Authentication Properties</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="49%" />
<col width="29%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="auth-class">auth.class</p>
</td>
<td><p class="first">The class used for user authentication. Currently, both the AuthFile and
AuthLdap classes are included in the Metacat distribution.
Note: If you implement another authentication strategy by implementing a Java
class that extends the AuthInterface interface and rebuilding Metacat,
change this property to the fully qualified class name of your custom
authentication mechanism.</p>
<p class="last">Default Value: edu.ucsb.nceas.metacat.authentication.AuthFile</p>
</td>
<td>edu.ucsb.nceas.metacat.AuthLdap</td>
</tr>
<tr class="row-odd"><td>auth.timeoutMinutes*</td>
<td><p class="first">The number of minutes that a user will stay logged in to Metacat
without any activity.</p>
<p class="last">Default Value: 180</p>
</td>
<td>180</td>
</tr>
<tr class="row-even"><td><p class="first last" id="auth-administrators">auth.administrators</p>
</td>
<td>A colon separated list of LDAP users or groups that have administrative
Metacat privileges. At least one user or group must be entered when
Metacat is first installed and configured. All accounts must exist
in LDAP in order to continue with the configuration.</td>
<td>uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org
cn=yourgroup,o=NCEAS,dc=ecoinformatics,dc=org</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="auth-user-management-url">auth.userManagementUrl</p>
</td>
<td>A web page provides the user management such as creating a new user and
changing password.</td>
<td><a class="reference external" href="https://identity.nceas.ucsb.edu">https://identity.nceas.ucsb.edu</a></td>
</tr>
<tr class="row-even"><td><p class="first last" id="auth-file-path">auth.file.path</p>
</td>
<td><p class="first">The absolute path of the password file which stores the username/password
and users&#8217; information. This file is used for the file-based authentication
mechanism.</p>
<p>Please see the <a class="reference external" href="./authinterface.html">Authentication details</a> page for more information.</p>
<p class="last">Default Value: /var/metacat/certs/password</p>
</td>
<td>/var/metacat/certs/password</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="auth-url">auth.url</p>
</td>
<td><p class="first">The URL of the server that Metacat should use for authentication.</p>
<p class="last">Default Value: <a class="reference external" href="ldap://ldap.ecoinformatics.org:389/">ldap://ldap.ecoinformatics.org:389/</a></p>
</td>
<td><a class="reference external" href="ldap://ldap.ecoinformatics.org:389/">ldap://ldap.ecoinformatics.org:389/</a></td>
</tr>
<tr class="row-even"><td><p class="first last" id="auth-surl">auth.surl</p>
</td>
<td><p class="first">The URL of the server that Metacat should use for secure authentication.</p>
<p class="last">Default Value: <a class="reference external" href="ldap://ldap.ecoinformatics.org:389/">ldap://ldap.ecoinformatics.org:389/</a></p>
</td>
<td><a class="reference external" href="ldap://ldap.ecoinformatics.org:389/">ldap://ldap.ecoinformatics.org:389/</a></td>
</tr>
<tr class="row-odd"><td><p class="first last" id="auth-base">auth.base</p>
</td>
<td><p class="first">The base part of the distinguished name that Metacat uses for authentication.</p>
<p class="last">Default Value: dc=ecoinformatics,dc=org</p>
</td>
<td>dc=ecoinformatics,dc=org</td>
</tr>
<tr class="row-even"><td><p class="first last" id="auth-allowedsubmitters">auth.allowedSubmitters</p>
</td>
<td><p class="first">A colon delimited list of users who should be allowed to submit documents
to Metacat. If no value is specified, all users will be
allowed to submit documents.</p>
<p class="last">Default Value: (none)</p>
</td>
<td>uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="auth-deniedsubmitters">auth.deniedSubmitters</p>
</td>
<td><p class="first">A colon delimited list of users who should NOT be allowed to
submit documents. If no value is specified, all users will be allowed to
submit documents.</p>
<p class="last">Default Value: (none)</p>
</td>
<td>uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org</td>
</tr>
<tr class="row-even"><td>ldap.connectTimeLimit*</td>
<td><p class="first">The time in milliseconds allowed for LDAP server connections.</p>
<p class="last">Default Value: 5000</p>
</td>
<td>5000</td>
</tr>
<tr class="row-odd"><td>ldap.searchTimeLimit*</td>
<td><p class="first">The time in milliseconds allowed for LDAP server searches.</p>
<p class="last">Default Value: 30000</p>
</td>
<td>3000</td>
</tr>
<tr class="row-even"><td>ldap.searchCountLimit*</td>
<td><p class="first">The number of return entries allowed for LDAP server searches.</p>
<p class="last">Default Value: 30000</p>
</td>
<td>30000</td>
</tr>
<tr class="row-odd"><td>ldap.referral*</td>
<td><p class="first">The type of LDAP referrals to use. Possible values are &#8220;follow&#8221;,
&#8220;throw&#8221; or &#8220;none&#8221;. Refer to LDAP documentation for further information.</p>
<p class="last">Default Value: follow</p>
</td>
<td>follow</td>
</tr>
<tr class="row-even"><td>ldap.onlySecureConnection*</td>
<td><p class="first">Determines whether to use only a secure LDAP server.
Acceptable values are &#8220;true&#8221; and &#8220;false&#8221;.</p>
<p class="last">Default Value: false</p>
</td>
<td>false</td>
</tr>
<tr class="row-odd"><td>ldap.onlySecureReferalsConnection*</td>
<td><p class="first">Determines whether to only use a secure referral server.
Acceptable values are &#8220;true&#8221; and &#8220;false&#8221;.</p>
<p class="last">Default Value: false</p>
</td>
<td>false</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="xml-eml-properties">
<h2>17.5. XML/EML Properties<a class="headerlink" href="#xml-eml-properties" title="Permalink to this headline">¶</a></h2>
<p>Metacat&#8217;s XML/EML properties are described below. These properties can only be
edited manually in the metacat.properties file.</p>
<p>XML/EML Properties</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="47%" />
<col width="36%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>xml.saxparser</td>
<td><p class="first">The SAX parser used to parse XML documents. Metacat
requires a SAX2-compatible XML parser.</p>
<p class="last">Default Value: org.apache.xerces.parsers.SAXParser</p>
</td>
<td>org.apache.xerces.parsers.SAXParser</td>
</tr>
<tr class="row-odd"><td>xml.eml2_0_0namespace</td>
<td><p class="first">The namespace of EML 2.0.0 documents.</p>
<p class="last">Default Value: eml://ecoinformatics.org/eml-2.0.0</p>
</td>
<td>eml://ecoinformatics.org/eml-2.0.0</td>
</tr>
<tr class="row-even"><td>xml.eml2_0_1namespace</td>
<td><p class="first">The namespace of EML 2.0.1 documents.</p>
<p class="last">Default Value: eml://ecoinformatics.org/eml-2.0.1</p>
</td>
<td>eml://ecoinformatics.org/eml-2.0.1</td>
</tr>
<tr class="row-odd"><td>xml.eml2_1_0namespace</td>
<td><p class="first">The namespace of EML 2.1.0 documents.</p>
<p class="last">Default Value: eml://ecoinformatics.org/eml-2.1.0</p>
</td>
<td>eml://ecoinformatics.org/eml-2.1.0</td>
</tr>
<tr class="row-even"><td>xml.packagedoctype</td>
<td><p class="first">The doctype of a package file. The system will only
recognize documents of this type as package files.
See: package documentation.</p>
<p class="last">Default Value: -//ecoinformatics.org//eml-dataset-2.0.0beta6//EN</p>
</td>
<td>-//ecoinformatics.org//eml-dataset-2.0.0beta6//EN
-//ecoinformatics.org//eml-dataset-2.0.0beta4//EN</td>
</tr>
<tr class="row-odd"><td>xml.accessdoctype</td>
<td><p class="first">The doctype of an access control list (ACL) file. The system
will only recognize documents of this type as
access files. See: access control documentation.</p>
<p class="last">Default Value: -//ecoinformatics.org//eml-access-2.0.0beta6//EN</p>
</td>
<td>-//ecoinformatics.org//eml-access-2.0.0beta6//EN
-//ecoinformatics.org//eml-access-2.0.0beta4//EN</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="data-manager-properties">
<h2>17.6. Data Manager Properties<a class="headerlink" href="#data-manager-properties" title="Permalink to this headline">¶</a></h2>
<p>The EML Data Manager is also included for extended data-query operations. Note that this feature is still experimental.</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="49%" />
<col width="29%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="datamanager-server">datamanager.server</p>
</td>
<td>The server for the Datamanager library to use for temporary db storage</td>
<td>localhost</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="datamanager-database">datamanager.database</p>
</td>
<td>The database name for the Datamanager</td>
<td>datamananger</td>
</tr>
<tr class="row-even"><td><p class="first last" id="datamanager-user">datamanager.user</p>
</td>
<td>The username for the Datamanager DB</td>
<td>datamananger</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="datamanager-password">datamanager.password</p>
</td>
<td>The password for the Datamanager user</td>
<td>datamananger</td>
</tr>
</tbody>
</table>
<blockquote>
<div></div></blockquote>
</div>
<div class="section" id="id1">
<h2>17.7. EZID Properties<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>The EZID service assigning Digital Object Identifiers (DOIs) is included in the Metacat service.</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="49%" />
<col width="29%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="guid-ezid-enabled">guid.ezid.enabled</p>
</td>
<td>The enabled status of the EZID service</td>
<td>true</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="guid-ezid-username">guid.ezid.username</p>
</td>
<td>A registered user name in the EZID service</td>
<td>apitest</td>
</tr>
<tr class="row-even"><td><p class="first last" id="guid-ezid-password">guid.ezid.password</p>
</td>
<td>The password for the user name</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><p class="first last" id="guid-ezid-baseurl">guid.ezid.baseurl</p>
</td>
<td>The base ulr of the specified EZID service</td>
<td><a class="reference external" href="https://ezid.cdlib.org/">https://ezid.cdlib.org/</a></td>
</tr>
<tr class="row-even"><td><p class="first last" id="guid-ezid-doishoulder-1">guid.ezid.doishoulder.1</p>
</td>
<td>The DOI shoulder associated with the EZId account</td>
<td>doi:10.5072/FK2</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="additional-properties">
<h2>17.8. Additional Properties<a class="headerlink" href="#additional-properties" title="Permalink to this headline">¶</a></h2>
<p>Additional configuration properties are described below, though there are many more that can be manually edited in the properties file directly.</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="47%" />
<col width="36%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<th class="head">Example</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><p class="first last" id="plugin-handlers">plugin.handlers</p>
</td>
<td><p class="first">Implementations of the plugin interface:
edu.ucsb.nceas.metacat.plugin.MetacatHandlerPlugin can be listed</p>
<p class="last">Default Value: blank</p>
</td>
<td>org.example.CustomActionHandler</td>
</tr>
</tbody>
</table>
</div>
</div>


	          </div>
	        </div>
      	</div>

	
	      <div class="clearer"></div>
	    </div>
	    <div class="footer">
	    	<div class="footerNav">
				
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right">
        <span id="searchbox" style="display: none;">
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="18" />
              <input type="submit" value="Go" class="icon-search"/>
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>
        </span>
        </li>
        <script type="text/javascript">$('#searchbox').show(0);</script>
        <li class="right">
          <a href="genindex.html" title="General Index"
             >index</a>
           </li>
        <li class="right">
          <a href="development.html" title="18. Appendix: Development Issues"
             >next</a>
           </li>
        <li class="right">
          <a href="sitemaps.html" title="16. Enabling Web Searches: Sitemaps"
             >previous</a>
           </li>
        <li class="breadcrumb first"><a href="index.html">Metacat 2.6.0 documentation</a> &raquo;</li> 
      </ul>
      
    </div>
			</div>
	    	<div class="small-print">
			      &copy; Copyright 2012, Regents of the University of California.
			      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.1.
			</div>
	    </div>
	</div>
  </body>
</html>