RAT (Release Audit Tool) results

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

*****************************************************
Summary
-------
Notes: 3
Binaries: 3
Archives: 0
Standards: 77

Apache Licensed: 68
Generated Documents: 0

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

9 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
  AL    build.properties.sample
  AL    build.xml
  AL    checkstyle.xml
  AL    default.properties
 !????? doap_codec.rdf
  AL    LICENSE-header.txt
  N     LICENSE.txt
  AL    maven.xml
  N     NOTICE.txt
  AL    pom.xml
  AL    project.properties
  AL    project.xml
  AL    PROPOSAL.html
 !????? RELEASE-NOTES-1.0-dev.txt
 !????? RELEASE-NOTES-1.1.txt
 !????? RELEASE-NOTES-1.2.txt
 !????? RELEASE-NOTES-1.3.txt
  N     RELEASE-NOTES.txt
 !????? RELEASE-PLAN
  AL    src/assembly/bin.xml
  AL    src/assembly/src.xml
 !????? src/conf/MANIFEST.MF
  AL    src/java/org/apache/commons/codec/binary/Base64.java
  AL    src/java/org/apache/commons/codec/binary/BinaryCodec.java
  AL    src/java/org/apache/commons/codec/binary/Hex.java
  AL    src/java/org/apache/commons/codec/binary/package.html
  AL    src/java/org/apache/commons/codec/BinaryDecoder.java
  AL    src/java/org/apache/commons/codec/BinaryEncoder.java
  AL    src/java/org/apache/commons/codec/Decoder.java
  AL    src/java/org/apache/commons/codec/DecoderException.java
  AL    src/java/org/apache/commons/codec/digest/DigestUtils.java
  AL    src/java/org/apache/commons/codec/digest/package.html
  AL    src/java/org/apache/commons/codec/Encoder.java
  AL    src/java/org/apache/commons/codec/EncoderException.java
  AL    src/java/org/apache/commons/codec/language/DoubleMetaphone.java
  AL    src/java/org/apache/commons/codec/language/Metaphone.java
  AL    src/java/org/apache/commons/codec/language/package.html
  AL    src/java/org/apache/commons/codec/language/RefinedSoundex.java
  AL    src/java/org/apache/commons/codec/language/Soundex.java
  AL    src/java/org/apache/commons/codec/language/SoundexUtils.java
  AL    src/java/org/apache/commons/codec/net/BCodec.java
  AL    src/java/org/apache/commons/codec/net/CharacterEncodingNames.java
  AL    src/java/org/apache/commons/codec/net/package.html
  AL    src/java/org/apache/commons/codec/net/QCodec.java
  AL    src/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
  AL    src/java/org/apache/commons/codec/net/RFC1522Codec.java
  AL    src/java/org/apache/commons/codec/net/URLCodec.java
  AL    src/java/org/apache/commons/codec/overview.html
  AL    src/java/org/apache/commons/codec/package.html
  AL    src/java/org/apache/commons/codec/StringDecoder.java
  AL    src/java/org/apache/commons/codec/StringEncoder.java
  AL    src/java/org/apache/commons/codec/StringEncoderComparator.java
  B     src/media/logo.xcf
  B     src/site/resources/images/logo.png
  AL    src/site/site.xml
  AL    src/test/org/apache/commons/codec/binary/Base64Test.java
  AL    src/test/org/apache/commons/codec/binary/BinaryCodecTest.java
  AL    src/test/org/apache/commons/codec/binary/HexTest.java
  AL    src/test/org/apache/commons/codec/BinaryEncoderAbstractTest.java
  AL    src/test/org/apache/commons/codec/digest/DigestUtilsTest.java
  AL    src/test/org/apache/commons/codec/language/AllTests.java
  AL    src/test/org/apache/commons/codec/language/DoubleMetaphoneTest.java
  AL    src/test/org/apache/commons/codec/language/MetaphoneTest.java
  AL    src/test/org/apache/commons/codec/language/RefinedSoundexTest.java
  AL    src/test/org/apache/commons/codec/language/SoundexTest.java
  AL    src/test/org/apache/commons/codec/net/BCodecTest.java
  AL    src/test/org/apache/commons/codec/net/QCodecTest.java
  AL    src/test/org/apache/commons/codec/net/QuotedPrintableCodecTest.java
  AL    src/test/org/apache/commons/codec/net/RFC1522CodecTest.java
  AL    src/test/org/apache/commons/codec/net/URLCodecTest.java
  AL    src/test/org/apache/commons/codec/StringEncoderAbstractTest.java
  AL    src/test/org/apache/commons/codec/StringEncoderComparatorTest.java
 !????? TODO
  AL    xdocs/changes.xml
  AL    xdocs/cvs-usage.xml
  AL    xdocs/download_codec.xml
  B     xdocs/images/logo.png
  AL    xdocs/index.xml
  AL    xdocs/issue-tracking.xml
  AL    xdocs/navigation.xml
  AL    xdocs/proposal.xml
 !????? xdocs/style/project.css
  AL    xdocs/userguide.xml
 
 *****************************************************
 Printing headers for files without AL header...
 
 
 =======================================================================
 ==doap_codec.rdf
 =======================================================================
 <?xml version="1.0"?>
