Project

General

Profile

1 981 tao
#
2 666 jones
#  '$RCSfile$'
3
#   '$Author$'
4
# '$Revision$'
5
#     '$Date$'
6
#
7
8
Metacat: XML Metadata Database
9
------------------------------
10
11 1307 jones
Version: 1.2.0 Release
12 666 jones
13 1295 jones
Send feedback and bugs to: metacat-dev@ecoinformatics.org
14
                           http://bugzilla.ecoinformatics.org
15 696 jones
16 666 jones
Contributors: Matt Jones (jones@nceas.ucsb.edu)
17
              Chad Berkley (berkley@nceas.ucsb.edu)
18 981 tao
              Jing Tao (tao@nceas.ucsb.edu)
19 666 jones
              Jivka Bojilova (bojilova@nceas.ucsb.edu)
20
              Dan Higgins (higgins@nceas.ucsb.edu)
21 1311 berkley
22 982 berkley
Metacat is a flexible database storage system for XML formatted
23 666 jones
documents. Metacat models the structure of the XML document, therefore
24 1003 berkley
allowing storage of XML documents with arbitrary schemas. Metacat supports
25 1307 jones
several databases on the back-end, including Oracle, PostgreSQL and SQL
26
Server.  The server supports XML document storage, retrievel, query,
27
validation, and transformation (using the XSLT stylesheet language).
28
In addition, there is a mechanism for replicating the database
29
to other metacat instances for backup and load balancing purposes.
30
Metacat currently uses an LDAP database for authenticating users, but
31
was written to accomodate other authentication services as well.
32 666 jones
33 877 jones
Release Notes
34 1308 tao
35 1311 berkley
In this release, the structure of the xml_replication table was changed.
36
If you try to update a previously installed Metacat, you should run a script
37
file to updated the table structure before installation.
38 1310 tao
For Oracle user: At the SQLPLUS prompt type the following -
39 1308 tao
@src/xmlreplicationtable.sql
40 1310 tao
For Postgresql user: At install directory prompt type the following -
41
psql exp < src/xmlreplicationtable_postgres.sql
42 1311 berkley
(where 'exp' is the database name).
43 1308 tao
44 1311 berkley
If you are a new Metacat user, this step is unneeded.
45 1308 tao
46 1311 berkley
The build.xml file now has a property named datafilepath. It should be set
47 1317 tao
to the location of where you want your data files stored. The data directory
48
needs to be writeable by whatever user is running tomcat. If you are an
49
existing user, the data directory is now /<tomcatdir>/webapps/metacat/data
50 1311 berkley
where <tomcatdir> is the your tomcat installation directory where
51
your webapps directory is located and 'metacat' is the name of your servlet
52 1317 tao
instance. If you leave your data directory where it currently is, your
53
data files are web accessible.  If you do not want your data files to be
54
web accessible, move the data directory somewhere outside of your
55
webapps directory and change the datafilepath property in the
56
build.xml file and reinstall metacat.  Note that if you have existing data
57
files, they need to be moved to the new directory.  For more information
58
see bug 478.
59 1308 tao
60 877 jones
-------------
61 1307 jones
  New features in 1.2.0:
62
  1) Performance improvements through improved access control handling
63
  2) New replication features
64
  3) Added partial SSL support
65
  4) Additional bugs fixed, see http://bugzilla.ecoinformatics.org
66 1311 berkley
     474   Metacat in Ecoinfo hang
67
     475   Associate access doc to some docid which doesn't have ent...
68
     478   Security hole in Metacat for data file.
69
     536   Changes to Metacat build script to install stylesheets fr...
70
     457   Bug in replciation
71
     466   Create a JUnit class for Metacat action
72
     502   Security issues in replication
73
     503   Access control problem to a replicated doucment
74
     537   SQL error when first insert a new record into xml_replication...
75
     540   In force replication, some time has reversion number error
76
     541   Update dataset document which host is not in this metacat...
77
     542   Duplicate entries in xml_replication table
78
     543   Metacat hang in there when delta T replication
79
     554   xml_replication table in production metacat
