|
| 1 | +<?xml version="1.0"?> |
| 2 | + |
| 3 | +<document> |
| 4 | + <properties> |
| 5 | + <title>Jakarta Commons-Codec: Proposal</title> |
| 6 | + </properties> |
| 7 | + |
| 8 | + <body> |
| 9 | + |
| 10 | + <section name="Proposal for Codec Package"><br/> |
| 11 | + <h4>January 24, 2002</h4> |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<subsection name="(0) Rationale"> |
| 16 | + <p> |
| 17 | + Many software projects have a need to use various formats of data, |
| 18 | + and to be able to switch between various formats. The codec package |
| 19 | + seeks to encapsulate some of the most popular encode/decode |
| 20 | + algorithms in one easy to use, well tested package. A base64 codec |
| 21 | + is the first candidate, with others to follow soon. |
| 22 | + </p> |
| 23 | + |
| 24 | + </subsection> |
| 25 | +<subsection name="(1) Scope of the Package"> |
| 26 | + <p> |
| 27 | + This proposal is to create a package of Java utility classes for the |
| 28 | + encoding/decoding of various types of data. A base64 codec will be the |
| 29 | + first implementation. |
| 30 | + </p> |
| 31 | + |
| 32 | + </subsection> |
| 33 | +<subsection name="(1.5) Interaction With Other Packages"> |
| 34 | + |
| 35 | + <p> |
| 36 | + <em>Codec</em> relies only on standard JDK 1.2 (or later) APIs for |
| 37 | + production deployment. It utilizes the JUnit unit testing framework for |
| 38 | + developing and executing unit tests, but this is of interest only to |
| 39 | + developers of the component. Codec will be a dependency for |
| 40 | + several existing components in the open source world. |
| 41 | + </p> |
| 42 | + |
| 43 | + <p>No external configuration files are utilized.</p> |
| 44 | + |
| 45 | + </subsection> |
| 46 | +<subsection name="(2) Initial Source of the Package"> |
| 47 | + |
| 48 | + <p> |
| 49 | + The original Java classes (<code>Base64</code>, etc.) are splashed around |
| 50 | + various Apache subprojects. We intend to seek them out and integrate them. |
| 51 | + </p> |
| 52 | + |
| 53 | + <p> |
| 54 | + The proposed package name for the new component is |
| 55 | + <code>org.apache.commons.codec</code>. |
| 56 | + </p> |
| 57 | + |
| 58 | + </subsection> |
| 59 | +<subsection name="(3) Required Jakarta-Commons Resources"> |
| 60 | + |
| 61 | + <ul> |
| 62 | + <li> |
| 63 | + CVS Repository - New directory <code>codec</code> in the |
| 64 | + <code>jakarta-commons</code> CVS repository. |
| 65 | + </li> |
| 66 | + <li> |
| 67 | + Mailing List - Discussions will take place on the general |
| 68 | + <em>commons-dev@jakarta.apache.org</em> mailing list. To help |
| 69 | + list subscribers identify messages of interest, it is suggested that |
| 70 | + the message subject of messages about this component be prefixed with |
| 71 | + [Codec]. |
| 72 | + </li> |
| 73 | + <li> |
| 74 | + Bugzilla - New component "Codec" under the "Commons" product |
| 75 | + category, with appropriate version identifiers as needed. |
| 76 | + </li> |
| 77 | + </ul> |
| 78 | + |
| 79 | + </subsection> |
| 80 | +<subsection name="(4) Initial Committers"> |
| 81 | + |
| 82 | + <p> |
| 83 | + The initial committers on the Codec component shall be as follows: |
| 84 | + <ul> |
| 85 | + <li><a href="mailto:sanders@apache.org">Scott Sanders</a></li> |
| 86 | + <li><a href="mailto:bayard@apache.org">Henri Yandell</a></li> |
| 87 | + <li><a href="mailto:rwaldhoff@apache.org">Rodney Waldhoff</a></li> |
| 88 | + <li><a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a></li> |
| 89 | + <li><a href="mailto:jon@collab.net">Jon S. Stevens</a></li> |
| 90 | + <li><a href="mailto:tobrien@apache.org">Tim O'Brien</a></li> |
| 91 | + </ul> |
| 92 | + </p> |
| 93 | + |
| 94 | + </subsection> |
| 95 | +</section> |
| 96 | +</body> |
| 97 | +</document> |
0 commit comments