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 2002/03/03 17:44:24 UTC

cvs commit: jakarta-avalon-apps/enterprise/tools/src/java/org/apache/avalon/excalibur/service package.html

mcconnell    02/03/03 08:44:24

  Modified:    enterprise/tools/src/java/org/apache/avalon/excalibur/service
                        package.html
  Added:       enterprise/tools .cvsignore build.xml
  Log:
  no message
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-apps/enterprise/tools/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  build
  local.properties
  dist
  
  
  
  1.1                  jakarta-avalon-apps/enterprise/tools/build.xml
  
  Index: build.xml
  ===================================================================
  
  <!-- 
  PSS Service.
  Copyright 2001-2002 OSM SARL, All Rights Reserved.
  -->
  
  <project name="tools" default="help" basedir=".">
  
    <property file="local.properties"/>
    <property file="build.properties"/>
  
    <target name="help" >
      <echo>
  
        Description
        -----------
  
        Enterprise suite tools.
  
        General Targets:
        ----------------
  
        build            - invokes the general build target
        javadoc          - javadoc API generation
        dist             - executes build, javadoc and support file creation
        clean            - destroy the build directory
        install          - upgrade merlin.jar in lib
        
      </echo>
    </target>
  
    <property name="MAJOR" value="1"/>
    <property name="MINOR" value="0"/>
    <property name="MICRO" value="1"/>
    <property name="VERSION" value="${MAJOR}.${MINOR}.${MICRO}"/>
  
    <property name="enterprise" value=".." />
    <property name="tools.path" value="${enterprise}/tools" />
    <property name="tools.lib.path" value="${tools.path}/lib" />
  
    <property name="merlin.jar" value="merlin.jar"/>
  
    <property name="lib" value="lib" />
    <property name="src" value="src" />
    <property name="etc" value="${src}/etc" />
    <property name="build"  value="build" />
    <property name="dist"  value="dist" />
  
    <property name="javadoc.root.path"  value="${dist}/javadoc" />
    <property name="avalon.href"  value="http://jakarta.apache.org/avalon/api/" />
    <property name="jdk.href"  value="http://java.sun.com/j2se/1.4/docs/api/" />
    <property name="overview.html" value="${tools.path}/etc/overview.html" />
  
    <!-- demo configuration -->
    
    <property name="demo.verbose"  value="false" />
    <property name="demo.priority"  value="debug" />
     
    <!-- classpath -->
  
    <path id="project.classpath">
        <fileset dir="${tools.lib.path}">
          <include name="*.jar" />
        </fileset>
    </path>
  
    <!-- MAIN TARGETS -->
  
    <target name="all" depends="clean,dist,examples"/>
    <target name="build" depends="merlin"/>
    <target name="dist" depends="build,javadoc,support"/>
  
    <target name="install.context">
      <available file="${tools.lib.path}" type="dir" property="install.path.present"/>
    </target>
    
    <target name="install" depends="install.context,build" if="install.path.present">
      <copy todir="${tools.lib.path}">
        <fileset dir="${dist}">
          <include name="${merlin.jar}"/>
        </fileset>
      </copy>
    </target>
  
    <target name="clean">
       <delete dir="${build}"/>
       <delete dir="${dist}"/>
    </target>
  
    <!-- PREPARE -->
  
    <target name="prepare"  >
      <mkdir dir="${build}" />
      <mkdir dir="${build}/src" />
      <mkdir dir="${build}/lib" />
      <mkdir dir="${dist}" />
    </target>
  
    <!-- MERLIN TOOL -->
  
    <target name="merlin.context" depends="prepare">
      <mkdir dir="dist"/>
      <uptodate property="merlin.uptodate" targetfile="${dist}/${merlin.jar}">
        <srcfiles dir="${src}/java">
           <include name="org/apache/**/*.*"/>
        </srcfiles>
        <srcfiles dir="${etc}">
           <include name="loader.mf"/>
        </srcfiles>
      </uptodate>
    </target>
  
    <target name="merlin" depends="merlin.context" unless="merlin.uptodate" >
        <echo message="Building merlin Processor."/>
        <javac debug="off" destdir="${build}/lib" deprecation="true" target="1.2">
          <classpath>
  	    <path refid="project.classpath" />
  	  </classpath>
          <src path="${src}/java" />
          <include name="org/apache/avalon/phoenix/**"/>
          <include name="org/apache/avalon/excalibur/**"/>
        </javac>
        <copy todir="${build}/lib">
          <fileset dir="${src}/java">
            <include name="org/apache/avalon/excalibur/**/*.xinfo"/>
            <include name="org/apache/avalon/excalibur/**/*.xml"/>
          </fileset>
        </copy>
        <jar jarfile="${dist}/${merlin.jar}" basedir="${build}/lib" manifest="${etc}/loader.mf" />
    </target>
  
    <target name="examples" depends="merlin">
        <mkdir dir="${build}/demo"/>
        <javac debug="off" destdir="${build}/demo" deprecation="true" target="1.2">
          <classpath>
  	    <path refid="project.classpath" />
            <pathelement location="${dist}/${merlin.jar}"/>
  	  </classpath>
          <src path="${src}/java" />
          <include name="org/apache/demo/**"/>
        </javac>
        <copy todir="${build}/demo">
          <fileset dir="${src}/java">
            <include name="org/apache/demo/**/*.xinfo"/>
            <include name="org/apache/demo/**/*.xml"/>
          </fileset>
        </copy>
        <jar jarfile="${dist}/examples.jar" basedir="${build}/demo" manifest="${etc}/demo.mf" />
    </target>
  
  
    <!-- UTILITY TARGETS -->
  
    <target name="support">
      <copy todir="${dist}">
         <fileset dir="${etc}">
           <include name="LICENSE.TXT"/>
           <include name="README.TXT"/>
         </fileset>
      </copy>
    </target>
  
    <target name="javadoc" depends="prepare" >
      <mkdir dir="${javadoc.root.path}" />
      <copy todir="${javadoc.root.path}/">
         <fileset dir="${etc}">
           <include name="LICENSE.HTML"/>
           <include name="license.css"/>
         </fileset>
      </copy>
      <javadoc destdir="${javadoc.root.path}" 
  	doctitle="&lt;h1&gt;Enterprise Suite Tools Package&lt;/h1&gt;" 
        noindex="false" author="false" 
        use="true"
        overview="${overview.html}"
  	windowtitle="Enterprise Tools" 
        bottom="&lt;a href='{@docRoot}/LICENSE.HTML'/&gt;License, Disclaimer and due credits.&lt;/a&gt;"
        additionalparam="-breakiterator -J-Xmx128m"
        packagenames="org.*" 
        excludepackagenames="org.apache.avalon.phoenix.*,org.apache.avalon.excalibur.service.ant,org.apache.demo"
        >
          <sourcepath path="${src}/java"/>
          <classpath>
  	    <path refid="project.classpath" />
            <pathelement path="${dist}/${merlin.jar}" />
  	  </classpath>
  	  <link href="${jdk.href}" />
  	  <link href="${avalon.href}" />
      </javadoc>
    </target>
  
    <target name="loader.context">
      <available property="merlin.available" file="${dist}/${merlin.jar}"/>
    </target>
  
    <target name="loader.defintion" depends="loader.context" if="merlin.available">
      <taskdef name="load" classname="org.apache.avalon.excalibur.service.ant.Load">
        <classpath>
          <pathelement location="${dist}/${merlin.jar}"/>
          <pathelement location="${tools.lib.path}/avalon-framework.jar"/>
          <pathelement location="${tools.lib.path}/logkit.jar"/>
        </classpath>
      </taskdef>
    </target>
   
    <target name="demo" depends="loader.defintion,examples" if="merlin.available">
  
      <load target="org.apache.demo.ReferralBlock" priority="${demo.priority}" 
        disposal="false" verbose="${demo.verbose}">
  
        <classpath>
           <fileset dir="${dist}">
               <include name="merlin.jar"/>
           </fileset>
           <fileset dir="${lib}">
               <include name="avalon-framework.jar"/>
               <include name="logkit.jar"/>
           </fileset>
        </classpath>
  
        <!--
        For all of the jar files in the fileset, load the jar file
        into the classloader. 
        -->
  
        <fileset dir="${dist}">
           <include name="examples.jar"/>
        </fileset>
  
      </load>
  
    </target>
  
  </project>
  
  
  
  1.2       +33 -6     jakarta-avalon-apps/enterprise/tools/src/java/org/apache/avalon/excalibur/service/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-apps/enterprise/tools/src/java/org/apache/avalon/excalibur/service/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	3 Mar 2002 15:45:58 -0000	1.1
  +++ package.html	3 Mar 2002 16:44:24 -0000	1.2
  @@ -6,15 +6,42 @@
   <tr><td width="20%"><b>Feature</b></td>
   <td><b>Description</b></td></tr>
   
  -<tr><td width="20%" valign="top">Service Composition</td>
  +<tr><td valign="top">Service Composition</td>
   <td>Handles automated composition of services based on declared component dependencies.</td></tr>
  -<tr><td>Default Configurations</td>
  +<tr><td valign="top">Default Configurations</td>
   <td>Provides support for configuration using component default configurations together
   with supplied configuration information using the CascadingConfiguration model.</td></tr>
  -<tr><td>Mixed execution modes</td>
  +<tr><td valign="top">Mixed execution modes</td>
   <td>Supports execution from the command line (main method), as a jar file, as an Ant task,
  -and as an embedded component.</td></tr>
  +and as an embedded component.
  +    <p><strong>java -jar form</strong></p>
  +    <p>Execution using java -jar pattern requires the presence 
  +    of the following files under the same directory:</p>
  +           <ul>
  +             <li><code>merlin.jar</code>
  +             <li><code>avalon-framework.jar</code>
  +            <li><code>logkit.jar</code>
  +           </ul>
  +      <p>An example command line is shown below:</p>
  +       <pre>
  +     $ java -jar <strong>merlin.jar</strong> &lt;supporting-jar-files&gt; 
  +         -target &lt;class-name&gt; 
  +       </pre>
  +       <p><strong>java -classpath form</strong></p>
  +       <p>Execution using java -classpath pattern requires the inclusions 
  +       of the pipeline, framework and logkit jar files in the classpath 
  +       statement.</p>
  +       <p>An example command line is shown below:</p>
  +       <pre>
  +     $ java -classpath <strong>merlin.jar;avalon-framework.jar;logkit.jar</strong> 
  +         org.apache.avalon.excalibur.service.ServiceLoader
  +          &lt;supporting-jar-files&gt; -target &lt;class-name&gt; 
  +       </pre>
  +     </ul>
  +
  +</td></tr>
   </table>
  +     
   
   <h3>Component Creation</h3>
   
  @@ -46,8 +73,8 @@
   
   <p>For each component declared in a manifest, the implementation establishes the available services
   and dependencies based on information contained in an <code>.xinfo</code> file.  Given a component
  -implementation class <strong><code>org/apache/DirectoryBlock.class</code></strong> the <code>Pipeline</code> processor
  -will attempt to locate a <strong><code>org/apache/DirectoryBlock.xinfo</code></strong> resource in the jar file.</P>
  +implementation class <strong><code>org/apache/DirectoryBlock.class</code></strong> the <code>Pipeline</code> processor will attempt to locate a <strong><code>org/apache/DirectoryBlock.xinfo</code></strong> 
  +resource in the jar file.</P>
   
   <pre>
     &lt;?xml version="1.0"?&gt;
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>