<rdf:RDF xmlns="http://usefulinc.com/ns/doap#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:asfext="http://projects.apache.org/ns/asfext#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:doap="http://usefulinc.com/ns/doap#" xml:lang="en">
  <Project rdf:about="http://commons.apache.org/codec/">
    <name>Apache Commons Codec</name>
    <homepage rdf:resource="http://commons.apache.org/codec/"/>
    <programming-language>Java</programming-language>
    <category rdf:resource="http://projects.apache.org/category/library"/>
    <license rdf:resource="http://usefulinc.com/doap/licenses/asl20"/>
    <bug-database rdf:resource="http://issues.apache.org/jira/browse/CODEC"/>
    <download-page rdf:resource="http://jakarta.apache.org/site/downloads/downloads_commons-codec.cgi"/>
    <asfext:pmc rdf:resource="http://commons.apache.org/"/>
    <shortdesc xml:lang="en">Simple encoders and decoders</shortdesc>
    <description xml:lang="en">
   The codec package contains simple encoder and decoders for
   various formats such as Base64 and Hexadecimal.  In addition to these
   widely used encoders and decoders, the codec package also maintains a
   collection of phonetic encoding utilities.
  </description>
    <repository>
      <SVNRepository>
        <browse rdf:resource="http://svn.apache.org/repos/asf/commons/proper/codec/trunk"/>
        <location rdf:resource="http://svn.apache.org/repos/asf/commons/proper/codec"/>
      </SVNRepository>
    </repository>
    <release>
      <revision>
        <name>commons-codec</name>
        <created>2004-07-10</created>
        <version>1.3</version>
      </revision>
    </release>
    <mailing-list rdf:resource="http://commons.apache.org/mail-lists.html"/>
  </Project>
</rdf:RDF>

 =======================================================================
 ==RELEASE-NOTES-1.0-dev.txt
 =======================================================================
 Please use ./xdocs/changes.xml instead of this file.

$Id: RELEASE-NOTES-1.0-dev.txt 155405 2005-02-26 12:53:42Z dirkv $

			Commons Codec Package
			   Version 1.0-dev
			    Release Notes


INTRODUCTION:

This document contains the release notes for this version of the Commons
Codec package, and highlights changes since the previous version.  The
current release adds new features and bug fixes, and is being done now to
follow the release early/release often mentality.


NEW FEATURES:

* Base64 class from commons-httpclient in org.apache.commons.codec.base64
* Soundex class from commons-util in org.apache.commons.codec
* Metaphone class from commons-util in org.apache.commons.codec
* SoundexComparator class from commons-util in org.apache.commons.codec


BUG FIXES:



 =======================================================================
 ==RELEASE-NOTES-1.1.txt
 =======================================================================
 Please use ./xdocs/changes.xml instead of this file.

