2007-10-30 13:47:33 -04:00
|
|
|
Building HttpComponents Client
|
|
|
|
|
============================
|
|
|
|
|
|
|
|
|
|
(1) Requisites
|
|
|
|
|
--------------
|
2013-01-06 15:34:07 -05:00
|
|
|
JDK 1.5+ is required in order to compile and run HttpClient.
|
2007-10-30 13:47:33 -04:00
|
|
|
|
2013-01-06 15:34:07 -05:00
|
|
|
HttpClient utilizes Maven as a distribution management and packaging tool.
|
|
|
|
|
Version 3.0.3 or later is recommended. Maven 3.0.x, however it is known
|
|
|
|
|
to be incompatible with the Clover plugin. Use Maven 2.2.1 to generate
|
|
|
|
|
web site content with Clover coverage reports.
|
2012-11-26 11:49:58 -05:00
|
|
|
|
2007-10-30 13:47:33 -04:00
|
|
|
Maven installation and configuration instructions can be found here:
|
|
|
|
|
|
|
|
|
|
http://maven.apache.org/run-maven/index.html
|
|
|
|
|
|
|
|
|
|
(2) Executing test cases
|
|
|
|
|
|
|
|
|
|
Execute the following command in order to compile and test the components
|
|
|
|
|
|
|
|
|
|
mvn test
|
|
|
|
|
|
|
|
|
|
(3) Building packages
|
|
|
|
|
|
2013-01-06 15:34:07 -05:00
|
|
|
Execute the following command in order to build the JAR packages and install
|
|
|
|
|
them to the local repository:
|
2007-10-30 13:47:33 -04:00
|
|
|
|
2013-01-06 15:34:07 -05:00
|
|
|
mvn install
|
2007-10-30 13:47:33 -04:00
|
|
|
|
2013-01-06 15:34:07 -05:00
|
|
|
The JAR packages can be found in the target folders of their respective modules
|
2007-10-30 13:47:33 -04:00
|
|
|
|
2009-07-09 15:31:04 -04:00
|
|
|
httpclient/target/httpclient-<VERSION>.jar
|
|
|
|
|
httpmime/target/httpmime-<VERSION>.jar
|
2013-01-06 15:34:07 -05:00
|
|
|
httpclient-cache/target/httpclient-cache-<VERSION>.jar
|
|
|
|
|
fluent-hc/target/fluent-hc-<VERSION>.jar
|
2009-07-09 15:31:04 -04:00
|
|
|
httpclient-osgi/target/org.apache.httpcomponents.httpclient_<VERSION>.jar
|
2007-10-30 13:47:33 -04:00
|
|
|
|
|
|
|
|
where <VERSION> is the release version
|
2009-07-09 15:31:04 -04:00
|
|
|
|
|
|
|
|
(4) Building documentation
|
|
|
|
|
|
|
|
|
|
Execute the following command in order to generate javadoc:
|
|
|
|
|
|
2009-07-14 15:33:32 -04:00
|
|
|
mvn javadoc:aggregate
|
2009-07-09 15:31:04 -04:00
|
|
|
|
|
|
|
|
Execute the following command in order to generate the tutorial in html and pdf formats
|
|
|
|
|
|
|
|
|
|
mvn docbkx:generate-pdf docbkx:generate-html
|
|
|
|
|
|
|
|
|
|
(5) Building distribution assemblies
|
|
|
|
|
|
|
|
|
|
Execute the following command in order to build the distribution assemblies
|
|
|
|
|
|
|
|
|
|
mvn package assembly:assembly
|
|
|
|
|
|
|
|
|
|
(6) Fix EOL in source files
|
|
|
|
|
|
|
|
|
|
Fix the archive files so the source files have the correct EOL settings:
|
|
|
|
|
|
|
|
|
|
mvn antrun:run
|
|
|
|
|
|
|
|
|
|
(7) Building project web site
|
|
|
|
|
|
|
|
|
|
Execute the following command in order to generate the project web site:
|
|
|
|
|
|
2010-03-01 13:04:42 -05:00
|
|
|
mvn site -Dmaven.clover.licenseLocation=<path>/clover.license
|
2009-07-09 15:31:04 -04:00
|
|
|
|
|
|
|
|
where <path> is a full path to Clover license file
|
|
|
|
|
|
|
|
|
|
ASF committers can obtain a copy of Clover license donated to the ASF from the SVN repository
|
|
|
|
|
at the following location:
|
|
|
|
|
|
|
|
|
|
https://svn.apache.org/repos/private/committers/donated-licenses/clover
|
|
|
|
|
|
