cvs commit: jakarta-avalon-excalibur/meta/src/xdocs service.xml

Sun, 22 Sep 2002 00:31:46 -0700 

mcconnell    2002/09/22 00:56:38

  Added:       meta/src/xdocs service.xml
  Log:
  Documentation on the ServiceDefintion class, example code, UML and XML descriptions.
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-excalibur/meta/src/xdocs/service.xml
  
  Index: service.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <header>
      <title>Service Definition</title>
      <authors>
        <person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
      </authors>
    </header>
  
  <body>
  
  <s1 title="Introduction">
  
  <p>
  The org.apache.excalibur.meta.info.ServiceDefinition class describes a type of 
service. It suppliments the classic Java interface with a version identifier and 
attributes.  A ServiceDefintion may be referenced by multiple components that will 
typically suppliment the defintion in terms of additional  attributes.  References to 
a ServiceDefintion concern a component type declaration of depedencies, service access 
points, lifestyle extension ability, and lifestyle extension depedencies.</p>
  
  <img src="images/ServiceDefinition.gif" />
  
  <p>An instance of ServiceDescriptor is created using a ServiceBuilder.  The 
following code fragment shows the creation of new ServiceBuilder and the creation of a 
ServiceDefinition using the builder.</p>
  <source>
    //
    // create the builder
    //
  
    ServiceBuilder builder = new ServiceBuilder();
    builder.enableLogging( m_loger );
  
    //
    // create the service defintion
    //
  
    ServiceDefinition defintion = builder.build( this.class() );
  </source>
  
  <s2 title="XML Schema">
  
  <source>
  
    <font color="gray"><i>&lt;!--
    Example of a service defintion.
    --&gt;</i></font>
  
    &lt;service&gt;
  
      <font color="gray"><i>&lt;!--
      Declaration of a service version.
      --&gt;</i></font>
  
      &lt;version&gt;3.2&lt;/version&gt;
      
      &lt;attributes&gt;
  
        <font color="gray"><i>&lt;!--
        Attribute declarations included in a service defintion
        are independent of a particular service implementation.
        --&gt;</i></font>
  
        &lt;attribute key="<font color="darkred">a-key</font>" value="<font 
color="darkred">a-value</font>"/&gt;
  
      &lt;/attributes&gt;
  
    &lt;/service&gt;
  
  </source>
  
        </s2>
  
      </s1>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2002/09/22 07:56:38 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to