$Id: RELEASE-NOTES-1.1.txt 155405 2005-02-26 12:53:42Z dirkv $

			Commons Codec Package
			     Version 1.1
			    Release Notes


INTRODUCTION:

This document contains the release notes for this version of the Commons
Codec package, and highlights changes since the previous version.  Version
1.1 is the first official release of Codec.  Numerous projects had been 
depending on Version 1.0-dev while Codec was in the Sandbox, and backwards
compatibility has been preserved to ease the transition to this official
release. 

NEW FEATURES:

* A newer version of the Base64 class reflecting improvements from
  both the commons-httpclient and xml-rpc versions of code forked
  from catalina.
* Base64 class from commons-httpclient in org.apache.commons.codec.base64
  has been retained for backwards compatibility but has been deprecated
* Soundex class from commons-util in org.apache.commons.codec
* Metaphone class from commons-util in org.apache.commons.codec
* RefinedSoundex class in org.apache.commons.codec
* Encoder/Decoder interfaces in org.apache.commons
* String and Binary specific Encoder/Decoder interfaces in 
  org.apache.commons
* StringEncoderComparator replaces the SoundexComparator from the
  language package.

BUG FIXES:

* Base64 now discards whitespace characters when decoding encoded
  content.

 =======================================================================
 ==RELEASE-NOTES-1.2.txt
 =======================================================================
 Please use ./xdocs/changes.xml instead of this file.

$Id: RELEASE-NOTES-1.2.txt 155405 2005-02-26 12:53:42Z dirkv $

			Commons Codec Package
			    Version 1.2
			    Release Notes


INTRODUCTION:

This document contains the release notes for this version of the Commons
Codec package, and highlights changes since the previous version.  Version
1.2 contains bug fixes for the 1.1 release.

NEW FEATURES:

* URLCodec - Implements the 'www-form-urlencoded' encoding scheme

* DigestUtils - Simple utility class that provides static convenience
  methods for calculating md5 and hex digests.


BUG FIXES:

* Fix for Bug 19860: Modified Base64 to remedy non-compliance with RFC
  2045.  Non-Base64 characters were not being discarded during the
  decode.  RFC 2045 explicitly states that all characters outside of the
  base64 alphabet are to be ignored.  

* Fix for Bug 24360: Hex.decode(Object) throws a ClassCastException 
  when a String argument is passed in.
  
* Fix for Bug 24471: Soundex: The HW rule is not applied; hyphens and 
  apostrophes are not ignored.
  
* Fix for Bug 24484: Soundex.setMaxLength causes bugs and is not needed.
  Calling Soundex.setMaxLength() with a value of 2 or less causes the wrong
  answer to be returned.  Since the encoding returned by Soundex is always
  of length 4 by definition (we do not use the '-' in as a letter-nnn 
  separator) the need for a maxLength attribute is not needed.  Deprecate 
  the field and accessor methods.

* Fix in Metaphone relating to the handling of the maximum code length.

 =======================================================================
 ==RELEASE-NOTES-1.3.txt
 =======================================================================
 The commons-codec team is pleased to announce the Codec 1.3 release! 

http://commons.apache.org/codec/

The codec package contains simple encoder and decoders for various formats 
such as Base64 and Hexadecimal. In addition to these widely used encoders and 
decoders, the codec package also maintains a collection of phonetic encoding 
utilities. 

Changes in this version include:

  New Features:

o BinaryCodec: Encodes and decodes binary to and from Strings of 0s and 1s. 
  Issue: 27813. Thanks to Alex Karasulu. 
o QuotedPrintableCodec: Codec for RFC 1521 MIME (Multipurpose Internet Mail 
  Extensions) Part One. Rules #3, #4, and #5 of the quoted-printable spec are 
  not implemented yet. See also issue 27789. Issue: 26617. Thanks to Oleg 
  Kalnichevski. 
o BCodec: Identical to the Base64 encoding defined by RFC 1521 and allows a 
  character set to be specified. Issue: 26617. Thanks to Oleg Kalnichevski. 
