Project

General

Profile

metacat / docs / user / properties.html @ 881

1
<!--
2
  * properties.html
3
  *
4
  *      Authors: Chad Berkley
5
  *    Copyright: 2000 Regents of the University of California and the
6
  *               National Center for Ecological Analysis and Synthesis
7
  *  For Details: http://www.nceas.ucsb.edu/
8
  *      Created: 2001 January 23
9
  *      Version: 
10
  *    File Info: '$ '
11
  * 
12
  * 
13
-->
14
<HTML>
15
<HEAD>
16
<TITLE>Metacat</TITLE>
17
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css">
18
</HEAD> 
19
<BODY>
20
  <table width="100%">
21
    <tr>
22
      <td class="tablehead" colspan="2"><p class="label">Metacat Properties File</p></td>
23
      <td class="tablehead" colspan="2" align="right">
24
        <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> | 
25
        <a href="./unimplem.html">Next</a>
26
      </td>
27
    </tr>
28
  </table>
29
  <p>Metacat Server has many dynamically settable properties.  All of them 
30
  are kept in the Metacat.properties file.  Most can be set from within
31
  the build file when you first install Metacat.  The following is a summary
32
  of each property and its function.</p>
33
  <table border="1">
34
    <tr>
35
      <td><b>Property</b></td>
36
      <td><b>Description</b></td>
37
      <td><b>Possible or default value</b></td>
38
    </tr>
39
    <tr>
40
      <td>user</td>
41
      <td>The username that Metacat uses to access the backend database.</td>
42
      <td>&nbsp;</td>
43
    </tr>
44
    <tr>
45
      <td>password</td>
46
      <td>The password that Metacat uses to access the backend database.</td>
47
      <td>&nbsp;</td>
48
    </tr>
49
    <tr>
50
      <td>defaultDB</td>
51
      <td>The JDBC connection string that Metacat uses to connect to the backend
52
      database.</td>
53
      <td>jdbc:oracle:thin:@server.domain.com:1521:Metacat</td>
54
    </tr>
55
    <tr>
56
      <td>dbDriver</td>
57
      <td>The JDBC driver to be used to access the backend database.</td>
58
      <td>oracle.jdbc.driver.OracleDriver</td>
59
    </tr>
60
    <tr>
61
      <td>dbAdapter</td>
62
      <td>The name of the RDBMS Adapter Class that Metacat uses to get specific
63
          features in the backend database.</td>
64
      <td>edu.ucsb.nceas.dbadapter.OracleAdapter</td>
65
    </tr>
66
    <tr>
67
      <td>initialConnections</td>
68
      <td>The number of initial connection that Metacat creates to the database.</td>
69
      <td>5</td>
70
    </tr>
71
    <tr>
72
      <td>incrementConnections</td>
73
      <td>The number of connections that are created when Metacat needs more 
74
      connections.</td>
75
      <td>5</td>
76
    </tr>
77
    <tr>
78
      <td>maximumConnections</td>
79
      <td>The maximum number of database connection Metacat can make.</td>
80
      <td>10</td>
81
    </tr>
82
    <tr>
83
      <td>config-dir</td>
84
      <td>directory where the style-sets exist</td>
85
      <td>/opt/tomcat/webapps/metacat/lib</td>
86
    </tr>
87
    <tr>
88
      <td>default-style</td>
89
      <td>the style-set to use if qformat is set to 'html'</td>
90
      <td></td>
91
    </tr>
92
    <tr>
93
      <td>xmlcatalogfile</td>
94
      <td>The default file type catalog file location.<br>
95
      DEPRECATED</td>
96
      <td>/opt/tomcat/webapps/xmltodb/catalog.txt</td>
97
    </tr>
98
    <tr>
99
      <td>siteCode</td>
100
      <td>The code for the current site.</td>
101
      <td>NCEAS</td>
102
    </tr>
103
    <tr>
104
      <td>accNumSeparator</td>
105
      <td>The separator that is used to separate the three parts 
106
          of the accession number: codename, sequence and revision number.
107
          It should be synchronized with the Client application.</td>
108
      <td>. (period)</td>
109
    </tr>
110
    <tr>
111
      <td>saxparser</td>
112
      <td>The SAX parser to be used to <a href="./saxparser.html">parse</a> 
113
      XML documents.</td>
114
      <td>org.apache.xerces.parsers.SAXParser</td>
115
    </tr>
