LDAPHttp Examples
September 2005

Introduction
------------

The LDAPHttp libraries are described by the file named README in this directory.
An LDAPHttp examples distribution also includes classes in and under the package
com.mentata.examples and context properties files in paths under com.mentata.l3d. 
Demonstrations and information on the LDAPHttp examples is available at:

http://www.mentata.com/ldaphttp/examples/

Examples are included for demonstration purposes.
          
Dependencies
------------

The LDAPHttp examples can use Java Standard Development Kit (SDK) version 1.4 or higher 
for compilation or execution. Examples are designed to make use of the Apache Ant build 
tool, available and explained at:

http://ant.apache.org/

The compilation instructions below assume a proper installation and use of Ant.

These examples depend upon the classes of the open source Java LDAP API (JLDAP) 
as well as the LDAPHttp libraries themselves. Some examples assume a local database
with custom schema and entries which may be shared by Mentata Systems in OpenLDAP
and LDIF formats respectively.

Contents
--------

In addition to the standard LDAPHttp file structure, this distribution should 
contain the following paths:

./README.examples
  This file.
./demo.xml
  The Ant build file for examples.
./includes/
  Contains header and footer HTML files for some examples. 
./styles/
  Contains Cascading Style Sheets and background graphics for some examples. 
./vys/
  Contains JSP content files for the voyosef example servlet.

More files are also added to various LDAPHttp paths to support the examples,
including an instructional example context properties file at:

./WEB-INF/classes/com/mentata/l3d/example/context.properties

This is the recommended place to start building your own LDAPHttp application.

Compilation
-----------

Before compiling, ensure that your environment contains appropriate values for the 
JAVA_HOME and ANT_HOME environment variables. Change your current filesystem directory 
to the same path as this file in the distribution. To get a list of major available 
targets, execute the command:

ant -f demo.xml -p

The default target will build all deliverable code and archive files. To erase all 
built files, use the command:

ant -f demo.xml clean

The web application archives created by designated "ms" targets are identical to those
deployed on the Mentata Systems public server.

Notes
-----

Relative to the local directory, the default target for the demo.xml Ant build file will 
produce, among other things, a web application archive 'webapps/ds.war'. This file can be
deployed in any compliant servlet container using any name you wish. To see the software
in action, use the links provided in the home page of the application path. For example,
if your container is available over port 80 and you deploy the archive as 'foo.war' then 
use a browser to open the URL:

http://<host>/<foo>/index.htm

and you will find links to run LDAPHttp applications locally.

------------------------------------
Thanks for your interest in LDAPHttp.