o QCodec: Similar to the Quoted-Printable content-transfer-encoding defined 
  in RFC 1521 and designed to allow text containing mostly ASCII characters 
  to be decipherable on an ASCII terminal without decoding. Issue: 26617. 
  Thanks to Oleg Kalnichevski. 
o Soundex: Implemented the DIFFERENCE algorithm. Issue: 25243. Thanks to 
  Matthew Inger. 
o RefinedSoundex: Implemented the DIFFERENCE algorithm. Issue: 25243. Thanks 
  to Matthew Inger. 

  Fixed bugs:

o The default URL encoding logic was broken. Issue: 25995. Thanks to Oleg 
  Kalnichevski. 
o Base64 chunked encoding not compliant with RFC 2045 section 2.1 CRLF. 
  Issue: 27781. Thanks to Gary D. Gregory. 
o Hex converts illegal characters to 255. Issue: 28455. 
o Metaphone now correctly handles a silent B in a word that ends in MB. 
  "COMB" is encoded as "KM", before this fix "COMB" was encoded as "KMB". 
  Issue: 28457. 
o Added missing tags in Javadoc comments. 
o General Javadoc improvements. 

  Changes:

o This version is relesed under the Apache License 2.0 , please see 
  LICENSE.txt. Previous versions were released under the Apache License 1.1. 
o The Board recommendation to remove Javadoc author tags has been 
  implemented. All author tags are now "Apache Software Foundation".  


 =======================================================================
 ==RELEASE-PLAN
 =======================================================================
 $Id: RELEASE-PLAN 155405 2005-02-26 12:53:42Z dirkv $

Jakarta Commons Codec  

This document outline the current goals for the next release(s).  
This document defines objectives and action items that should
be met before the next release.  

*** Codec 1.1

	Status: Codec 1.1 released.

*** Codec 1.1.1 Maintenance Release Plan

Objective: 

   The main objective of 1.1.1 release is to fix any bugs identified
   in the 1.1 release of codec.

Changes Made since 1.1:

   - Fix for Bug 19860 - Base64 is not RFC 2045 compliant because it was
     ONLY discarding whitespace.  The RFC requires that all non-base64
     characters be ignored, and Base64 was changed to reflect this.

Changes to be made before release:

   - Still waiting for more bug reports

	Status: Codec 1.1.1 not released.

*** Codec 1.2 Release Candidate

Objective: 

   Identify as *existing* (or set of *existing*) stream Base64 implementation,
   and either integrate or emulate this code.  The community is currently
   in the process of selecting a primary candidate.
   
	Status: Codec 1.2 released.

*** Codec 1.3 Release Plan

   - Fix bugs. 
   - Improve Javadocs.
   - Add DIFFERENCE implementation in language package.

	Status:  Items above done.

*** Codec 2.0 Release Plan

 =======================================================================
 ==src/conf/MANIFEST.MF
 =======================================================================
 Extension-Name: org.apache.commons.codec
Specification-Title: Jakarta Commons Codec
Specification-Vendor: Apache Software Foundation
Specification-Version: 1.3
Implementation-Title: org.apache.commons.codec
Implementation-Vendor: Apache Software Foundation
Implementation-Version: 1.3

 =======================================================================
 ==TODO
 =======================================================================
 $Id: TODO 155405 2005-02-26 12:53:42Z dirkv $

This is a list of action items to be finished in the [codec] project.  
This TODO list reflects the current direction of development, and
should be updated by all committers when a known issues or task
is identified.  

When a task in the TODO list is done, change the changes.xml document in xdocs

** TODO List

* Add a ship encode and decode to binary package

* Add a btoa encode and decode to binary package

* Add a uu encode and decode to binary package

* Add a Rot13 implementation to text package 

* figure out a better way to supply test data and expected input/output
  to the JUNIT test cases

* develop multiple distributions for projects that only wish to use 
  a specific class, and are worried about footprint (memory and diskspace).





 =======================================================================
 ==xdocs/style/project.css
 =======================================================================
 @import url("http://commons.apache.org/style/commons-maven.css");