You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/06/19 19:42:59 UTC

cvs commit: avalon-components/site/xdocs/components connection.xml datasource.xml

mcconnell    2003/06/19 10:42:59

  Modified:    datasources-impl/conf block.xml
               site/xdocs/components connection.xml datasource.xml
  Log:
  Documation enhancement.
  
  Revision  Changes    Path
  1.2       +0 -2      avalon-components/datasources-impl/conf/block.xml
  
  Index: block.xml
  ===================================================================
  RCS file: /home/cvs/avalon-components/datasources-impl/conf/block.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- block.xml	19 Jun 2003 16:59:02 -0000	1.1
  +++ block.xml	19 Jun 2003 17:42:59 -0000	1.2
  @@ -33,8 +33,6 @@
        <component name="manager" 
           class="org.apache.avalon.cornerstone.blocks.datasources.DefaultDataSourceSelector" 
           activation="true">
  -       <configuration>
  -       </configuration>
        </component>
   
      </implementation>
  
  
  
  1.2       +43 -3     avalon-components/site/xdocs/components/connection.xml
  
  Index: connection.xml
  ===================================================================
  RCS file: /home/cvs/avalon-components/site/xdocs/components/connection.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- connection.xml	4 May 2003 12:19:49 -0000	1.1
  +++ connection.xml	19 Jun 2003 17:42:59 -0000	1.2
  @@ -4,15 +4,55 @@
   
     <properties>
       <author email="mcconnell@apache.org">Stephen McConnell</author>
  -    <title>Cornerstone Scheduler</title>
  +    <title>Cornerstone Connection</title>
     </properties>
   
     <body>
  -    <section name="Cornerstone Components - Connnection">
  -      <p><strong>PLACEHOLDER</strong></p>
  +    <section name="Cornerstone Components - Connection">
  +      <subsection name="Description">
  +            <p>
  +            The ConnectionManager service provides a facility to listen 
  +            for incoming socket connections.
  +            The DefaultConnectionManager compoent gives a thread pooled 
  +            implementation of this service. If there are multiple server 
  +            components depending on this component, they would all share
  +            the same thread pool.
  +            </p>
  +      </subsection>
  +      <subsection name="Deployment Facts">
  +        <table>
  +          <tr><td>Containment</td><td>Classic Framework 4.</td>
  +          </tr>
  +          <tr><td>Lifestyle</td><td>singleton</td></tr>
  +          <tr><td>Lifecycle</td>
  +            <td>
  +              <table>
  +                <tr><th>Stage</th><th>Description</th></tr>
  +                <tr><td>LogEnabled</td><td>Logs lifescycle stages and handles assignment
  +                 of logging channels to managed connection handlers.</td></tr>
  +                <tr>
  +                  <td>Serviceable</td>
  +                  <td>
  +                  The connection manager has a structural dependency on the 
  +                  <a href="threads.html">Threads</a>component.
  +                  </td>
  +                </tr>
  +                <tr>
  +                  <td>Disposable</td>
  +                  <td>
  +                  Disconnects all standing connections.
  +                  </td>
  +                </tr>
  +              </table>
  +            </td>
  +          </tr>
  +        </table>
  +      </subsection>
       </section>
  +
     </body>
   
   </document>
  +
   
   
  
  
  
  1.2       +77 -2     avalon-components/site/xdocs/components/datasource.xml
  
  Index: datasource.xml
  ===================================================================
  RCS file: /home/cvs/avalon-components/site/xdocs/components/datasource.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- datasource.xml	4 May 2003 12:19:49 -0000	1.1
  +++ datasource.xml	19 Jun 2003 17:42:59 -0000	1.2
  @@ -4,15 +4,90 @@
   
     <properties>
       <author email="mcconnell@apache.org">Stephen McConnell</author>
  -    <title>Cornerstone Datasource</title>
  +    <title>Cornerstone Connection</title>
     </properties>
   
     <body>
       <section name="Cornerstone Components - Datasource">
  -      <p><strong>PLACEHOLDER</strong></p>
  +      <subsection name="Description">
  +            <p>
  +            The ConnectionManager service provides a facility to listen 
  +            for incoming socket connections.
  +            The DefaultConnectionManager compoent gives a thread pooled 
  +            implementation of this service. If there are multiple server 
  +            components depending on this component, they would all share
  +            the same thread pool.
  +            </p>
  +      </subsection>
  +      <subsection name="Deployment Facts">
  +        <table>
  +          <tr><td>Containment</td><td>Classic Framework 4.</td>
  +          </tr>
  +          <tr><td>Lifestyle</td><td>singleton</td></tr>
  +          <tr><td>Lifecycle</td>
  +            <td>
  +              <table>
  +                <tr><th>Stage</th><th>Description</th></tr>
  +                <tr><td>LogEnabled</td><td>Logs lifescycle stages and handles assignment
  +                 of logging channels to managed connection handlers.</td></tr>
  +                <tr>
  +                  <td>Contextualizable</td>
  +                  <td>
  +                  <table>
  +                    <tr>
  +                      <th>Key</th><th>Type</th><th>Required</th>
  +                    </tr>
  +                    <tr>
  +                      <td>block.name</td><td>The component name.</td><td>false</td>
  +                    </tr>
  +                  </table>
  +                  </td>
  +                </tr>
  +                <tr>
  +                  <td>Configurable</td>
  +                  <td>
  +                  <p>Example configuration:</p>
  +                  <source>
  + &lt;configuration&gt;
  +   &lt;data-source name="<i>default</i>"
  +     class="<i>org.apache.avalon.excalibur.datasource.JdbcDataSource</i>"&gt;
  +     &lt;!-- configuration for JdbcDataSource --&gt;
  +     &lt;pool-controller min="<i>5</i>" max="<i>10</i>" 
  +       connection-class="<i>my.overrided.ConnectionClass</i>"&gt;
  +     &lt;keep-alive&gt;select 1&lt;/keep-alive&gt;
  +     &lt;/pool-controller&gt;
  +     &lt;driver&gt;<i>com.database.jdbc.JdbcDriver</i>&lt;/driver&gt;
  +     &lt;dburl&gt;<i>jdbc:driver://host/mydb</i>&lt;/dburl&gt;
  +     &lt;user&gt;<i>username</i>&lt;/user&gt;
  +     &lt;password&gt;<i>password</i>&lt;/password&gt;
  +   &lt;/data-source&gt;
  + &lt;/configuration&gt;
  +                  </source>
  +                  </td>
  +                </tr>
  +                <tr>
  +                  <td>Initializable</td>
  +                  <td>
  +                  Component initialization.
  +                  </td>
  +                </tr>
  +                <tr>
  +                  <td>Disposable</td>
  +                  <td>
  +                  Component disposal.
  +                  </td>
  +                </tr>
  +              </table>
  +            </td>
  +          </tr>
  +        </table>
  +      </subsection>
       </section>
  +
     </body>
   
   </document>
  +
  +
   
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org