README for JK2
--------------

JK2 is a refactoring of  JK and is much more  powerfull.  Even if it works  with
Apache 1.3, JK2 has been developed with Apache 2.0 in mind, and is better suited
for multi-threaded  servers like  IIS, NES/iPlanet.  It can  also be  embeded in
other applications and used from java.

JK2 improves  the modularity  and has  a better  separation between protocol and
physical layer. As such JK2 support  fast unix-socket, and could be extended  to
support others communications channels. It is better suited for JNI and may  use
(in a future version) JDK 1.4  NIO. There is additional support for  monitoring,
similar with  JMX in  java. A  module similar  with mod_status  is provided, and
additional adapters  can be  used to  interface and  provide status  and runtime
configuration.  The  configuration  has been  changed  to  follow the  component
models. Multiple configuration sources can be  supported ( in additon to file  )
providing better  integration with  the embeding  application. The  config layer
uses the management layer APIs and  it can support persistence for changes  done
via runtime configuration. 


How to obtain the JK2 and Apache Portable Runtime sources:
----------------------------------------------------------

NOTE: If you downloaded a source distribution from our website or a mirror  (the
file is called jakarta-tomcat-connectors-jk2-X.X.X.src.tar.gz) you don't need to
obtain any other file. Please follow this chapter only if you want to obtain the
latest CVS version of the sources.

Check out the module sources from CVS using the following commands:

    cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
    (Logging in to anoncvs@cvs.apache.org)
    CVS password: anoncvs
    cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic \
        checkout jakarta-tomcat-connectors

Once  CVS downloads  the jakarta-tomcat-connectors  module sources,  we need  to
download the  APR (Apache  Portable Runtime)  sources. To  do this  simply use a
release version of APR:

    - You can download it from http://www.apache.org/dist/apr/.
    - The file is called apr-X.X.X.tar.gz

You will also need the APR-UTIL (a companion library to APR). To do this  simply
use a release version of APR:

    - You can download it from http://www.apache.org/dist/apr/.
    - The file is called apr-util-X.X.X.tar.gz

When the APR sources are in place,  we need to create the configure scripts.  It
is done by running the command:

    ./buildconf.sh


WARNING:
---------

The JK2  should be  considered initial-release  quality code.   It has  not been
subjected to the  same stresses on  its stability and  security that the  mod_jk
releases  have  enjoyed,  so  there is  a  greater  possibility  of undiscovered
vulnerabilities to stability or security.
