directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fel...@apache.org
Subject svn commit: r985852 - /directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml
Date Mon, 16 Aug 2010 10:00:59 GMT
Author: felixk
Date: Mon Aug 16 10:00:59 2010
New Revision: 985852

URL: http://svn.apache.org/viewvc?rev=985852&view=rev
Log:
Start with advanced-user-guide

Modified:
    directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml

Modified: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml?rev=985852&r1=985851&r2=985852&view=diff
==============================================================================
--- directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml
(original)
+++ directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-protocol-providers.xml
Mon Aug 16 10:00:59 2010
@@ -2980,9 +2980,315 @@ o: Example Inc.
   <section
     id="NTP Protocol Provider">
     <title>NTP Protocol Provider</title>
+    <important>
+      <title>Work in progress</title>
+      <para>This site is in the process of being reviewed and updated.</para>
+    </important>
+    <section
+      id="Introduction NTP Protocol Provider">
+      <title>Introduction</title>
+      <para>
+        The Apache NTP Protocol Provider is a Java server that implements
+        <link
+          xlink:href="http://www.faqs.org/rfcs/rfc2030.html">RFC 2030</link>
+        to service Simple Network Time Protocol requests. The Network Time Protocol is used
to synchronize computer
+        clocks on the Internet.
+      </para>
+      <para>
+        Apache NTP, in conjunction with MINA and the Apache Directory, provides an easy-to-use
yet fully-featured
+        network time synchronization service. As implemented within the Apache Directory,
Apache NTP will provide:
+        <itemizedlist>
+          <listitem>
+            <para>Simple Network Time Protocol (SNTP) service (RFC 2030)</para>
+          </listitem>
+          <listitem>
+            <para>JMX remote management (JSR 160, JSR 28)</para>
+          </listitem>
+          <listitem>
+            <para>UDP and TCP Support (MINA)</para>
+          </listitem>
+          <listitem>
+            <para>Easy POJO embeddability for containers such as Geronimo, JBoss, and
OSGi</para>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </section>
+    <section
+      id="Basic Testing NTP Protocol Provider">
+      <title>Basic Testing</title>
+      <para>
+        On Linux:
+        <screen><![CDATA[
+bash-2.05b# ntpdate -u localhost
+      ]]></screen>
+      </para>
+    </section>
+    <section
+      id="Resources NTP Protocol Provider">
+      <title>Resources</title>
+      <section
+        id="SNTP RFC's">
+        <title>SNTP RFC's</title>
+        <itemizedlist>
+          <listitem>
+            <para>
+              RFC 2030 - Simple Network Time Protocol (SNTP) Version 4 for IPv4, IPv6 and
OSI
+              <link
+                xlink:href="http://www.faqs.org/rfcs/rfc2030.html">http://www.faqs.org/rfcs/rfc2030.html</link>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              RFC 1305 - Network Time Protocol (Version 3) Specification, Implementation
and Analysis
+              <link
+                xlink:href="http://www.faqs.org/rfcs/rfc1305.html">http://www.faqs.org/rfcs/rfc1305.html</link>
+            </para>
+          </listitem>
+        </itemizedlist>
+      </section>
+    </section>
+    <section
+      id="NTP Protocol Configuration">
+      <title>NTP Protocol Configuration</title>
+      <warning>
+        <para>This page is only valid with ADS 1.5.5 !</para>
+      </warning>
+      <para>
+        The server.xml file contains the bas configuration for the NTP server :
+        <programlisting><![CDATA[
+<ntpServer id="ntpServer" ipPort="60123" nbThreads="2"/>
+      ]]></programlisting>
+      </para>
+      <para>With such a configuration, the NTP server will listen to port 60123, with
UDP and TCP transports selected.
+      </para>
+      <section
+        id="Common Service Configuration Parameters NTP Protocol Configuration">
+        <title>Common Service Configuration Parameters</title>
+        <para>Here is the list of parameters you can set. The bold parameters are mandatory.</para>
+        <table
+          id="Common Service Configuration Parameters NTP Protocol Configuration table">
+          <title>Common Service Configuration Parameters</title>
+          <tgroup
+            cols="4">
+            <thead>
+              <row>
+                <entry>Parameter</entry>
+                <entry>value</entry>
+                <entry>Description</entry>
+                <entry>Optional</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <emphasis
+                    role="bold">id</emphasis>
+                </entry>
+                <entry>
+                  <emphasis
+                    role="bold">"ntpServer"</emphasis>
+                </entry>
+                <entry>Do not change this value : it is used internally to identify
the NTP server instance</entry>
+                <entry>NA</entry>
+              </row>
+              <row>
+                <entry>serviceName</entry>
+                <entry>Apache NTP Service</entry>
+                <entry>The friendly name of this service.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>enabled</entry>
+                <entry>true</entry>
+                <entry>Tells if the server is enabled or not.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>ipAddress</entry>
+                <entry>localhost</entry>
+                <entry>The IP address for this service.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>ipBacklog</entry>
+                <entry>50</entry>
+                <entry>The backlog size for both UDP and TCP transport</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>
+                  <emphasis
+                    role="bold">ipPort</emphasis>
+                </entry>
+                <entry>123</entry>
+                <entry>The IP port for this service. It is valid for both UDP and TCP
transports. To define only one of
+                  those two transports, or to set a specific port for each transport, use
the two following parameters
+                </entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>nbThreads</entry>
+                <entry>2</entry>
+                <entry>The number of thread used by the service IoProcessor</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>tcpBacklog</entry>
+                <entry>50</entry>
+                <entry>The backlog size for the TCP transport.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>tcpPort</entry>
+                <entry>123</entry>
+                <entry>The TCP port for this service.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>nbTcpThreads</entry>
+                <entry>2</entry>
+                <entry>The number of thread used by the TCP service IoProcessor</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>udpBacklog</entry>
+                <entry>50</entry>
+                <entry>The backlog size for the UDP transport</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>udpPort</entry>
+                <entry>123</entry>
+                <entry>The UDP port for this service.</entry>
+                <entry>yes</entry>
+              </row>
+              <row>
+                <entry>nbUdpThreads</entry>
+                <entry>2</entry>
+                <entry>The number of thread used by the UDP service IoProcessor</entry>
+                <entry>yes</entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </table>
+        <important>
+          <para>The last six parameters should be used only if one want to set up only
a single transport, or when UDP
+            and TCP transport don't share the same port.</para>
+        </important>
+      </section>
+      <section
+        id="More Information NTP Protocol Configuration">
+        <title>More Information</title>
+        <para>
+          For help with more advanced configurations, check out our
+          <link
+            xlink:href="http://cwiki.apache.org/DIRxINTEROP/">Interoperability Guide</link>
+          .
+        </para>
+      </section>
+    </section>
   </section>
   <section
     id="DHCP Protocol Provider">
     <title>DHCP Protocol Provider</title>
