You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2004/02/01 09:49:31 UTC
svn commit: rev 6404 - in incubator/directory/eve/trunk/eve: . xdocs xdocs/backend xdocs/frontend
Author: akarasulu
Date: Sun Feb 1 00:49:31 2004
New Revision: 6404
Added:
incubator/directory/eve/trunk/eve/xdocs/
incubator/directory/eve/trunk/eve/xdocs/backend/
incubator/directory/eve/trunk/eve/xdocs/backend/index.xml
incubator/directory/eve/trunk/eve/xdocs/backend/navigation.xml
incubator/directory/eve/trunk/eve/xdocs/design.xml
incubator/directory/eve/trunk/eve/xdocs/features.xml
incubator/directory/eve/trunk/eve/xdocs/frontend/
incubator/directory/eve/trunk/eve/xdocs/frontend/index.xml
incubator/directory/eve/trunk/eve/xdocs/frontend/navigation.xml
incubator/directory/eve/trunk/eve/xdocs/index.xml
incubator/directory/eve/trunk/eve/xdocs/navigation.xml
Modified:
incubator/directory/eve/trunk/eve/maven.xml
incubator/directory/eve/trunk/eve/project.xml
Log:
added site documentation for eve subproject
Modified: incubator/directory/eve/trunk/eve/maven.xml
==============================================================================
--- incubator/directory/eve/trunk/eve/maven.xml (original)
+++ incubator/directory/eve/trunk/eve/maven.xml Sun Feb 1 00:49:31 2004
@@ -1,96 +1,65 @@
-<project default="java:compile"
- xmlns:j="jelly:core"
- xmlns:u="jelly:util"
- xmlns:ant="jelly:ant"
- xmlns:maven="jelly:maven"
- xmlns:m="maven"
- xmlns:deploy="deploy">
-
- <preGoal name="site">
- <attainGoal name="docbook:transform"/>
- </preGoal>
-
- <postGoal name="site">
- <attainGoal name="server:copy-images"/>
- </postGoal>
-
- <goal name="server:copy-images">
- <copy toDir="target/docs/images">
- <fileSet dir="${basedir}/src/images">
- <include name="*.gif"/>
- </fileSet>
- </copy>
- </goal>
-
- <goal name="cleanall">
- <attainGoal name="clean"/>
- <delete dir="home"/>
- </goal>
-
- <goal
- name="java:compile"
- description="Build All Jar Files And Intall">
-
- <maven:reactor
- basedir="${basedir}"
- postProcessing="true"
- includes="**/project.xml"
- excludes="./project.xml"
- goals="jar:install"
- banner="Building All"
- ignoreFailures="false"/>
- </goal>
-
- <goal
- name="sitedocs"
- description="Builds the entire site documentation">
-
- <maven:reactor
- basedir="${basedir}"
- postProcessing="true"
- includes="**/project.xml"
- excludes="./project.xml"
- goals="site"
- banner="site"
- ignoreFailures="false"/>
- </goal>
-
- <goal
- name="clean-all"
- description="Clean all sandbox projects">
-
- <maven:reactor
- basedir="${basedir}"
- postProcessing="true"
- includes="*/project.xml"
- goals="clean"
- banner="Clean All"
- ignoreFailures="true"/>
- </goal>
-
- <goal
- name="eclipse-all"
- description="Generate eclipse descriptors for all projects">
-
- <maven:reactor
- basedir="${basedir}"
- postProcessing="true"
- includes="*/project.xml"
- goals="clean"
- banner="Clean All"
- ignoreFailures="true"/>
- </goal>
-
- <goal
- name="eclipse-all"
- description="Create all eclipse projects">
-
- <maven:reactor
- basedir="${basedir}"
- postProcessing="true"
- includes="*/project.xml"
- goals="eclipse"
- banner="Eclipse Project"
- ignoreFailures="true"/>
- </goal>
-</project>
+<project default="java:compile" xmlns:j="jelly:core" xmlns:u="jelly:util"
+ xmlns:ant="jelly:ant" xmlns:maven="jelly:maven" xmlns:m="maven"
+ xmlns:deploy="deploy">
+
+ <preGoal name="site">
+ <attainGoal name="docbook:transform"/>
+ </preGoal>
+
+ <postGoal name="site">
+ <attainGoal name="server:copy-images"/>
+ <attainGoal name="subproject:collectdocs"/>
+ </postGoal>
+
+ <goal name="subproject:collectdocs">
+ <ant:copy toDir="../../../sitedocs/trunk/sitedocs/target/docs/subprojects/eve">
+ <ant:fileSet dir="${basedir}/target/docs">
+ <ant:include name="**"/>
+ </ant:fileSet>
+ </ant:copy>
+ </goal>
+
+ <goal name="server:copy-images">
+ <copy toDir="target/docs/images">
+ <fileSet dir="${basedir}/src/images">
+ <include name="*.gif"/>
+ </fileSet>
+ </copy>
+ </goal>
+
+ <goal name="cleanall">
+ <attainGoal name="clean"/>
+ <delete dir="home"/>
+ </goal>
+
+ <goal name="java:compile" description="Build All Jar Files And Intall">
+ <maven:reactor basedir="${basedir}" postProcessing="true"
+ includes="**/project.xml" excludes="./project.xml" goals="jar:install"
+ banner="Building All" ignoreFailures="false"/>
+ </goal>
+
+ <goal name="sitedocs" description="Builds the entire site documentation">
+ <maven:reactor basedir="${basedir}" postProcessing="true"
+ includes="**/project.xml" excludes="./project.xml" goals="site"
+ banner="site" ignoreFailures="false"/>
+ </goal>
+
+ <goal name="clean-all" description="Clean all sandbox projects">
+ <maven:reactor basedir="${basedir}" postProcessing="true"
+ includes="*/project.xml" goals="clean" banner="Clean All"
+ ignoreFailures="true"/>
+ </goal>
+
+ <goal name="eclipse-all"
+ description="Generate eclipse descriptors for all projects">
+ <maven:reactor basedir="${basedir}" postProcessing="true"
+ includes="*/project.xml" goals="clean" banner="Clean All"
+ ignoreFailures="true"/>
+ </goal>
+
+ <goal name="eclipse-all" description="Create all eclipse projects">
+ <maven:reactor basedir="${basedir}" postProcessing="true"
+ includes="*/project.xml" goals="eclipse" banner="Eclipse Project"
+ ignoreFailures="true"/>
+ </goal>
+</project>
\ No newline at end of file
Modified: incubator/directory/eve/trunk/eve/project.xml
==============================================================================
--- incubator/directory/eve/trunk/eve/project.xml (original)
+++ incubator/directory/eve/trunk/eve/project.xml Sun Feb 1 00:49:31 2004
@@ -19,7 +19,7 @@
<repository>
<connection>
- scm:svn:http://cvs.apache.org/repos/asf/incubator/directory/ldap/trunk/${module.path}
+ scm:svn:http://cvs.apache.org/repos/asf/incubator/directory/ldap/trunk/${module.path}
</connection>
<url>
@@ -125,7 +125,7 @@
<license>
<name>Apache 1.1 License</name>
<url>
-http://cvs.apache.org/viewcvs.cgi/incubator/directory/LICENSE.txt?rev=1369&root=Apache-SVN&view=markup
+ http://cvs.apache.org/viewcvs.cgi/incubator/directory/LICENSE.txt?rev=1369&root=Apache-SVN&view=markup
</url>
<distribution>repo</distribution>
</license>
Added: incubator/directory/eve/trunk/eve/xdocs/backend/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/backend/index.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Eve Backend Subsystem</title>
+ </properties>
+
+ <body>
+ <section name="Eve Backend Subsystem">
+ <subsection name="Overview">
+ <p>
+ Coming soon ...
+ </p>
+
+ <table>
+ <tr>
+ <th>Heading I</th>
+ <th>Heading II</th>
+ </tr>
+
+ <tr>
+ <td>
+ Coming soon ...
+ </td>
+ <td>
+ <p>
+ Coming soon ...
+ </p>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Added: incubator/directory/eve/trunk/eve/xdocs/backend/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/backend/navigation.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project>
+
+ <title>Apache Directory Project</title>
+
+ <body>
+
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="../../index.html"/>
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </links>
+
+ <menu name="About Directory">
+ <item name="Overview" href="../../index.html"/>
+ <item name="Community" href="../../community/index.html"/>
+ <item name="Latest News" href="../../news.html"/>
+ <item name="Sub-Projects" href="../../subprojects/index.html">
+ <item name="Eve" href="/index.html">
+ <item name="Design" href="/design.html"/>
+ <item name="Features" href="/features.html"/>
+ <item name="Backend" href="/backend/index.html"/>
+ <item name="Frontend" href="/frontend/index.html"/>
+ </item>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="../../doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <item name="Jira" href=
+ "http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory"/>
+ <item name="Lists" href="../../mailing-lists.html"/>
+ <item name="License" href="../../license.html"/>
+ <item name="Sandbox" href="../../sandbox/index.html"/>
+ <item name="Downloads" href="../../download.cgi"/>
+ <item name="Subversion" href="../../svn.html"/>
+ <item name="Related Projects" href="../../related/index.html"/>
+ </menu>
+
+ </body>
+
+</project>
Added: incubator/directory/eve/trunk/eve/xdocs/design.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/design.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Eve Directory Server</title>
+ </properties>
+
+ <body>
+ <section name="Design">
+
+ <subsection name="General Overview">
+ <p>
+ The server is designed as a system of components. Some components
+ are a collection of other components with a facade to form a subsystem
+ of the server. Subsystems can contain other subsystems and one
+ component can depend on another.
+ </p>
+
+ <p>
+ A micro kernel or component container is required to run the server.
+ A micro kernel is a peice of code operating as a component container
+ providing services for that component and running the component
+ through a set of life-cycles. Eve is designed to run on any micro
+ kernel. Her subsystems and components are designed as Plain Old Java
+ Objects (POJOs) that can be wrapped to make them interoperate within
+ different containers. Eve currently will work out of the box with
+ Merlin and PicoContainer.
+ </p>
+
+ <p>
+ Each component within Eve has a service interface which defines to
+ the world what that component can do for its clients. The service
+ interface is kept separate from any component implementation.
+ Different projects are used to separate them. An SPI project is often
+ used to contain the service interface and other interfaces associated
+ with the component. Providers of the service must implement the
+ interfaces in the SPI. These component implementations are often
+ kept in separate projects. The drive behind this approach has to do
+ with modularity and classloader schemes. It is always good to keep
+ the interfaces separate from any specific implementations. You can
+ have many implementations for the same service interface. Secondly
+ the classloader heirarchy in containers often puts implementation
+ classloaders under a classloader containing the service interface.
+ This allows containers to manage multiple implementations for the
+ same service without having conflicts. Also implementations can be
+ created and destroyed in separate classloaders without affecting one
+ another.
+ </p>
+
+ <p>
+ Eve tries to make a logical distinction between various subsystems and
+ separates out its components in a heirarchy based on function within
+ the source code repository. The aspects of each subsystem shall be
+ discussed in detail within the documentation set for that subsystem.
+ Developers looking at Eve's source should know that the Subversion
+ repository is structured to mimic this component containment
+ heirarchy. Here's a brief listing of the directory structure we're
+ referring to:
+ </p>
+
+ <source>
+${basedir}/frontend -- holds frontend subsystem components
+ ./buffer/spi -- holds buffer component SPI
+ ./buffer/impl -- holds buffer component implementation
+...
+ </source>
+
+ <p>
+ The structure above my nest deeper for other subsystems. For example
+ the backend subsystem has within it other sub subsystems. Each
+ subsystem itself is a new directory depth. In turn this subsystem
+ may have other subsystems and or component directories that have an
+ SPI and an implementation project. Some subsystems may have a common
+ API under a common directory used to centralize some classes shared
+ by the subsystem. This helps localize domain specific classes and
+ interfaces and helps reduce the possibility of cyclic java class
+ dependencies between component projects within the subsystem.
+ Basically if there are classes that depend on each other but are
+ kept apart in separate component projects, they create a dependency
+ between the two projects when both classes are needed by both
+ projects. To decouple these component projects we relocate these
+ ancillary non SPI classes into the common API where possible. This
+ way both component projects depend on a common API rather than each
+ other.
+ </p>
+ </subsection>
+
+ <subsection name="Major Subsystems">
+ <p>
+
+ </p>
+ </subsection>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Added: incubator/directory/eve/trunk/eve/xdocs/features.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/features.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Eve's Features</title>
+ </properties>
+
+ <body>
+ <section name="Eve's Features">
+ <p>
+ The Eve Directory Server is an embeddable LDAP server implemented in
+ pure Java. It has several features that make it unique amoung LDAP
+ servers. These features are described below:
+ </p>
+
+ <ul>
+ <li>
+ Designed as an LDAP and X.500 experimentation platform. Plugable
+ components and subsystems make Eve extremely modular and perfect for
+ experiments with various aspects of the LDAP and X.500 protocols. Eve
+ can run on any IoC based microkernel using IoC type wrappers for her
+ components.
+ </li>
+
+ <li>
+ Eve's frontend is completely separable from its backend and
+ vice-versa making it very conducive for implementing virtual
+ directories and front ends to X.500.
+ </li>
+
+ <li>
+ Several backends can be implemented and plugged into Eve's backend
+ nexus. Eve will initially support a custom JDBM and JDBC based
+ backend but any backend can be implemented so long as it conforms to
+ the backend SPI.
+ </li>
+
+ <li>
+ Eve exposes all aspects of administration via a special system
+ backend. LDAP can be used to manage these concerns through the
+ system context.
+ </li>
+
+ <li>
+ Java and Groovy based triggers and stored procedures are supported
+ by Eve's backend subsystem. Any backends plugged into the nexus
+ are automatically decorated with these features.
+ </li>
+
+ <li>
+ Both Eve's backend and her frontend are embeddable.
+ </li>
+
+ <li>
+ Eve implements a server side JNDI LDAP provider as the facade for the
+ entire backend subsystem. JNDI operations are directly translated by
+ this provider into operations against the nexus and the target
+ backend.
+ </li>
+
+ <li>
+ Eve uses JNDI as the data access API for stored procedures. This
+ makes stored procedures functional within and outside of the server
+ without requiring recompilation.
+ </li>
+
+ <li>
+ Eve is based on a simple Staged Event Driven Architecture (SEDA) which
+ gives Eve the ability to handle large amounts of concurrency.
+ </li>
+
+ <li>
+ Eve uses the Snickers tools and APIs for ASN.1 BER encoding and
+ decoding. These tools are designed for a very small encoding and
+ decoding footprint as well as for use in non-blocking servers. The
+ revolutionary event based processing of BER messages makes Eve very
+ efficient at handling this aspect of the protocol.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: incubator/directory/eve/trunk/eve/xdocs/frontend/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/frontend/index.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Eve Frontend Subsystem</title>
+ </properties>
+
+ <body>
+ <section name="Eve Frontend Subsystem">
+ <subsection name="Overview">
+ <p>
+ Coming soon ...
+ </p>
+
+ <table>
+ <tr>
+ <th>Heading I</th>
+ <th>Heading II</th>
+ </tr>
+
+ <tr>
+ <td>
+ Coming soon ...
+ </td>
+ <td>
+ <p>
+ Coming soon ...
+ </p>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Added: incubator/directory/eve/trunk/eve/xdocs/frontend/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/frontend/navigation.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project>
+
+ <title>Apache Directory Project</title>
+
+ <body>
+
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="../../index.html"/>
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </links>
+
+ <menu name="About Directory">
+ <item name="Overview" href="../../index.html"/>
+ <item name="Community" href="../../community/index.html"/>
+ <item name="Latest News" href="../../news.html"/>
+ <item name="Sub-Projects" href="../../subprojects/index.html">
+ <item name="Eve" href="/index.html">
+ <item name="Design" href="/design.html"/>
+ <item name="Features" href="/features.html"/>
+ <item name="Backend" href="/backend/index.html"/>
+ <item name="Frontend" href="/frontend/index.html"/>
+ </item>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="../../doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <item name="Jira" href=
+ "http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory"/>
+ <item name="Lists" href="../../mailing-lists.html"/>
+ <item name="License" href="../../license.html"/>
+ <item name="Sandbox" href="../../sandbox/index.html"/>
+ <item name="Downloads" href="../../download.cgi"/>
+ <item name="Subversion" href="../../svn.html"/>
+ <item name="Related Projects" href="../../related/index.html"/>
+ </menu>
+
+ </body>
+
+</project>
Added: incubator/directory/eve/trunk/eve/xdocs/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/index.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Apache Directory Project: Eve Directory Server</title>
+ </properties>
+
+ <body>
+ <section name="Overview">
+ <subsection name="">
+ <p>
+ Coming soon ...
+ </p>
+
+ <table>
+ <tr>
+ <th>Heading I</th>
+ <th>Heading II</th>
+ </tr>
+
+ <tr>
+ <td>
+ Coming soon ...
+ </td>
+ <td>
+ <p>
+ Coming soon ...
+ </p>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Added: incubator/directory/eve/trunk/eve/xdocs/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/eve/trunk/eve/xdocs/navigation.xml Sun Feb 1 00:49:31 2004
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project>
+
+ <title>Apache Directory Project</title>
+
+ <body>
+
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="../../index.html"/>
+ <item name="Eve" href="/index.html"/>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </links>
+
+ <menu name="About Directory">
+ <item name="Overview" href="../../index.html"/>
+ <item name="Community" href="../../community/index.html"/>
+ <item name="Latest News" href="../../news.html"/>
+ <item name="Sub-Projects" href="../../subprojects/index.html">
+ <item name="Eve" href="/index.html">
+ <item name="Design" href="/design.html"/>
+ <item name="Features" href="/features.html"/>
+ <item name="Backend" href="/backend/index.html"/>
+ <item name="Frontend" href="/frontend/index.html"/>
+ </item>
+ <item name="LDAP" href="../ldap/index.html"/>
+ <item name="Janus" href="../janus/index.html"/>
+ <item name="Naming" href="../naming/index.html"/>
+ <item name="Snickers" href="../snickers/index.html"/>
+ <item name="Sitedocs" href="../sitedocs/index.html"/>
+ </item>
+ <item name="Documentation" href="../../doc/index.html"/>
+ </menu>
+
+ <menu name="Resources">
+ <item name="Jira" href=
+ "http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10400"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory"/>
+ <item name="Lists" href="../../mailing-lists.html"/>
+ <item name="License" href="../../license.html"/>
+ <item name="Sandbox" href="../../sandbox/index.html"/>
+ <item name="Downloads" href="../../download.cgi"/>
+ <item name="Subversion" href="../../svn.html"/>
+ <item name="Related Projects" href="../../related/index.html"/>
+ </menu>
+
+ </body>
+
+</project>