You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cr...@apache.org on 2001/09/16 07:59:42 UTC

cvs commit: jakarta-tomcat-4.0 BUILDING.txt RELEASE-NOTES-4.0.txt

craigmcc    01/09/15 22:59:42

  Modified:    .        BUILDING.txt RELEASE-NOTES-4.0.txt
  Log:
  Update BUILDING.txt to reflect the revised requirements for dependent
  packages.
  
  Update release notes to describe the APIs that are now made available to
  all web applications (in common/lib or lib).
  
  Revision  Changes    Path
  1.4       +34 -70    jakarta-tomcat-4.0/BUILDING.txt
  
  Index: BUILDING.txt
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/BUILDING.txt,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- BUILDING.txt	2001/09/11 16:54:41	1.3
  +++ BUILDING.txt	2001/09/16 05:59:42	1.4
  @@ -1,4 +1,4 @@
  -$Id: BUILDING.txt,v 1.3 2001/09/11 16:54:41 craigmcc Exp $
  +$Id: BUILDING.txt,v 1.4 2001/09/16 05:59:42 craigmcc Exp $
   
   
                  Building The Tomcat 4.0 Servlet/JSP Container
  @@ -111,18 +111,15 @@
   
   * Unpack the binary distribution into a convenient location so that the
     distribution resides in its own directory (conventionally named
  -  "jakarta-regexp").  For the purposes of the remainder of this document,
  -  the symbolic name "${regexp.home}" is used to refer to the full pathname
  -  of this directory.
  +  "jakarta-regexp-x.y").
   
  -FIXME:  This step and the associated stuff in build.xml files needs to be
  -made independent of the actual jakarta-regexp version number.
   
  -
   (5) Download and Install the Servlet API Binary Distribution
   
   NOTE:  Alternatively, you can download the sources of the
  -"jakarta-servletapi-4" subproject, and build a binary distribution yourself.
  +"jakarta-servletapi-4" subproject, and build a binary distribution yourself,
  +or use the binary distribution that is available with binary distributions
  +of Tomcat 4.0.
   
   * Download a binary distribution from:
   
  @@ -138,11 +135,8 @@
     distribution resides in its own directory.
   
   
  -(6) Download and Install JDBC Optional Package API (OPTIONAL)
  +(6) Download and Install JDBC Optional Package API
   
  -NOTE:  This step is only required if you wish to build the Tyrex connection
  -pool implementation for JNDI-accessed data sources.
  -
   * Download the JDBC Optional Pacakge API package (version 2.0) from:
   
       http://java.sun.com/products/jdbc/download.html
  @@ -164,10 +158,6 @@
   
   (8) Download and Install the JNDI 1.2.1 Reference Implementation
   
  -NOTE:  This step is required to build Tomcat 4.0, even when you are running
  -a JDK 1.3 (or later) platform that includes the JNDI classes.  This is because
  -the Tomcat build process includes "jndi.jar" into the binary distribution.
  -
   * Download the Java Naming and Directory Interface (JNDI) package,
     (version 1.2.1 or later) from
   
  @@ -176,6 +166,9 @@
   * Unpack the reference implementation into a convenient location so that
     it resides in its own subdirectory.
   
  +* You will also need the "LDAP Provider" (ldap.jar), available on the
  +  same download page.  Be sure that you unpack "ldap.jar" into the "lib"
  +  subdirectory of the JNDI directory, parallel to "jndi.jar".
   
   (9) Download and Install the Java Activation Framework 1.0.1
   
  @@ -207,11 +200,8 @@
     it resides in its own subdirectory.
   
   
  -(12) Download and Install the Java Transaction APIs (OPTIONAL)
  +(12) Download and Install the Java Transaction APIs
   
  -NOTE:  This step is only required if you wish to build the Tyrex connection
  -pool implementation for JNDI-accessed data sources.
  -
   * Download the Java Transaction API (JTA) package (version 1.0.1) from:
   
       http://java.sun.com/products/jta/
  @@ -220,27 +210,27 @@
     own subdirectory.
   
   
  -(13) Download and Install the JUnit Testing Package (OPTIONAL)
  +(13) Download and Install the Tyrex Data Source Package
   
  -NOTE:  This step is only required if you wish to build and execute the unit
  -tests that are part of the Tomcat 4.0 source base.
  +NOTE:  This step is only required if you wish to build the Tyrex connection
  +pool implementation for JNDI-accessed data sources.
   
  -* Download the JUnit unit test package (version 3.7 or later) from:
  +* Download the Tyrex JAR or release (version 0.9.7) from:
   
  -    http://www.junit.org/
  +    http://tyrex.exolab.org/download.html
   
   * Unpack the package into a convenient location so that it resides in its
     own subdirectory.
   
   
  -(14) Download and Install the Tyrex Data Source Package (OPTIONAL)
  +(14) Download and Install the JUnit Testing Package (OPTIONAL)
   
  -NOTE:  This step is only required if you wish to build the Tyrex connection
  -pool implementation for JNDI-accessed data sources.
  +NOTE:  This step is only required if you wish to build and execute the unit
  +tests that are part of the Tomcat 4.0 source base.
   
  -* Download the Tyrex JAR or release (version 0.9.7) from:
  +* Download the JUnit unit test package (version 3.7 or later) from:
   
  -    http://tyrex.exolab.org/download.html
  +    http://www.junit.org/
   
   * Unpack the package into a convenient location so that it resides in its
     own subdirectory.
  @@ -254,49 +244,23 @@
   definitions local to this subproject) and/or your user home directory (for
   property definitions shared across subprojects).  You can use the included
   "build.properties.sample" file as a starting point for this.
  -
  -Tomcat has several external dependencies that are satisfied by configuring
  -appropriate values in your <code>build.properties</code> file.  You must set
  -the following properties:
  -
  -  Property Name     Description
  -  ----------------  --------------------------------------------------------
  -
  -  activation.home   Pathname to directory containing the Java Activation
  -                    Framework package, version 1.0.1 or later
  -
  -  jmx.home          Pathname to directory containing the Java Management
  -                    Extensions (JMX) Reference Implementation, version 1.0
  -                    or later
  -
  -  jndi.home         Pathname to directory containing the Java Naming and
  -                    Directory Interface (JNDI) Reference Implementation,
  -                    version 1.2.1 or later
  -
  -  jsse.home         Pathname to directory containing the Java Secure Sockets
  -                    Extension (JSSE) Reference Implementation, version 1.0.2
  -                    or later
  -
  -  junit.jar         Pathname to the "junit.jar" file from JUnit, version 3.7
  -                    or later
  -
  -  mail.home         Pathname to the directory containing the JavaMail package,
  -                    version 1.2 or later
  -
  -  regexp.home       Pathname to directory containing a binary distribution of
  -                    the Jakarta Regexp Project, version 1.2
  -
  -  servletapi.home   Pathname to directory containing a binary distribution of
  -                    the Servlet 2.3/JSP 1.2 API classes
   
  -FIXME:  Properties for jdbc2_0-stdext.jar,
  -jta-spec1_0_1.jar, tyrex-0.9.7.0.jar
  +Tomcat has many external dependencies that are satisfied by configuring
  +appropriate values in your <code>build.properties</code> file.  The easiest
  +way to satisfy these dependencies is to copy the "build.properties.sample"
  +file (in the top-level Tomcat source directory) to "build.properties", and
  +then edit it to suit your environment.  On Unix, this would be done as:
  +
  +  cd ${tomcat.source}
  +  cp build.properties.sample build.properties
  +  emacs build.properties
  +
  +NOTE:  Be *sure* that you do not check "build.properties" in to the CVS
  +repository.  This file is local to your own development environment, and
  +each developer will have their own version.
   
  -A short-cut to preparing your "build.properties" file is to make a copy of the
  -"build.properties.sample" file included in the Tomcat source distribution,
  -and then customize the paths within it.
   
  -(17) Build A Binary Distribution
  +(16) Build A Binary Distribution
   
   Open a command line shell, and issue the following commands:
   
  
  
  
  1.3       +39 -40    jakarta-tomcat-4.0/RELEASE-NOTES-4.0.txt
  
  Index: RELEASE-NOTES-4.0.txt
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/RELEASE-NOTES-4.0.txt,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- RELEASE-NOTES-4.0.txt	2001/09/15 23:47:16	1.2
  +++ RELEASE-NOTES-4.0.txt	2001/09/16 05:59:42	1.3
  @@ -3,7 +3,7 @@
                               Release Notes
                               =============
   
  -$Id: RELEASE-NOTES-4.0.txt,v 1.2 2001/09/15 23:47:16 craigmcc Exp $
  +$Id: RELEASE-NOTES-4.0.txt,v 1.3 2001/09/16 05:59:42 craigmcc Exp $
   
   
   ============
  @@ -102,45 +102,6 @@
   ============================
   
   
  ---------------------------
  -Tomcat 4.0 and XML Parsers:
  ---------------------------
  -
  -Previous versions of Tomcat 4.0 exposed the XML parser used by Jasper (the
  -JAXP/1.1 reference implementation) to web applications.  This is no longer
  -the case, because Jasper loads its parser with a new class loader instead.
  -Keep the following points in mind when considering how to use XML parsers
  -in Tomcat 4.0 and your web applications:
  -
  -* If you wish to make the JAXP/1.1 RI XML parser available to all web
  -  applications, simply move the "jaxp.jar" and "crimson.jar" files from
  -  the "$CATALINA_HOME/jasper" directory to the "$CATALINA_HOME/lib" directory.
  -
  -* If you wish to make another XML parser that is JAXP/1.1-compatible
  -  available to all web applications, install that parser into the
  -  "$CATALINA_HOME/lib" directory and remove "jaxp.jar" and "crimson.jar"
  -  from the "$CATALINA_HOME/jasper" directory.  It has been reported that
  -  Xerces 1.3.1 can be used in this fashion, but 2.x alpha releases
  -  can not be.
  -
  -* If you wish to use an XML parser (such as Xerces) in the WEB-INF/lib
  -  directory of your web application, this should now be possible, because
  -  of the modified JAXP 1.1 parser mentioned below.
  -
  -* Make sure you do *not* place an XML parser in your Java system extensions
  -  directory ($JAVA_HOME/jre/lib/ext), or modify the startup scripts to include
  -  such a parser in the CLASSPATH under which Tomcat executes.
  -
  -WARNING:  Tomcat 4.0 now ships with a modified version of the JAXP/1.1
  -(Final) "jaxp.jar" and "crimson.jar" files in the "jasper" subdirectory.
  -The "sealed" attribute has been removed from the manifest file for these
  -two JARs, to avoid "package sealing violation" errors that were caused by
  -them in a JDK 1.3 environment.  You MUST NOT replace these files with a
  -different (or later) release of JAXP, unless that later release has had
  -the sealed attribute removed, or you will encounter "package sealing violation"
  -errors when trying to use a different XML parser in a web application.
  -
  -
   ---------------------
   Tomcat 4.0 and Apache:
   ---------------------
  @@ -198,5 +159,43 @@
   "-webapp" command line option so that the entire web application (including
   all the required tag library descriptors and JAR files) is available to the
   compiler.
  +
  +
  +----------------------------------
  +Tomcat 4.0 Standard APIs Available:
  +----------------------------------
  +
  +A standard installation of Tomcat 4 makes all of the following APIs available
  +for use by web applications (by placing them in "common/lib" or "lib"):
  +* activation.jar (Java Activation Framework)
  +* crimson.jar (Unsealed version of JAXP/1.1 parser)
  +* jaxp.jar (Unsealed version of JAXP/1.1 API classes)
  +* jdbc2_0-stdext.jar (JDBC 2.0 Optional Package, javax.sql.*)
  +* jndi.jar (JNDI 1.2 base API classes)
  +* jta-spec1_0_1 (Java Transacation APIs)
  +* ldap.jar (JNDI LDAP provider required by JNDIRealm)
  +* mail.jar (JavaMail 1.2)
  +* servlet.jar (Servlet 2.3 and JSP 1.2 APIs)
  +* tyrex-0.9.7.0.jar (Tyrex XA-compatible data source from tyrex.exolab.org)
  +
  +
  +--------------------------
  +Tomcat 4.0 and XML Parsers:
  +--------------------------
  +
  +As described above, Tomcat 4.0 makes an XML parser (and many other standard
  +APIs) available to web applications.  This parser is also used internally
  +to parse web.xml files and the server.xml configuration file.  If you wish,
  +you may replace the "jaxp.jar" and "crimson.jar" files in "common/lib" with
  +another XML parser, as long as it is compatible with the JAXP/1.1 APIs.
  +
  +WARNING:  Tomcat 4.0 ships with a modified version of the JAXP/1.1
  +"jaxp.jar" and "crimson.jar" files from JAXP/1.1 final release.
  +The "sealed" attribute has been removed from the manifest file for these
  +two JARs, to avoid "package sealing violation" errors that were caused by
  +them in a JDK 1.3 environment.  You MUST NOT replace these files with a
  +different (or later) release of JAXP, unless that later release has had
  +the sealed attribute removed, or you will encounter "package sealing violation"
  +errors when trying to use a different XML parser in a web application.