################################################################################
#
#    Licensed to the Apache Software Foundation (ASF) under one or more
#    contributor license agreements.  See the NOTICE file distributed with
#    this work for additional information regarding copyright ownership.
#    The ASF licenses this file to You under the Apache License, Version 2.0
#    (the "License"); you may not use this file except in compliance with
#    the License.  You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
################################################################################


This project is a proof of concept for developing Apache Directory Server on
top of an OSGi runtime container.  Follow the following steps to build the project.

1).  Check out or svn up a new copy of apacheds 1.5.5-SNAPSHOT from
http://svn.apache.org/repos/asf/directory/apacheds/trunk-with-dependencies

2).  If you have never built the top level of the project above, edit apacheds/pom.xml
and uncomment the following line in the modules section:
    <module>osgi</module>

3).  Build the apacheds project form the root.  If you have already built the entire project
before, you can skip this step and just run "mvn clean install" within the apacheds/osgi module.

4).  For Mina 2.0 SNAPSHOTs, you will either need to download and apply the patches at
https://issues.apache.org/jira/browse/DIRMINA-673

As an alternative that is much easier, you can comment out the maven-antrun plugin entry entirely
starting at around line 190 in the main pom.xml

5).  After the above steps are completed, you should be able to run "mvn clean install"
on this project and have the build complete succesfully.

6).  Go to the assembly/target directory and run:
tar xvzf apache-directory-assembly-2.0.0-SNAPSHOT.tar.gz to expand the assembly.

7).  cd apache-directory-assembly-2.0.0-SNAPSHOT/bin

8).  ./apacheds
At this point you should see the welcome screen for the server and a prompt.  If it appears
to hang at this point, something is wrong so you can check the logs in data/logs/servicemix.log

9).  There is no configuration installed at this point, so to demonstrate the hot deployment
of server configurations, copy the modified server.xml file from:
assembly/src/main/distribution/text/deploy/server.xml into the deploy directory.

You should see:
 Ldap service started.
Ldaps service started.

smx@root:/>

You should be able to attach to the LDAP service on port 10389 jsut as you would with
a default ApacheDS installation.

=========================================
Kernel shell tips
=========================================

Useful commands:
help - lists all commands available
log/d - displays log entries
    So for instance, you can pipe to the internal grep command just like Unix:
    log/d|grep ERROR

log/de - Displays exceptions only.

osgi/list - Displays all of the installed OSGi bundles and their status.

exit - exits the shell and shuts down the server instance