+    <important>
+      <title>Work in progress</title>
+      <para>This site is in the process of being reviewed and updated.</para>
+    </important>
+    <section
+      id="Introduction DHCP Protocol Provider">
+      <title>Introduction</title>
+      <para>
+        The ApacheDS Dynamic Host Configuration Protocol (DHCP) provider implements
+        <link
+          xlink:href="http://www.faqs.org/rfcs/rfc2131.html">RFC 2131</link>
+        and
+        <link
+          xlink:href="http://www.faqs.org/rfcs/rfc2132.html">RFC 2132</link>
+        to pass configuration information to hosts on a TCP/IP network.
+      </para>
+      <para>The DHCP provider is implemented plugin into the ApacheDS network layer
(MINA). As a plugin, DHCP leverages
+        Apache MINA for front-end services and the Apache Directory read-optimized backing
store via JNDI for a
+        persistent store.</para>
+      <para>
+        The ApacheDS DHCP plugin, in conjunction with MINA and the Apache Directory store,
provides an easy-to-use yet
+        fully-featured dynamic configuration service. As implemented within the Apache Directory,
DHCP will provide:
+        <itemizedlist>
+          <listitem>
+            <para>DHCP service (RFC 2131, 2132)</para>
+          </listitem>
+          <listitem>
+            <para>Vendor extensions (RFC 1497)</para>
+          </listitem>
+          <listitem>
+            <para>Service Location Protocol (SLP) support (RFC 2608)</para>
+          </listitem>
+          <listitem>
+            <para>Optional LDAP management</para>
+          </listitem>
+          <listitem>
+            <para>UDP and TCP Support (MINA)</para>
+          </listitem>
+          <listitem>
+            <para>Easy POJO embeddability for containers such as Geronimo, JBoss, and
OSGi</para>
+          </listitem>
+        </itemizedlist>
+      </para>
+      <section
+        id="DHCP Notes">
+        <title>DHCP Notes</title>
+        <itemizedlist>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://www.linux.com/howtos/Clone-HOWTO/setting-up.shtml">Setting
up DHCP and TFTP servers</link>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://204.182.52.180/fom-serve/cache/7.html">PXE using etherboot:
HOWTO</link>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://www.j51.com/~sshay/tcpip/dhcp/dhcp.htm">How DHCP works</link>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://www.faqs.org/rfcs/rfc1533.html">RFC 1533</link>
+              - DHCP Options and BOOTP Vendor Extensions
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://www.faqs.org/rfcs/rfc1534.html">RFC 1534</link>
+              - Interoperation Between DHCP and BOOTP
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link
+                xlink:href="http://www.faqs.org/rfcs/rfc3118.html">RFC 3118</link>
+              - Authentication for DHCP Messages
+            </para>
+          </listitem>
+        </itemizedlist>
+      </section>
+    </section>
+    <section
+      id="More Information DHCP Protocol Provider">
+      <title>More Information</title>
+      <para>
+        For help with more advanced configurations, check out our
+        <link
+          xlink:href="http://cwiki.apache.org/DIRxINTEROP/">Interoperability Guide</link>
+        .
+      </para>
+    </section>
   </section>
 </chapter>



Mime
View raw message