116
    <tr>
117
      <td>servletpath</td>
118
      <td>The path on the local machine to the Metacat Servlet.</td>
119
      <td>/knb/servlet/metacat</td>
120
    </tr>
121
    <tr>
122
      <td>htmlpath</td>
123
      <td>The path to the HTML server for this Metacat context.  This is where
124
      the Metacat web interface would be served from.</td>
125
      <td>/knb</td>
126
    </tr>
127
    <tr>
128
      <td>packagedoctype</td>
129
      <td>The doctype of a package file.  The system will only recognize documents
130
      of this type as a <a href="./packages.html">Package</a> files.</td>
131
      <td>-//NCEAS//eml-dataset-2.0//EN</td>
132
    </tr>
133
    <tr>
134
      <td>accessdoctype</td>
135
      <td>The doctype of an access control list (ACL) file.  The system will 
136
          only recognize documents of this type as an <a href="./acontrol.html">Access</a> 
137
          files.</td>
138
      <td>-//NCEAS//eml-access-2.0//EN</td>
139
    </tr>
140
    <tr>
141
      <td>server</td>
142
      <td>The server on which this Metacat server runs.</td>
143
      <td>dev.nceas.ucsb.edu:8090</td>
144
    </tr>
145
    <tr>
146
      <td>authclass</td>
147
      <td>The authorization plugin to use.  In this example, LDAP.</td>
148
      <td>edu.ucsb.nceas.metacat.AuthLdap</td>
149
    </tr>
150
    <tr>
151
      <td>ldapurl</td>
152
      <td>The path to your LDAP server (if LDAP authentication is being used.</td>
153
      <td>ldap://ldap.nceas.ucsb.edu:389/</td>
154
    </tr>
155
    <tr>
156
      <td>ldapsurl</td>
157
      <td>The path to your LDAP server with SSL support.
158
          (if LDAP authentication is being used and if your LDAT server is set
159
          with SSL support.) 2 ports are used to listen: 389 for plain sockets 
160
          and 636 for SSL Sockect. If your LDAP server is not set to support SSL
161
          this property should be the same as ldapurl, else Metacat will
162
          retieve an error.</td>
163
      <td>ldap://ldap.nceas.ucsb.edu:636/</td>
164
    </tr>
165
    <tr>
166
      <td>ldapbase</td>
167
      <td>LDAP base parameters for the LDAP server.</td>
168
      <td>o=NCEAS,c=US</td>
169
    </tr>
170
    <tr>
171
      <td>referral</td>
172
      <td>The type of ldap referrals you want to use.  Eithe 'follow', 'throw' or 
173
      'none'.  See the ldap documentation for further information</td>
174
      <td>follow</td>
175
    </tr>
176
    <tr>
177
      <td>deltaT</td>
178
      <td>The default delta T used for <a href="./replication.html">replication</a>.</td>
179
      <td>60</td>
180
    </tr>
181
    <tr>
182
      <td>replicationpath</td>
183
      <td>The relative path to the replication servlet.</td>
184
      <td>/knb/servlet/replication</td>
185
    </tr>
186
    <tr>
187
      <td>replicationlog</td>
188
      <td>Location of the replication log file.</td>
189
      <td>/logs/Metacatreplication.log</td>
190
    </tr>
191
    <tr>
192
      <td>dtdPath</td>
193
      <td>Path to which DTDs are uploaded.</td>
194
      <td>/opt/tomcat/webapps/knb/dtd/</td>
195
    </tr>
196
    <tr>
197
      <td>dtdURL</td>
198
      <td>The HTTP accessable URL to the DTD files specified in dtdPath.</td>
199
      <td>http://server.domain.com/knb/dtd/</td>
200
    </tr>
201
    <tr>
202
      <td>datafilepath</td>
203
      <td>The path to which you want data files uploaded.</td>
204
      <td>/opt/tomcat/webapps/knb/data</td>
205
    </tr>
206
    <tr>
207
      <td>certPath</td>
208
      <td>path to the SSL keys for secure transmissions.</td>
209
      <td>/opt/tomcat/webapps/metacat/lib</td>
210
    </tr>
211
  </table>
212
  
213
  <br>
214
  <a href="./datafiles.html">Back</a> | <a href="./metacattour.html">Home</a> | 
215
  <a href="./unimplem.html">Next</a>
216
  
217

    
218
</BODY>
219
</HTML>