RAT (Release Audit Tool) results

The following document contains the results of RAT (Release Audit Tool).

*****************************************************
Summary
-------
Notes: 2
Binaries: 4
Archives: 0
Standards: 16

Apache Licensed: 9
Generated Documents: 0

JavaDocs are generated and so license header is optional
Generated files do not required license headers

7 Unknown Licenses

*******************************

Archives (+ indicates readable, $ unreadable): 

 
*****************************************************
  Files with AL headers will be marked L
  Binary files (which do not require AL headers) will be marked B
  Compressed archives will be marked A
  Notices, licenses etc will be marked N
 !????? checkstyle.xml
  N     LICENSE.txt
  N     NOTICE.txt
  AL    pom.xml
 !????? project.properties
 !????? project.xml
  AL    src/java/org/apache/commons/threadpool/CommonsLoggingThreadPoolMonitor.java
  AL    src/java/org/apache/commons/threadpool/DefaultThreadPool.java
  AL    src/java/org/apache/commons/threadpool/MTQueue.java
  AL    src/java/org/apache/commons/threadpool/NullThreadPoolMonitor.java
 !????? src/java/org/apache/commons/threadpool/package.html
  AL    src/java/org/apache/commons/threadpool/ThreadPool.java
  AL    src/java/org/apache/commons/threadpool/ThreadPoolMonitor.java
  B     src/site/resources/images/threadpool-logo-white.png
  B     src/site/resources/images/threadpool-logo-white.xcf
  AL    src/site/site.xml
  AL    src/test/org/apache/commons/threadpool/TestThreadPool.java
 !????? xdocs/downloads.xml
  B     xdocs/images/threadpool-logo-white.png
  B     xdocs/images/threadpool-logo-white.xcf
 !????? xdocs/index.xml
 !????? xdocs/navigation.xml
 
 *****************************************************
 Printing headers for files without AL header...
 
 
 =======================================================================
 ==checkstyle.xml
 =======================================================================
 <?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">

<!--
  Checkstyle checks configured for Maven.
-->

<module name="Checker">

    <!-- Checks that a package.html file exists for each package.     -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
    <module name="PackageHtml"/>

    <!-- Checks whether files end with a new line.                        -->
    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
    <module name="NewlineAtEndOfFile"/>

    <!-- Checks that property files contain the same keys.         -->
    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
    <module name="Translation"/>

    <module name="TreeWalker">

        <property name="cacheFile" value="${checkstyle.cache.file}"/>

        <!-- ************************************************************** -->
        <!-- Checks that are different from the sun coding conventions ones -->
        <!-- ************************************************************** -->
        <module name="Header">
            <property name="headerFile" value="${basedir}/LICENSE.txt"/>
            <property name="ignoreLines" value="2,3,4,10"/>
        </module>
        <property name="tabWidth" value="4"/>
        <module name="LeftCurly">
          <property name="option" value="eol"/>
        </module>
        <module name="RightCurly">
          <property name="option" value="alone"/>
        </module>
        <module name="LineLength">
          <property name="max" value="132"/>
        </module>
        <module name="MethodLength">
          <property name="max" value="175"/>
        </module>
        <!-- No Paren pad check
        <module name="ParenPad"/>
        -->

 =======================================================================
 ==project.properties
 =======================================================================
 maven.checkstyle.properties = checkstyle.xml

# uncomment the next line to work in offline mode (no jar download & no linkcheck)
#maven.mode.online=
maven.changelog.factory=org.apache.maven.svnlib.SvnChangeLogFactory

maven.javadoc.author=false
maven.javadoc.links=http://java.sun.com/products/jdk/1.4/docs/api

maven.xdoc.jsl=../commons-build/commons-site.jsl
maven.xdoc.date=bottom
maven.xdoc.poweredby.image=maven-feather.png
maven.xdoc.version=${pom.currentVersion}
maven.xdoc.developmentProcessUrl=http://commons.apache.org/charter.html
maven.xdoc.includeProjectDocumentation=yes

maven.compile.debug=on
maven.compile.deprecation=off
maven.compile.optimize=off

maven.jarResources.basedir=src/java
maven.jar.excludes=**/package.html
maven.junit.fork=true
maven.junit.sysproperties=org.xml.sax.driver
org.xml.sax.driver=org.apache.xerces.parsers.SAXParser

clover.excludes=**/Test*.java

 =======================================================================
 ==project.xml
 =======================================================================
 <?xml version="1.0"?>
