tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject cvs commit: jakarta-tomcat-4.0/webapps/tomcat-docs/config resources.xml project.xml
Date Wed, 30 Jan 2002 00:55:27 GMT
remm        02/01/29 16:55:27

  Modified:    webapps/tomcat-docs/config project.xml
  Added:       webapps/tomcat-docs/config resources.xml
  Log:
  - Document the JNDI based Resources component, which is used to abstract
    access to the webapp files.
  - Fix bug 5752.
  
  Revision  Changes    Path
  1.8       +1 -0      jakarta-tomcat-4.0/webapps/tomcat-docs/config/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/project.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- project.xml	25 Jan 2002 15:21:34 -0000	1.7
  +++ project.xml	30 Jan 2002 00:55:27 -0000	1.8
  @@ -41,6 +41,7 @@
           <item name="Logger"                href="logger.html"/>
           <item name="Manager"               href="manager.html"/> 
           <item name="Realm"                 href="realm.html"/>
  +        <item name="Resources"             href="resources.html"/>
           <item name="Valve"                 href="valve.html"/>
       </menu>
   
  
  
  
  1.1                  jakarta-tomcat-4.0/webapps/tomcat-docs/config/resources.xml
  
  Index: resources.xml
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE document [
    <!ENTITY project SYSTEM "project.xml">
  ]>
  <document>
  
    &project;
  
    <properties>
      <author email="remm@apache.org">Remy Maucherat</author>
      <title>The Resources Component</title>
    </properties>
  
  <body>
  
  
  <section name="Introduction">
  
    <p>The <strong>Resources</strong> element represents the <em>web
    application static resources</em>, from which classes will be loaded, 
    HTML, JSP and the other static files will be served. This allows the webapp
    to reside on various mediums other than the filesystem, like compressed
    in a WAR file, in a JDBC database, or in a more advanced versioning
    repository.</p>
  
    <p>A unified caching engine is provided for all accesses to the webapp
    resources made by the servlet container and web applications which use the
    container provided mechanisms to access such resources, such as class laoder
    access, access through the <code>ServletContext</code> interface, or native
    access through the <code>DirectoryContext</code> interface.</p>
  
    <p><strong>Note: Running a webapp with non-filesystem based 
    Resources implementations is only possible when the webapp does not 
    rely on direct filesystem access to its own resources, and uses the methods
    in the ServletContext interface to access them.</strong></p>
  
    <p>A Resources element MAY be nested inside a 
    <a href="context.html">Context</a> component.  If it is not included, 
    a default filesystem based Resources will be created automatically, 
    which is sufficient for most requirements.</p>
  
  </section>
  
  
  <section name="Attributes">
  
    <subsection name="Common Attributes">
  
      <p>All implementations of <strong>Resources</strong>
      support the following attributes:</p>
  
      <attributes>
  
        <attribute name="className" required="false">
          <p>Java class name of the implementation to use.  This class must
          implement the <code>javax.naming.directory.DirContext</code> interface.
          It is recommended for optimal functionality and performance, 
          but not mandatory, that the class extend 
          <code>org.apache.naming.resources.BaseDirContext</code>, as well as
          use the special object types provided in the 
          <code>org.apache.naming.resources</code> for returned objects.
          If not specified, the standard value (defined below) will be used.</p>
        </attribute>
  
      </attributes>
  
    </subsection>
  
  
    <subsection name="Standard Implementation">
  
      <p>The standard implementation of <strong>Resources</strong> is
      <strong>org.apache.naming.resources.FileDirContext</strong>.
      It supports the following additional attributes (in addition to the
      common attributes listed above):</p>
  
      <attributes>
  
        <attribute name="cached" required="false">
          <p>This boolean flag indicates if the resources should be cached. It
          defaults to <code>true</code>.</p>
        </attribute>
  
        <attribute name="caseSensitive" required="false">
          <p>This boolean flag toggles case sensitivity for resourceson 
          the Windows platform. Defaults to <code>true</code>.</p>
        </attribute>
  
        <attribute name="docBase" required="false">
          <p>This is the functional equivalent to the <em>Document Base</em>

          of a <a href="context.html">Context</a>.</p>
        </attribute>
  
      </attributes>
  
    </subsection>
  
  
  </section>
  
  
  <section name="Nested Components">
  
    <p>No components may be nested inside a <strong>Resources</strong> element.</p>
  
  </section>
  
  
  <section name="Special Features">
  
    <p>No special features are associated with a <strong>Resources</strong>
    element.</p>
  
  </section>
  
  
  </body>
  
  
  </document>
  
  
  

--
To unsubscribe, e-mail:   <mailto:tomcat-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:tomcat-dev-help@jakarta.apache.org>


Mime
View raw message