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/01/18 21:40:36 UTC
svn commit: rev 6213 - in incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl: src/java/org/apache/eve/schema xdocs xdocs/classes xdocs/classes/CVS xdocs/components xdocs/components/CVS xdocs/config xdocs/schema
Author: akarasulu
Date: Sun Jan 18 12:40:36 2004
New Revision: 6213
Added:
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Entries
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Repository
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Root
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/diagram.gif (contents, props changed)
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/index.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/navigation.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Entries
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Repository
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Root
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/diagram.gif (contents, props changed)
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/index.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/navigation.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/index.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/navigation.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/diagram.png (contents, props changed)
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/index.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/navigation.xml
Modified:
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/src/java/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xsd
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/index.xml
incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/navigation.xml
Log:
Added some example documentation to be followed as the
standard for components within the server.
Modified: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/src/java/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xsd
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/src/java/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xsd (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/src/java/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xsd Sun Jan 18 12:40:36 2004
@@ -1,34 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSPY v2004 rel. 3 U (http://www.xmlspy.com) by Alex Karasulu (CITISTREET) -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
- <xs:element name="configuration">
- <xs:annotation>
- <xs:documentation>A syntax registry configuration node</xs:documentation>
- </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="syntax" type="syntax" maxOccurs="unbounded"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:complexType name="syntax">
- <xs:annotation>
- <xs:documentation>An X.500 Syntax Definition</xs:documentation>
- </xs:annotation>
- <xs:choice minOccurs="3" maxOccurs="5">
- <xs:element name="oid" type="xs:string"/>
- <xs:element name="name" type="xs:string"/>
- <xs:element name="description" type="xs:string" minOccurs="0"/>
- <xs:element name="human-readable" type="xs:boolean" minOccurs="0"/>
- <xs:element name="syntax-checker">
- <xs:complexType>
- <xs:choice>
- <xs:element name="built-in" type="xs:string"/>
- <xs:element name="regex" type="xs:string" maxOccurs="unbounded"/>
- <xs:element name="class" type="xs:string"/>
- </xs:choice>
- </xs:complexType>
- </xs:element>
- </xs:choice>
- </xs:complexType>
+ <xs:element name="configuration">
+ <xs:annotation>
+ <xs:documentation>A syntax registry configuration node</xs:documentation>
+ </xs:annotation>
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element name="syntax" type="syntax" maxOccurs="unbounded"/>
+ </xs:sequence>
+ </xs:complexType>
+ </xs:element>
+ <xs:complexType name="syntax">
+ <xs:annotation>
+ <xs:documentation>An X.500 Syntax Definition</xs:documentation>
+ </xs:annotation>
+ <xs:choice minOccurs="3" maxOccurs="5">
+ <xs:element name="oid" type="xs:string"/>
+ <xs:element name="name" type="xs:string"/>
+ <xs:element name="description" type="xs:string" minOccurs="0"/>
+ <xs:element name="human-readable" type="xs:boolean" default="false" minOccurs="0"/>
+ <xs:element name="syntax-checker">
+ <xs:complexType>
+ <xs:choice>
+ <xs:element name="built-in" type="xs:string"/>
+ <xs:element name="regex" type="xs:string" maxOccurs="unbounded"/>
+ <xs:element name="class" type="xs:string"/>
+ </xs:choice>
+ </xs:complexType>
+ </xs:element>
+ </xs:choice>
+ </xs:complexType>
</xs:schema>
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Entries
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Entries Sun Jan 18 12:40:36 2004
@@ -0,0 +1,3 @@
+/index.xml/1.1/Thu Dec 4 21:01:32 2003//
+/navigation.xml/1.1/Thu Dec 4 21:01:32 2003//
+D
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Repository
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Repository Sun Jan 18 12:40:36 2004
@@ -0,0 +1 @@
+avalon/util/xdocs/factory
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Root
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/CVS/Root Sun Jan 18 12:40:36 2004
@@ -0,0 +1 @@
+:ext:akarasulu@cvs.apache.org:/home/cvs
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/diagram.gif
==============================================================================
Binary file. No diff available.
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/index.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,104 @@
+<?xml version="1.0"?>
+
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Classes</title>
+ </properties>
+ <body>
+ <section name="Classes">
+ <img src="diagram.gif"/>
+ <subsection name="Legend">
+ <table>
+ <tr>
+ <th>Color</th>
+ <th>Category</th>
+ </tr>
+ <tr>
+ <td>Yellow</td>
+ <td>Component (and dependent) service interfaces</td>
+ </tr>.
+ <tr>
+ <td>Red</td>
+ <td>Simple POJO implementation of the service.</td>
+ </tr>
+ <tr>
+ <td>Purple</td>
+ <td>Merlin component implementation wrapping the POJO.</td>
+ </tr>.
+ </table>
+ </subsection>
+ <subsection name="Overview">
+ <p>
+The service interface is the SyntaxRegistry. This component implements
+this service interface.
+ </p>
+ <p>
+The Merlin component is a wrapper around the BootstrapSyntaxRegistry
+that implements the SyntaxRegistry interface and uses the Avalon lifecycles
+to initialize the BootstrapSyntaxRegistry instance it contains. The OidRegistry
+is a service interface which both the POJO and the Merlin component depends
+on. The component dependencies are illustrated in the component diagram.
+ </p>
+ <p>
+The bootstrap component does not implement the registration methods because
+it is static. It reads the XML configuration file from which it extracts
+the required set of Syntaxes to operate. The POJO implementation or delegate
+as we call it throws a UnsupportedOperation exception which is a form of
+NamingException.
+ </p>
+ </subsection>
+ </section>
+ </body>
+
+</document>
+
+
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/classes/navigation.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+<project>
+ <title>Bootstrap Syntax Registry</title>
+ <body>
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="http://directory.apache.org/"/>
+ </links>
+ <menu name="About Utilities">
+ <item name="Overview" href="/index.html"/>
+ <item name="Components" href="/components/index.html"/>
+ <item name="Classes" href="/classes/index.html"/>
+ <item name="Schema" href="/schema/index.html"/>
+ <item name="Configuration" href="/config/index.html"/>
+ </menu>
+ </body>
+</project>
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Entries
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Entries Sun Jan 18 12:40:36 2004
@@ -0,0 +1,3 @@
+/index.xml/1.1/Thu Dec 4 21:01:32 2003//
+/navigation.xml/1.1/Thu Dec 4 21:01:32 2003//
+D
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Repository
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Repository Sun Jan 18 12:40:36 2004
@@ -0,0 +1 @@
+avalon/util/xdocs/factory
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Root
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/CVS/Root Sun Jan 18 12:40:36 2004
@@ -0,0 +1 @@
+:ext:akarasulu@cvs.apache.org:/home/cvs
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/diagram.gif
==============================================================================
Binary file. No diff available.
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/index.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Components</title>
+ </properties>
+ <body>
+ <section name="Components">
+ <img src="diagram.gif"/>
+ <subsection name="Legend">
+ <table>
+ <tr>
+ <th>Color</th>
+ <th>Category</th>
+ </tr>
+ <tr>
+ <td>Yellow</td>
+ <td>Component service interfaces</td>
+ </tr>.
+ <tr>
+ <td>Green</td>
+ <td>Simple POJO implementations of the service.</td>
+ </tr>
+ <tr>
+ <td>Purple</td>
+ <td>Merlin wrapper implementations of the service.</td>
+ </tr>
+ </table>
+ </subsection>
+
+ <subsection name="Overview">
+ <p>
+ This component diagram shows the dependencies between simple
+ implementations and the Merlin wrappers. All dependencies as
+ expected are based on the service interfaces exposed. For
+ simplicity the implemented service interface has been replicated
+ rather than sharing the interface between multiple components:
+ there is only one interface object however.
+ </p>
+ </subsection>
+ </section>
+ </body>
+
+</document>
+
+
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/components/navigation.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+<project>
+ <title>Bootstrap Syntax Registry</title>
+ <body>
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="http://directory.apache.org/"/>
+ </links>
+ <menu name="About Utilities">
+ <item name="Overview" href="/index.html"/>
+ <item name="Components" href="/components/index.html"/>
+ <item name="Classes" href="/classes/index.html"/>
+ <item name="Schema" href="/schema/index.html"/>
+ <item name="Configuration" href="/config/index.html"/>
+ </menu>
+ </body>
+</project>
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/index.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Configuration</title>
+ </properties>
+ <body>
+ <section name="Configuration">
+ <subsection name="Download">
+ <p>
+The configuration XML source is available
+<a href="../../classes/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xconfig">here</a>.
+ </p>
+ </subsection>
+ </section>
+ </body>
+
+</document>
+
+
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/config/navigation.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+<project>
+ <title>Bootstrap Syntax Registry</title>
+ <body>
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="http://directory.apache.org/"/>
+ </links>
+ <menu name="About Utilities">
+ <item name="Overview" href="/index.html"/>
+ <item name="Components" href="/components/index.html"/>
+ <item name="Classes" href="/classes/index.html"/>
+ <item name="Schema" href="/schema/index.html"/>
+ <item name="Configuration" href="/config/index.html"/>
+ </menu>
+ </body>
+</project>
Modified: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/index.xml
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/index.xml (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/index.xml Sun Jan 18 12:40:36 2004
@@ -58,21 +58,26 @@
Eve's backend under the schema subsystem.
</p>
<p>
-Eve must be able to resolve schema syntax definitions based either on name or OID.
-The SyntaxRegistry service interface provides for easy lookup and registration of
-schema syntaxes.
+Eve must be able to resolve schema syntax definitions based either on name or
+OID. The SyntaxRegistry service interface provides for easy lookup and
+registration of schema syntaxes.
</p>
<p>
-On startup Eve does not have certain resources available to it. One of these
-resources is the system backend where the schema data is stored and maintained.
-The standard syntax registry used to manage syntaxes within the server uses the
-system backend as the backing store for syntax information. Most of the system
-registries in the solid state of the server use the system backend as the
-backing store for their respective entities. On startup certain syntaxes are
-are required just to initialize the system backend. Rather than impose cyclic
-dependencies between components we've created a transient bootstrapping
-component implementation of the SyntaxRegistry service to provide the required
-syntaxes for startup just during server initialization.
+This componenet is a special form of SyntaxRegistry only used during the
+initialization of the server. There is yet another SyntaxRegistry used during
+the solid state of operation. This is the default SyntaxRegistry and it
+depends on the system backend as its backing store for Syntax data. During
+server startup the system backend is unavailable yet certain syntaxes are
+still required by the server to initialize the system backend in the first
+place.
+ </p>
+ <p>
+Rather than have a cycle of dependency between the system backend and a
+SyntaxRegisrty we opted to create two totally different implementations.
+This implementation simply reads configuration information from an XML
+file which is used as its read only Syntax backing store. After its use
+is fulfilled during startup the compoenent is never used again and can
+be decomissioned.
</p>
<subsection name="Overview">
<table>
@@ -81,25 +86,24 @@
<th>Description</th>
</tr>
<tr>
- <td><a href="uml/components/index.html">Components</a></td>
- <td>A UML Component relationship diagram.</td>
+ <td><a href="components/index.html">Components</a></td>
+ <td>UML Component relationship diagram.</td>
</tr>
<tr>
- <td><a href="uml/classes/index.html">Classes</a></td>
- <td>A UML Class diagram</td>
+ <td><a href="classes/index.html">Classes</a></td>
+ <td>UML Class diagram</td>
</tr>
<tr>
- <td><a href="xml-schema/index.html">Schema</a></td>
+ <td><a href="schema/index.html">Schema</a></td>
<td>
XML Schema documentation for the XML configuration.
</td>
</tr>
<tr>
- <td><a
- href="../classes/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xconfig"
- >Configuration</a>
+ <td><a href="config/index.html">
+ Configuration</a>
</td>
- <td>The XML Configuration for this component.</td>
+ <td>XML Configuration for this component.</td>
</tr>
</table>
</subsection>
Modified: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/navigation.xml
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/navigation.xml (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/navigation.xml Sun Jan 18 12:40:36 2004
@@ -55,10 +55,10 @@
</links>
<menu name="About Utilities">
<item name="Overview" href="/index.html"/>
- <item name="UML Component Diagram" href="/uml/components/index.html"/>
- <item name="UML Class Diagram" href="/uml/classes/index.html"/>
- <item name="XML Schema" href="/xml-schema/index.html"/>
- <item name="XML Configuration" href="../classes/org/apache/eve/schema/MerlinBootstrapSyntaxRegistry.xconfig"/>
+ <item name="Components" href="/components/index.html"/>
+ <item name="Classes" href="/classes/index.html"/>
+ <item name="Schema" href="/schema/index.html"/>
+ <item name="Configuration" href="/config/index.html"/>
</menu>
</body>
</project>
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/diagram.png
==============================================================================
Binary file. No diff available.
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/index.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/index.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,141 @@
+<?xml version="1.0"?>
+
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+
+<document>
+ <properties>
+ <author email="akarasulu@apache.org">Alex Karasulu</author>
+ <title>Schema</title>
+ </properties>
+ <body>
+ <section name="Schema">
+ <img src="diagram.png"/>
+ <subsection name="Legend">
+ <table>
+ <tr>
+ <th>Tag</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>configuration</td>
+ <td>Top level component configuration</td>
+ </tr>
+ <tr>
+ <td>syntax</td>
+ <td>Syntax definition</td>
+ </tr>
+ <tr>
+ <td>oid</td>
+ <td>IANA assigned object idendifier for the syntax</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>Descriptive human readible name for the syntax</td>
+ </tr>
+ <tr>
+ <td>description</td>
+ <td>Optional description for the syntax</td>
+ </tr>
+ <tr>
+ <td>human-readable</td>
+ <td>Optional human readable flag which indicates whether
+ or not values of this syntax can be read by humans. Flag
+ defaults to false when not provided.</td>
+ </tr>
+ <tr>
+ <td>syntax-checker</td>
+ <td>Every syntax must provide a syntax checker to validate
+ values of the syntax.</td>
+ </tr>
+ <tr>
+ <td>built-in</td>
+ <td>Choice to indicate the label of the built in syntax checker
+ used to validate values of the syntax.</td>
+ </tr>
+ <tr>
+ <td>regex</td>
+ <td>One or more perl regular expression filters can be defined
+ to determine if the syntax is valid. A value must be matched
+ by all of the regular expressions in order to be deemed valid.
+ </td>
+ </tr>
+ <tr>
+ <td>class</td>
+ <td>Contains a fully qualified class name used to reference a
+ class implementing the SyntaxChecker interface for the
+ specified syntax.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Overview">
+ <p>
+ Syntaxes for the bootstrap syntax registry are defined here within
+ the configuration for the component.
+ </p>
+ <p>
+ Several syntaxes each with its own SyntaxChecker can be defined.
+ The registry cannot add to the definitions provided here and hence
+ is static. Calls to the register methods of the SyntaxRegistry
+ interfaces for this component generate exceptions indicating that
+ the operation is not supported.
+ </p>
+ <p>
+ Note that only those syntaxes absolutely required for the server
+ to initialize are required here. The solid state implementation
+ of the SyntaxRegistry should be used for dynamic Syntax additions
+ to the server after it has started up.
+ </p>
+ </subsection>
+ </section>
+ </body>
+
+</document>
+
+
Added: incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/navigation.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/syntax/bootstrap-impl/xdocs/schema/navigation.xml Sun Jan 18 12:40:36 2004
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============================================================================
+ The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+ include the following acknowledgment: "This product includes software
+ developed by the Apache Software Foundation (http://www.apache.org/)."
+ Alternately, this acknowledgment may appear in the software itself, if
+ and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
+ "Apache Software Foundation" must not be used to endorse or promote
+ products derived from this software without prior written
+ permission. For written permission, please contact apache@apache.org.
+
+ 5. Products derived from this software may not be called "Apache", nor may
+ "Apache" appear in their name, without prior written permission of the
+ Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many individuals
+ on behalf of the Apache Software Foundation. For more information on the
+ Apache Software Foundation, please see http://www.apache.org/.
+-->
+<project>
+ <title>Bootstrap Syntax Registry</title>
+ <body>
+ <links>
+ <item name="Apache" href="http://apache.org/"/>
+ <item name="Directory" href="http://directory.apache.org/"/>
+ </links>
+ <menu name="About Utilities">
+ <item name="Overview" href="/index.html"/>
+ <item name="Components" href="/components/index.html"/>
+ <item name="Classes" href="/classes/index.html"/>
+ <item name="Schema" href="/schema/index.html"/>
+ <item name="Configuration" href="/config/index.html"/>
+ </menu>
+ </body>
+</project>