commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r1149615 - in /commons/proper/compress/trunk/src/site/xdoc: examples.xml zip.xml
Date Fri, 22 Jul 2011 14:28:16 GMT
Author: bodewig
Date: Fri Jul 22 14:28:15 2011
New Revision: 1149615

URL: http://svn.apache.org/viewvc?rev=1149615&view=rev
Log:
document canReadEntryData more prominently

Modified:
    commons/proper/compress/trunk/src/site/xdoc/examples.xml
    commons/proper/compress/trunk/src/site/xdoc/zip.xml

Modified: commons/proper/compress/trunk/src/site/xdoc/examples.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/examples.xml?rev=1149615&r1=1149614&r2=1149615&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Fri Jul 22 14:28:15 2011
@@ -57,6 +57,20 @@ ArchiveInputStream input = new ArchiveSt
 
       </subsection>
 
+      <subsection name="Unsupported Features">
+        <p>Many of the supported formats have developed different
+        dialects and extensions and some formats allow for features
+        (not yet) supported by Commons Compress.</p>
+
+        <p>The <code>ArchiveInputStream</code> class provides a method
+        <code>canReadEntryData</code> that will return false if
+        Commons Compress can detect that an archive uses a feature
+        that is not supported by the current implementation.  If it
+        returns false you should not try to read the entry but skip
+        over it.</p>
+
+      </subsection>
+
       <subsection name="ar">
 
         <p>In addition to the information stored

Modified: commons/proper/compress/trunk/src/site/xdoc/zip.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/zip.xml?rev=1149615&r1=1149614&r2=1149615&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/zip.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/zip.xml Fri Jul 22 14:28:15 2011
@@ -253,6 +253,28 @@
           extract the file names correctly.</p>
       </subsection>
 
+      <subsection name="Encryption and Alternative Compression Algorithms"
+                  id="encryption">
+        
+        <p>In most cases entries of an archive are not encrypted and
+        are either not compressed at all or use the DEFLATED
+        algorithm, Commons Compress' ZIP archiver will handle them
+        just fine.</p>
+
+        <p>The ZIP specification allows for various other compression
+        algorithms and also supports several different ways of
+        encrypting archive contents.  Neither of those methods is
+        currently supported by Commons Compress and any such entry can
+        not be extracted by the archiving code.</p>
+
+        <p><code>ZipFile</code>'s and
+        <code>ZipArchiveInputStream</code>'s
+        <code>canReadEntryData</code> methods will return false for
+        encrypted entries or entries using an unsupported encryption
+        mechanism.  Using this method it is possible to at least
+        detect and skip the entries that can not be extracted.</p>
+
+      </subsection>
     </section>
   </body>
 </document>



Mime
View raw message