Author: bodewig
Date: Fri Jul 22 14:30:19 2011
New Revision: 1149618
URL: http://svn.apache.org/viewvc?rev=1149618&view=rev
Log:
document canReadEntryData more prominently (and double my commit count by
maintaining two branches)
Modified:
commons/proper/compress/branches/zip64/ (props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/TarBuffer.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
(props changed)
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
(props changed)
commons/proper/compress/branches/zip64/src/site/xdoc/examples.xml
commons/proper/compress/branches/zip64/src/site/xdoc/zip.xml
commons/proper/compress/branches/zip64/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryTest.java
(props changed)
commons/proper/compress/branches/zip64/src/test/java/org/apache/commons/compress/archivers/zip/ZipUtilTest.java
(props changed)
commons/proper/compress/branches/zip64/src/test/resources/OSX_ArchiveWithNestedArchive.zip
(props changed)
Propchange: commons/proper/compress/branches/zip64/
------------------------------------------------------------------------------
svn:mergeinfo = /commons/proper/compress/trunk:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/tar:741089
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1,2 +1,3 @@
/ant/core/trunk/src/main/org/apache/tools/tar/TarArchiveEntry.java:741089
/ant/core/trunk/src/main/org/apache/tools/tar/TarEntry.java:807513,823136
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/tar/TarBuffer.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/tar/TarBuffer.java:741089,789556
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarBuffer.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/zip:738844,739300,741089
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -0,0 +1 @@
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/zip/ZipEntry.java:745537
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -0,0 +1 @@
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/zip/ZipFile.java:738844,738853,739300,741089,747002,1146020
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java:741089
+/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java:1149615
Modified: commons/proper/compress/branches/zip64/src/site/xdoc/examples.xml
URL:
http://svn.apache.org/viewvc/commons/proper/compress/branches/zip64/src/site/xdoc/examples.xml?rev=1149618&r1=1149617&r2=1149618&view=diff
==============================================================================
--- commons/proper/compress/branches/zip64/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/branches/zip64/src/site/xdoc/examples.xml Fri Jul
22 14:30:19 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/branches/zip64/src/site/xdoc/zip.xml
URL:
http://svn.apache.org/viewvc/commons/proper/compress/branches/zip64/src/site/xdoc/zip.xml?rev=1149618&r1=1149617&r2=1149618&view=diff
==============================================================================
--- commons/proper/compress/branches/zip64/src/site/xdoc/zip.xml (original)
+++ commons/proper/compress/branches/zip64/src/site/xdoc/zip.xml Fri Jul 22
14:30:19 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>
Propchange:
commons/proper/compress/branches/zip64/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryTest.java
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jul 22 14:30:19 2011
@@ -1 +1,2 @@
/ant/core/trunk/src/tests/junit/org/apache/tools/zip/ZipEntryTest.java:745537
+/commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryTest.java:1149615
Propchange:
commons/proper/compress/branches/zip64/src/test/java/org/apache/commons/compress/archivers/zip/ZipUtilTest.java
('svn:mergeinfo' removed)
Propchange:
commons/proper/compress/branches/zip64/src/test/resources/OSX_ArchiveWithNestedArchive.zip
('svn:mergeinfo' removed)