80 1307 jones
     479   Debug message level
81
82 987 berkley
  New features in 1.1.0:
83 982 berkley
  1) Added functionality to export a zipped data package. The zip file contains
84
     all of the data and metadata as well as a rendered html summary of
85
     the metadata.
86 1311 berkley
  2) Changed version control mechanism.  Metacat can now accept any version of
87 982 berkley
     a document as long as the given version number is greater than the
88
     current one.  The new version number does not have to be exactly one
89
     greater than the current version.
90
  3) Update xerces.jar file to version 1.4.4
91 987 berkley
  Fixes in 1.1.0
92 1003 berkley
   1) Fixed ldap authentication bug.  Now, a user from a referred server cannot
93
      login with an incorrect password.
94 1311 berkley
   2) Changed the default behavior of the access control functionality with
95 1003 berkley
      respect to packaging.
96 1311 berkley
      If a member document in a data package doesn't have an access control list,
97
      access control rules of the main package document will not apply to the
98 1003 berkley
      member document.  Previously, package members, by default, inherited
99
      the access control rules of the main package document.
100 982 berkley
   3) Fixed minor bugs with document access control.
101
   4) Allowed new version of data files to be uploaded and handled.
102 1311 berkley
   5) Fixed bug where the client could not get the principals or groups from
103 1003 berkley
      the ldap server.
104 895 berkley
  Fixes in 1.0.3
105
   1) Fixed problem with Metacat not being able to query for group names when
106
      and LDAP referral server was down.  Added an LDAP timeout of 5 seconds
107
      for all referral activity.
108
   2) Fixed problem where invalid xml characters such as ampersands (&) could
109 1311 berkley
      be inserted into the resultset xml stream.
110 981 tao
  Fixes in 1.0.2
111
   1) Fixed problem with LDAP locking up Metacat when a referral server
112
      was not available.
113
  Fixes in 1.0.1
114
   1) Fixed problem with authenticating using LDAP referrals
115
   2) Fixed bug that prevent groups from being used in access documents
116 883 jones
Installation
117
------------
118
See the file "docs/user/metacatinstall.html" for detailed instructions.
119
120 861 jones
Documentation
121
-------------
122 1311 berkley
See the docs directory for detailed documentation and installation
123 666 jones
instructions.
124
125 1311 berkley
Details of the Metacat architecture can be found on the website for
126 666 jones
the Knowledge Network for Biocomplexity (KNB):
127
128 805 jones
  http://knb.ecoinformatics.org/software/metacat/
129 666 jones
130
Contributions to this work are welcome.  Please see the above web site
131
for details on how to contribute.
132
133 848 jones
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
134
-----------------------------------------------------------------------------
135 982 berkley
If you discover a bug
136 861 jones
please report it, either by email (above) or by using our bug tracking
137
system (http://bugzilla.ecoinformatics.org). There is a list of currently
138 1311 berkley
unimplemented features in Bugzilla that we are working on for the next
139 861 jones
release (no, we don't have a date yet!).
140 805 jones
141
Legalese
142
--------
143 666 jones
This software is copyrighted by The Regents of the University of California
144
and the National Center for Ecological Analysis and Synthesis
145
and licensed under the GNU GPL; see the 'LICENSE' file for
146
details.
147
148 1311 berkley
This material is based upon work supported by the
149 666 jones
National Science Foundation under Grant No. DEB99-80154 and DBI99-04777.
150
Any opinions, findings and conclusions or recomendations expressed in this
151 1311 berkley
material are those of the author(s) and do not necessarily reflect
152 666 jones
the views of the National Science Foundation (NSF).
153 1307 jones
154 1311 berkley
This product includes software developed by the Apache Software
155 1307 jones
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
156
for details.
157
158 1311 berkley
The source code, object code, and documentation in the com.oreilly.servlet
159 1307 jones
package is copyright and owned by Jason Hunter. See the cos-license.html file
160 1311 berkley
for details of the license.  Licensor retains title to and ownership of the
161 1307 jones
Software and all enhancements, modifications, and updates to the Software.