<project>
  <extend>../commons-build/sandbox-project.xml</extend>
  <name>Commons Threadpool</name>
  <id>commons-threadpool</id>
  <logo>/images/threadpool-logo-white.png</logo>
  <url>http://commons.apache.org/sandbox/threadpool/</url>
  <inceptionYear>2002</inceptionYear>
  <shortDescription>Commons Threadpool</shortDescription>
  <description>Commons Threadpool</description>

  <currentVersion>1.0-dev</currentVersion>
  <versions>
  </versions>
  <branches>
  </branches>

  <developers>
    <developer>
      <name>James Strachan</name>
      <id>jstrachan</id>
      <email>jstrachan@apache.org</email>
      <organization>SpiritSoft, Inc.</organization>
    </developer>
  </developers>



  <dependencies>
    <dependency>
      <id>commons-logging</id>
      <version>1.0.1</version>
    </dependency>
  </dependencies>
	
</project>


 =======================================================================
 ==src/java/org/apache/commons/threadpool/package.html
 =======================================================================
 <html>
<head>
</head>
<body>

  <p>
		The Core API of Commons ThreadPool which revolves around a simple {@link ThreadPool} interface.
		In addition the {@link MTQueue} can be useful for low level inter-thread communication.
  </p>

</body>
</html>

 =======================================================================
 ==xdocs/downloads.xml
 =======================================================================
 <?xml version="1.0"?>
<document>
   <properties>
      <title>Downloads</title>
      <author email="dev@commons.apache.org">Commons Documentation Team</author>
      <revision>$Id: downloads.xml 561366 2007-07-31 15:58:29Z rahul $</revision>
   </properties>

   <body>
      <section name="Releases">
         <p>There are no releases available.</p>

<!--
         <p>The following releases are available:</p>
         <ul>
           <li>Version 1.1 - 20 October 2003</li>
           <li>Version 1.0 - 12 August 2002</li>
         </ul>
         <br/>
         <p>
            The latest binary release is always available on the 
            <a href="http://jakarta.apache.org/site/binindex.cgi#commons-threadpool">
            Jakarta Binary Downloads page</a>,
            its source is available from 
            <a href="http://jakarta.apache.org/site/sourceindex.cgi#commons-threadpool">
            Jakarta Source Downloads page</a>.
         </p>
         <p>
            Older releases are retained by the Apache Software Foundation but are 
            moved into a
            <a href="http://archive.apache.org/dist/jakarta/commons/threadpool/">
            special archive area</a>.
         </p>
         <p>
           <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-threadpool/">
           Nightly source and binary drops</a> are also available.
         </p>
-->
         <p>
            Access to the source tree to see the latest and greatest code is possible
            through <a href="cvs-usage.html">anonymous SVN access</a>.
         </p>
      </section>

<!--
      <section name="Release Candidate">
         <p>
            Release candidates for the upcoming 1.1 release can be downloaded 
            <a href="http://cvs.apache.org/~dirkv/builds/">here</a>.
         </p>

 =======================================================================
 ==xdocs/index.xml
 =======================================================================
 <?xml version="1.0"?>

<document>

 <properties>
  <title>Overview</title>
  <author email="dev@commons.apache.org">Commons Documentation Team</author>
 </properties>

 <body>

<section name="The ThreadPool Component">
      <p>
        Commons ThreadPool is a component for working with pools of threads and asynchronously executing
        tasks.
      </p>
      <p>
        Often inside application servers and containers the threading model is managed for you.
        However in some circumstances it can be useful to use your own worker thread pools to dispatch
        asynchronous work into. 
      </p>
      <p>
      	In enterprise class systems typically JMS is used to perform some task asynchronously by another machine.
        However ThreadPools can be a simple and effective mechanism for asynchronous processing within the same process. 
        This can be particularly useful for performing asynchronous processing in
        Servlet engines or Swing applications.
      </p>
      <p>
        Please note that one of the reasons this component is still in the sandbox and has
        never had a 1.0 release is Doug Lea's excellent
        <a href="http://gee.cs.oswego.edu/dl">util.concurrent library</a>.  That library 
        works with many JDKs, is full-featured, well-documented, and well-tested.  That
        library is also a standard part of the JDK starting with JDK 1.5, as the
        java.util.concurrent library: it is specified in the
        <a href="http://www.jcp.org/en/jsr/detail?id=166">JSR 166 standard.</a>
        <br />
        All of this is not to say commons-sandbox-threadpool is useless.  As with most
        Apache products, the development and release of this component is driven by
        user requests and developer interest.
      </p>
</section>

<section name="Releases">
    <p>
       See the <a href="downloads.html">downloads</a> page for information on obtaining releases.
    </p>
</section>

<section name="Documentation">
  <p>

 =======================================================================
 ==xdocs/navigation.xml
 =======================================================================
 <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE org.apache.commons.menus SYSTEM '../../commons-build/menus/menus.dtd'>
<project name="Commons&#xA0;Threadpool">
    <title>Commons&#xA0;Threadpool</title>
    <body>
        <menu name="Commons&#xA0;Threadpool">
            <item name="Overview"                      href="/index.html" />
            <item name="API&#xA0;Documentation"        href="/apidocs/index.html"/>
            <item name="Downloads"                     href="/downloads.html"/>
        </menu>
        &common-menus;
    </body>
</project>