jsdever 2003/02/24 18:10:18 Modified: httpclient build.properties.sample build.xml project.xml httpclient/src/java/org/apache/commons/httpclient HttpMethodBase.java httpclient/src/java/org/apache/commons/httpclient/methods/multipart FilePart.java httpclient/xdocs news.xml testwebapp.xml Log: Cleanups for the alpha3 release. Revision Changes Path 1.12 +6 -6 jakarta-commons/httpclient/build.properties.sample Index: build.properties.sample =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/build.properties.sample,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- build.properties.sample 29 Oct 2002 06:08:20 -0000 1.11 +++ build.properties.sample 25 Feb 2003 02:10:15 -0000 1.12 @@ -25,16 +25,16 @@ # A JSSE implementation (see http://java.sun.com/products/jsse): # Required to compile, only needed at runtime if you're using HTTPS. base.path=/java -jsse.home=${base.path}/jsse +jsse.home=${base.path}/jsse-1.0.3_01 jsse.lib=${jsse.home}/lib -jcert.jar=${jsse.lib}/jcert.jar -jnet.jar=${jsse.lib}/jnet.jar -jsse.jar=${jsse.lib}/jsse.jar +jcert.jar=${jsse.lib}/jcert-1.0.3_01.jar +jnet.jar=${jsse.lib}/jnet-1.0.3_01.jar +jsse.jar=${jsse.lib}/jsse-1.0.3_01.jar # A JCE implementation (see http://java.sun.com/products/jce): # Required to compile, only needed at runtime if you're using HTTPS. jce.lib=${base.path}/Programs/sun/jce1.2.2/lib -jce.jar=${jce.lib}/jce1_2_2.jar +jce.jar=${jce.lib}/jce-1.2.2.jar # The Servlet API (See http://java.sun.com/products/servlet) # Required to compile the test webapp. 1.25 +11 -12 jakarta-commons/httpclient/build.xml Index: build.xml =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/build.xml,v retrieving revision 1.24 retrieving revision 1.25 diff -u -r1.24 -r1.25 --- build.xml 21 Jan 2003 22:09:31 -0000 1.24 +++ build.xml 25 Feb 2003 02:10:16 -0000 1.25 @@ -24,7 +24,7 @@ <!-- ========== Properties: Javadoc Properties ========================= --> - <property name="javadoc.j2sdk.link" value="http://java.sun.com/j2se/1.4.1/docs/api"/> + <property name="javadoc.j2sdk.link" value="http://java.sun.com/products/jdk/1.2/docs/api/"/> <property name="javadoc.logging.link" value="http://jakarta.apache.org/commons/logging/apidocs/"/> <!-- ========== Properties: Component Declarations ======================== --> @@ -36,7 +36,7 @@ <property name="component.title" value="HttpClient Library"/> <!-- The current version number of this component --> - <property name="component.version" value="2.0-alpha2-dev"/> + <property name="component.version" value="2.0-alpha3-dev"/> <!-- ========== Properties: Source Directories ============================ --> @@ -47,7 +47,7 @@ <property name="conf.home" value="src/conf"/> <!-- The base directory for component sources --> - <property name="source.home" value="src/java"/> + <property name="source.home" value="src"/> <!-- The base directory for documenation --> <property name="docs.home" value="docs"/> @@ -182,7 +182,9 @@ <target name="dist" depends="compile,doc" description="Create binary distribution"> <mkdir dir="${dist.home}"/> - <copy file="LICENSE.txt" todir="${dist.home}"/> + <copy file="LICENSE.txt" todir="${dist.home}"/> + <copy file="build.xml" todir="${dist.home}"/> + <copy file="build.properties.sample" todir="${dist.home}"/> <copy file="README.txt" todir="${dist.home}"/> <jar jarfile ="${dist.home}/commons-${component.name}.jar" basedir ="${build.home}/classes" @@ -196,8 +198,8 @@ <fileset dir="${source.home}"/> </copy> <mkdir dir="${dist.home}/lib"/> - <copy todir="${dist.home}/lib" filtering="on"> - <fileset dir="${dist.home}/lib" includes="**/*.jar"/> + <copy todir="${dist.home}/lib"> + <fileset dir="lib"/> </copy> </target> @@ -221,16 +223,13 @@ <target name="compile" depends="static" description="Compile shareable components"> - <javac srcdir ="${source.home}" + <javac srcdir ="${source.home}/java" destdir ="${build.home}/classes" debug ="${compile.debug}" deprecation ="${compile.deprecation}" optimize ="${compile.optimize}"> <classpath refid="compile.classpath"/> </javac> - <copy todir="${build.home}/classes" filtering="on"> - <fileset dir="${source.home}" excludes="**/*.java"/> - </copy> </target> <target name="compile.tests" depends="compile" @@ -361,7 +360,7 @@ <mkdir dir="${dist.home}"/> <mkdir dir="${dist.home}/docs"/> <mkdir dir="${dist.home}/docs/api"/> - <javadoc sourcepath ="${source.home}" + <javadoc sourcepath ="${source.home}/java" destdir ="${dist.home}/docs/api" packagenames ="org.apache.commons.*" author ="true" 1.29 +14 -5 jakarta-commons/httpclient/project.xml Index: project.xml =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/project.xml,v retrieving revision 1.28 retrieving revision 1.29 diff -u -r1.28 -r1.29 --- project.xml 26 Jan 2003 22:31:30 -0000 1.28 +++ project.xml 25 Feb 2003 02:10:16 -0000 1.29 @@ -6,7 +6,7 @@ <id>commons-httpclient</id> <gumpRepositoryId>jakarta-commons-httpclient</gumpRepositoryId> <inceptionYear>2001</inceptionYear> - <currentVersion>2.0-alpha2</currentVersion> + <currentVersion>2.0-alpha3</currentVersion> <package>org.apache.commons.httpclient</package> <organization> @@ -69,6 +69,15 @@ <developers> <developer> + <name>Michael Becke</name> + <id>mbecke</id> + <email>[EMAIL PROTECTED]</email> + <organization></organization> + <roles> + <role>Java Developer</role> + </roles> + </developer> + <developer> <name>Jeff Dever</name> <id>jsdever</id> <email>[EMAIL PROTECTED]</email> @@ -139,10 +148,6 @@ <email>[EMAIL PROTECTED]</email> </contributor> <contributor> - <name>Michael Becke</name> - <email>[EMAIL PROTECTED]</email> - </contributor> - <contributor> <name>Ola Berg</name> <email></email> </contributor> @@ -157,6 +162,10 @@ <contributor> <name>Ryan Lubke</name> <email>[EMAIL PROTECTED]</email> + </contributor> + <contributor> + <name>Sam Maloney</name> + <email>[EMAIL PROTECTED]</email> </contributor> <contributor> <name>Rob Di Marco</name> 1.116 +5 -5 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java Index: HttpMethodBase.java =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v retrieving revision 1.115 retrieving revision 1.116 diff -u -r1.115 -r1.116 --- HttpMethodBase.java 21 Feb 2003 13:48:09 -0000 1.115 +++ HttpMethodBase.java 25 Feb 2003 02:10:16 -0000 1.116 @@ -156,7 +156,7 @@ static { String agent = System.getProperties() .getProperty("httpclient.useragent", - "Jakarta Commons-HttpClient/2.0alpha2"); + "Jakarta Commons-HttpClient/2.0alpha3"); USER_AGENT = new Header("User-Agent", agent); } 1.12 +5 -5 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/FilePart.java Index: FilePart.java =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/FilePart.java,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- FilePart.java 12 Feb 2003 12:30:44 -0000 1.11 +++ FilePart.java 25 Feb 2003 02:10:17 -0000 1.12 @@ -260,7 +260,7 @@ * Write the disposition header to the output stream * @param out The output stream * @throws IOException If an IO problem occurs - * @see org.apache.commons.httpclient.methods.multipart.Part#sendHeader(OutputStream) + * @see Part#sendDispositionHeader(OutputStream) */ protected void sendDispositionHeader(OutputStream out) throws IOException { @@ -312,4 +312,4 @@ return source.getLength(); } -} \ No newline at end of file +} 1.15 +19 -2 jakarta-commons/httpclient/xdocs/news.xml Index: news.xml =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/xdocs/news.xml,v retrieving revision 1.14 retrieving revision 1.15 diff -u -r1.14 -r1.15 --- news.xml 26 Jan 2003 22:31:30 -0000 1.14 +++ news.xml 25 Feb 2003 02:10:17 -0000 1.15 @@ -11,6 +11,24 @@ <body> + <section name="25 January 2003 - HttpClient 2.0 Alpha 3 released"> + <p>This is an intermediate alpha release. The build process used in + the previous Alpha 2 changed from generating 4 build artifacts to + a single distribution. This one zip contains everything: all + the source, the binary jar, the logging dependancy, generated + javadoc and required build files for Ant builds and JUnit tests.</p> + <blockquote> + "One zip to rule them all, one zip to find them, one zip to + bring them all and in the darkness bind them"</blockquote> + </section> + + <section name="19 February, 2003 - Welcome new committer Michael Becke"> + <p>Mike been an active contributor for many months. He has worked on a diverse range + of problems with high quality results. In particular he is known for the massive + HttpClient/HttpMultiClient merger that took place in December.</p> + <p>Welcome to Middle Earth Mike!</p> + </section> + <section name="26 January 2003 - new mailing list archives"> <p>There are two new mailing list archives of the commons-httpclient-dev mailing list. It looks like someone up there is starting to like us! @@ -22,7 +40,6 @@ </ul> </p> </section> - <section name="25 January 2003 - HttpClient 2.0 Alpha 2 released"> <p>After many months and a great resurgence of developers, the new build 1.3 +185 -180 jakarta-commons/httpclient/xdocs/testwebapp.xml Index: testwebapp.xml =================================================================== RCS file: /home/cvs/jakarta-commons/httpclient/xdocs/testwebapp.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- testwebapp.xml 1 Feb 2003 12:56:23 -0000 1.2 +++ testwebapp.xml 25 Feb 2003 02:10:18 -0000 1.3 @@ -2,186 +2,191 @@ <document> - <properties> - <title>Webapp Test HowTo</title> - <author email="[EMAIL PROTECTED]">Oleg Kalnichevski</author> - <author email="[EMAIL PROTECTED]">Jeff Dever</author> - <revision>$Id$</revision> - </properties> - - <body> - <section name="Rationale"> - <p>Complex software development efforts - with many developers collaborating on the same code base require a - means of ensuring that changes introduced in one module do not - produce a rippling effect on other modules by breaking some - dependencies or assumptions. One of the widely employed approaches to - achieve such goal calls for simultaneous development of software - units and corresponding test cases. The latter can be executed - against the former in order to ensure that the software units comply - with their contract or programming interface. Such suite of test - cases helps developers ensure formal validity and integrity of the - their software artifact while it evolves through multiple development - cycles. - </p> - <p>JUnit, a popular open-source unit - testing framework, has been employed in the HttpClient project. - Please refer to the JUnit web site for more detailed information - <A HREF="http://www.junit.org/index.htm">http://www.junit.org/index.htm</A> - </p> - <p>Different types of unit tests in the HttpClient project - <ul> - <li>Test cases that have no external dependencies in order to - execute;</li> - <li>Test cases that require access to external public resources - (usually high profile web sites);</li> - <li>Test cases that must be run against a local web application - that implements test specific functions and produces specific HTTP - responses. These tests are the most critical component of the entire - test suite as they allow for testing of most arcane aspects of the - HTTP protocol that are not easily reproducible with external - resources.</li> - </ul> - </p> - <p>It is absolutely crucial that patches - are tested for compliance with the entire test suite in order to be - considered for acceptance into the main CVS trunk</p> - - <p>The purpose of this document is to help - potential HttpClient contributors compile and deploy the test web - application (later referred as Test WebApp)</p> - </section> - - <section name="Test WebApp external dependencies"> - - <p>In order to successfully compile the - Test WebApp we need satisfy the following external dependencies - </p> - <ul> - <li><a HREF="http://jakarta.apache.org/tomcat/">Apache Jakarta Tomcat</a><br/> - servlet engine version 4.0.3 or higher. Technically any Servlet 2.3 and JSP - 1.2 compliant servlet engine should do. However, the Test WebApp has - been mostly used with Tomcat servlet engine. - If you need assistance in deploying the Tomcat servlet engine please refer to this - <a HREF="http://jakarta.apache.org/tomcat/tomcat-4.0-doc/RUNNING.txt">document</a> - </li> - - <li><a HREF="http://jakarta.apache.org/ant/index.html">Apache Jakarta Ant</a><br/> - build tool version 1.5.1 or higher - </li> - - <li><a HREF="http://www.junit.org/index.htm">JUnit</a><br/> - unit testing framework version 3.7 or higher - </li> - - <li><a href="http://java.sun.com/products/jsse/">Java<sup>TM</sup> Secure Socket Extension (JSSE)</a><br/> - version 1.0.3 or higher - </li> - - </ul> - - </section> - - <section name="Development environment"> - - <p>HttpClient is a Java based framework and so is not tied to any particular platform. - However setup instructions such as these must choose a particular enviroment - to describe. This document will describe the setup for j2sdk1.4 on Unix. - </p> - - <ol> - <li>Specify Test WebApp build properties - <p> - Update references in the file - build.properties to refer to correct locations on your local system. - The build.properties is located in the root directory of the - HttpClient source tree. Most importantly the location of the - following packages must be specified: <b>junit.jar, servlet.jar</b></p> - <p> - For example, you can copy the build.properties.sample to your home directory - as build.properties and modify the following lines to match your system configuration:</p> - - <ul> - <li>servlet.jar=/usr/local/jakarta-tomcat/common/lib/servlet.jar</li> - <li>junit.jar=/usr/local/junit/junit.jar</li> - </ul> - </li> - </ol> - </section> - - <section name="Build Test WebApp"> - <p> - From the root directory of the HttpClient source tree, run the following - command: - <blockquote>/opt/ant test-webapp-war</blockquote> - </p> - <p>If all external dependencies have been - correctly specified the execution of the Ant task should result in - creation of web archive target/httpclienttest.war. - </p> - </section> - - <section name="Deploy Test WebApp"> - <ul> - <li>Shutdown Tomcat - <p>Run the shutdown script: /usr/local/jakarta-tomcat/bin/shutdown.sh</p> - </li> - <li>Copy the httpclienttest.war file into the webapps directory - <p>Your tomcat installations webapp directory might be in either - /var/tomcat/webapps or /usr/local/jakarta-tomcat/webapps. - </p> - </li> - <li>Startup Tomcap - <p>Run the startup script: /usr/local/jakarta-tomcat/bin/shutdown.sh - </p> - <p>Tomcat will check for new web archives in its base directory and - automatically deploy them. - </p> - </li> - <li>Test the deployment of the httpclienttest web archive - <p>Point your browser to the following - URL: <A HREF="http://127.0.0.1:8080/httpclienttest/headers"> - http://127.0.0.1:8080/httpclienttest/headers</A> - </p> - <p>If the Test WebApp has been - properly deployed and is ready for use you should see similar - response in your browser</p> - - - <p>This is a response to an HTTP GET request.<br/> - <blockquote> - Request Headers:<br/> - name="user-agent";value="Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.3a) Phoenix/0.5"<br/> - name="accept";value="text/xml,application/xml,application/xhtml+xml,text/html<br/> - name="accept-language";value="en-us,en;q=0.5"<br/> - name="accept-encoding";value="gzip,deflate,compress;q=0.9"<br/> - name="accept-charset";value="ISO-8859-1,utf-8;q=0.7,*;q=0.7"<br/> - name="keep-alive";value="300"<br/> - name="connection";value="keep-alive"<br/> - </blockquote> - </p> - </li> - </ul> - </section> - - <section name="Run test cases"> - <p>In case you run a non-default installation of the Tomcat servlet - engine you may need to update the following properties in the - build.properties file</p> - - <ul> - <li>httpclient.test.localHost</li> - <li>httpclient.test.localPort</li> - <li>httpclient.test.webappContext</li> - </ul> - <p>run the webapp tests using Ant:<br/> - <code>ant test-local</code> - </p> - <p>You should receive BUILD SUCCESSFUL message if all test cases succeeded</p> + <properties> + <title>Webapp Test HowTo</title> + <author email="[EMAIL PROTECTED]">Oleg Kalnichevski</author> + <author email="[EMAIL PROTECTED]">Jeff Dever</author> + <revision>$Id$</revision> + </properties> + + <body> + <section name="Rationale"> + <p>Complex software development efforts + with many developers collaborating on the same code base require a + means of ensuring that changes introduced in one module do not + produce a rippling effect on other modules by breaking some + dependencies or assumptions. One of the widely employed approaches to + achieve such goal calls for simultaneous development of software + units and corresponding test cases. The latter can be executed + against the former in order to ensure that the software units comply + with their contract or programming interface. Such suite of test + cases helps developers ensure formal validity and integrity of the + their software artifact while it evolves through multiple development + cycles. + </p> + <p>JUnit, a popular open-source unit + testing framework, has been employed in the HttpClient project. + Please refer to the JUnit web site for more detailed information + <A HREF="http://www.junit.org/index.htm">http://www.junit.org/index.htm</A> + </p> + <p>Different types of unit tests in the HttpClient project + <ul> + <li>Test cases that have no external dependencies in order to + execute;</li> + <li>Test cases that require access to external public resources + (usually high profile web sites);</li> + <li>Test cases that must be run against a local web application + that implements test specific functions and produces specific HTTP + responses. These tests are the most critical component of the entire + test suite as they allow for testing of most arcane aspects of the + HTTP protocol that are not easily reproducible with external + resources.</li> + </ul> + </p> + <p>It is absolutely crucial that patches + are tested for compliance with the entire test suite in order to be + considered for acceptance into the main CVS trunk</p> + + <p>The purpose of this document is to help + potential HttpClient contributors compile and deploy the test web + application (later referred as Test WebApp)</p> + </section> + + <section name="Test WebApp external dependencies"> + + <p>In order to successfully compile the + Test WebApp we need satisfy the following external dependencies + </p> + <ul> + <li><a HREF="http://jakarta.apache.org/tomcat/">Apache Jakarta Tomcat</a><br/> + servlet engine version 4.0.3 or higher. Technically any Servlet 2.3 and JSP + 1.2 compliant servlet engine should do. However, the Test WebApp has + been mostly used with Tomcat servlet engine. + If you need assistance in deploying the Tomcat servlet engine please refer to this + <a HREF="http://jakarta.apache.org/tomcat/tomcat-4.0-doc/RUNNING.txt">document</a> + </li> + + <li><a HREF="http://jakarta.apache.org/ant/index.html">Apache Jakarta Ant</a><br/> + build tool version 1.5.1 or higher + </li> + + <li><a HREF="http://www.junit.org/index.htm">JUnit</a><br/> + unit testing framework version 3.7 or higher + </li> + + <li><a href="http://java.sun.com/products/jsse/">Java<sup>TM</sup> Secure Socket Extension (JSSE)</a><br/> + version 1.0.3 or higher + </li> + + </ul> + + </section> + + <section name="Development environment"> + + <p>HttpClient is a Java based framework and so is not tied to any particular platform. + However setup instructions such as these must choose a particular enviroment + to describe. This document will describe the setup for j2sdk1.4 on Unix. + </p> + + <ol> + <li>Specify Test WebApp build properties + <p> + Update references in the file + build.properties to refer to correct locations on your local system. + The build.properties is located in the root directory of the + HttpClient source tree. Most importantly the location of the + following packages must be specified: <b>junit.jar, servlet.jar</b></p> + <p> + For example, you can copy the build.properties.sample to your home directory + as build.properties and modify the following lines to match your system configuration:</p> + + <ul> + <li>servlet.jar=/usr/local/jakarta-tomcat/common/lib/servlet.jar</li> + <li>junit.jar=/usr/local/junit/junit.jar</li> + </ul> + </li> + </ol> + </section> + + <section name="Build Test WebApp"> + <p> + From the root directory of the HttpClient source tree, run the following + command: + <blockquote>/opt/ant test-webapp-war</blockquote> + </p> + <p>If all external dependencies have been + correctly specified the execution of the Ant task should result in + creation of web archive target/httpclienttest.war. + </p> + </section> + + <section name="Deploy Test WebApp"> + <ul> + <li>Shutdown Tomcat + <p>Run the shutdown script: <tt>/usr/local/jakarta-tomcat/bin/shutdown.sh</tt></p> + </li> + <li>Copy the httpclienttest.war file into the webapps directory + <p>Your tomcat installations webapp directory might be in either + /var/tomcat/webapps or /usr/local/jakarta-tomcat/webapps. + </p> + <p><b>Note:</b> You can control where ant <tt>test-webapp-war</tt> target puts the + generated <tt>httpclienttest.war</tt> file by modifying the <tt>test-webapp.dest</tt> + property. This can be set to create the war file in the tomcat + webapps directory so you can skip this manual step. + </p> + </li> + <li>Startup Tomcap + <p>Run the startup script: /usr/local/jakarta-tomcat/bin/shutdown.sh + </p> + <p>Tomcat will check for new web archives in its base directory and + automatically deploy them. + </p> + </li> + <li>Test the deployment of the httpclienttest web archive + <p>Point your browser to the following + URL: <A HREF="http://127.0.0.1:8080/httpclienttest/headers"> + http://127.0.0.1:8080/httpclienttest/headers</A> + </p> + <p>If the Test WebApp has been + properly deployed and is ready for use you should see similar + response in your browser</p> + + + <p>This is a response to an HTTP GET request.<br/> + <blockquote> + Request Headers:<br/> + name="user-agent";value="Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.3a) Phoenix/0.5"<br/> + name="accept";value="text/xml,application/xml,application/xhtml+xml,text/html<br/> + name="accept-language";value="en-us,en;q=0.5"<br/> + name="accept-encoding";value="gzip,deflate,compress;q=0.9"<br/> + name="accept-charset";value="ISO-8859-1,utf-8;q=0.7,*;q=0.7"<br/> + name="keep-alive";value="300"<br/> + name="connection";value="keep-alive"<br/> + </blockquote> + </p> + </li> + </ul> + </section> + + <section name="Run test cases"> + <p>In case you run a non-default installation of the Tomcat servlet + engine you may need to update the following properties in the + build.properties file</p> + + <ul> + <li>httpclient.test.localHost</li> + <li>httpclient.test.localPort</li> + <li>httpclient.test.webappContext</li> + </ul> + <p>run the webapp tests using Ant:<br/> + <code>ant test-local</code> + </p> + <p>You should receive BUILD SUCCESSFUL message if all test cases succeeded</p> - <p>Disregard WARN messages. The test cases run through valid and invalid cases and as such - warnings are part of the HttpClient test sequence.</p> + <p>Disregard WARN messages. The test cases run through valid and invalid cases and as such + warnings are part of the HttpClient test sequence.</p> - </section> - </body> + </section> + </body> </document>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]