package-summary.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  6. <title>org.apache.commons.compress.archivers.dump (Apache Commons Compress 1.13 API)</title>
  7. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  8. </head>
  9. <body>
  10. <script type="text/javascript"><!--
  11. try {
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="org.apache.commons.compress.archivers.dump (Apache Commons Compress 1.13 API)";
  14. }
  15. }
  16. catch(err) {
  17. }
  18. //-->
  19. </script>
  20. <noscript>
  21. <div>JavaScript is disabled on your browser.</div>
  22. </noscript>
  23. <!-- ========= START OF TOP NAVBAR ======= -->
  24. <div class="topNav"><a name="navbar_top">
  25. <!-- -->
  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  27. <!-- -->
  28. </a>
  29. <ul class="navList" title="Navigation">
  30. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  31. <li class="navBarCell1Rev">Package</li>
  32. <li>Class</li>
  33. <li><a href="package-use.html">Use</a></li>
  34. <li><a href="package-tree.html">Tree</a></li>
  35. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  36. <li><a href="../../../../../../index-all.html">Index</a></li>
  37. <li><a href="../../../../../../help-doc.html">Help</a></li>
  38. </ul>
  39. </div>
  40. <div class="subNav">
  41. <ul class="navList">
  42. <li><a href="../../../../../../org/apache/commons/compress/archivers/cpio/package-summary.html">Prev Package</a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/jar/package-summary.html">Next Package</a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/dump/package-summary.html" target="_top">Frames</a></li>
  47. <li><a href="package-summary.html" target="_top">No Frames</a></li>
  48. </ul>
  49. <ul class="navList" id="allclasses_navbar_top">
  50. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  51. </ul>
  52. <div>
  53. <script type="text/javascript"><!--
  54. allClassesLink = document.getElementById("allclasses_navbar_top");
  55. if(window==top) {
  56. allClassesLink.style.display = "block";
  57. }
  58. else {
  59. allClassesLink.style.display = "none";
  60. }
  61. //-->
  62. </script>
  63. </div>
  64. <a name="skip-navbar_top">
  65. <!-- -->
  66. </a></div>
  67. <!-- ========= END OF TOP NAVBAR ========= -->
  68. <div class="header">
  69. <h1 title="Package" class="title">Package&nbsp;org.apache.commons.compress.archivers.dump</h1>
  70. <div class="docSummary">
  71. <div class="block">This package provides stream classes for reading archives
  72. using the Unix DUMP format.</div>
  73. </div>
  74. <p>See:&nbsp;<a href="#package_description">Description</a></p>
  75. </div>
  76. <div class="contentContainer">
  77. <ul class="blockList">
  78. <li class="blockList">
  79. <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
  80. <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
  81. <tr>
  82. <th class="colFirst" scope="col">Class</th>
  83. <th class="colLast" scope="col">Description</th>
  84. </tr>
  85. <tbody>
  86. <tr class="altColor">
  87. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveConstants.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveConstants</a></td>
  88. <td class="colLast">
  89. <div class="block">Various constants associated with dump archives.</div>
  90. </td>
  91. </tr>
  92. <tr class="rowColor">
  93. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveEntry</a></td>
  94. <td class="colLast">
  95. <div class="block">This class represents an entry in a Dump archive.</div>
  96. </td>
  97. </tr>
  98. <tr class="altColor">
  99. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveInputStream</a></td>
  100. <td class="colLast">
  101. <div class="block">The DumpArchiveInputStream reads a UNIX dump archive as an InputStream.</div>
  102. </td>
  103. </tr>
  104. <tr class="rowColor">
  105. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveSummary.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveSummary</a></td>
  106. <td class="colLast">
  107. <div class="block">This class represents identifying information about a Dump archive volume.</div>
  108. </td>
  109. </tr>
  110. </tbody>
  111. </table>
  112. </li>
  113. <li class="blockList">
  114. <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
  115. <caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
  116. <tr>
  117. <th class="colFirst" scope="col">Enum</th>
  118. <th class="colLast" scope="col">Description</th>
  119. </tr>
  120. <tbody>
  121. <tr class="altColor">
  122. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveConstants.COMPRESSION_TYPE.html" title="enum in org.apache.commons.compress.archivers.dump">DumpArchiveConstants.COMPRESSION_TYPE</a></td>
  123. <td class="colLast">
  124. <div class="block">The type of compression.</div>
  125. </td>
  126. </tr>
  127. <tr class="rowColor">
  128. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveConstants.SEGMENT_TYPE.html" title="enum in org.apache.commons.compress.archivers.dump">DumpArchiveConstants.SEGMENT_TYPE</a></td>
  129. <td class="colLast">
  130. <div class="block">The type of tape segment.</div>
  131. </td>
  132. </tr>
  133. <tr class="altColor">
  134. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.PERMISSION.html" title="enum in org.apache.commons.compress.archivers.dump">DumpArchiveEntry.PERMISSION</a></td>
  135. <td class="colLast">&nbsp;</td>
  136. </tr>
  137. <tr class="rowColor">
  138. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveEntry.TYPE.html" title="enum in org.apache.commons.compress.archivers.dump">DumpArchiveEntry.TYPE</a></td>
  139. <td class="colLast">&nbsp;</td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. </li>
  144. <li class="blockList">
  145. <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
  146. <caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
  147. <tr>
  148. <th class="colFirst" scope="col">Exception</th>
  149. <th class="colLast" scope="col">Description</th>
  150. </tr>
  151. <tbody>
  152. <tr class="altColor">
  153. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/DumpArchiveException.html" title="class in org.apache.commons.compress.archivers.dump">DumpArchiveException</a></td>
  154. <td class="colLast">
  155. <div class="block">Dump Archive Exception</div>
  156. </td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/InvalidFormatException.html" title="class in org.apache.commons.compress.archivers.dump">InvalidFormatException</a></td>
  160. <td class="colLast">
  161. <div class="block">Invalid Format Exception.</div>
  162. </td>
  163. </tr>
  164. <tr class="altColor">
  165. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/ShortFileException.html" title="class in org.apache.commons.compress.archivers.dump">ShortFileException</a></td>
  166. <td class="colLast">
  167. <div class="block">Short File Exception.</div>
  168. </td>
  169. </tr>
  170. <tr class="rowColor">
  171. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/UnrecognizedFormatException.html" title="class in org.apache.commons.compress.archivers.dump">UnrecognizedFormatException</a></td>
  172. <td class="colLast">
  173. <div class="block">Unrecognized Format Exception.</div>
  174. </td>
  175. </tr>
  176. <tr class="altColor">
  177. <td class="colFirst"><a href="../../../../../../org/apache/commons/compress/archivers/dump/UnsupportedCompressionAlgorithmException.html" title="class in org.apache.commons.compress.archivers.dump">UnsupportedCompressionAlgorithmException</a></td>
  178. <td class="colLast">
  179. <div class="block">Unsupported compression algorithm.</div>
  180. </td>
  181. </tr>
  182. </tbody>
  183. </table>
  184. </li>
  185. </ul>
  186. <a name="package_description">
  187. <!-- -->
  188. </a>
  189. <h2 title="Package org.apache.commons.compress.archivers.dump Description">Package org.apache.commons.compress.archivers.dump Description</h2>
  190. <div class="block"><p>This package provides stream classes for reading archives
  191. using the Unix DUMP format. This format is similar to (and
  192. contemporary with) TAR but reads the raw filesystem directly.
  193. This means that writers are filesystem-specific even though the
  194. created archives are filesystem-agnostic.
  195. </p>
  196. <p>Unlike other formats DUMP offers clean support for sparse files,
  197. extended attributes, and other file metadata. In addition DUMP
  198. supports incremental dump files can capture (most) file deletion.
  199. It also provides a native form of compression and will soon support
  200. native encryption as well.
  201. </p>
  202. <p>In practice TAR archives are used for both distribution
  203. and backups. DUMP archives are used exclusively for backups.
  204. </p>
  205. <p>Like any 30+-year-old application there are a number of variants.
  206. For pragmatic reasons we will only support archives with the
  207. 'new' tape header and inode formats. Other restrictions:
  208. <ul>
  209. <li>We only support ZLIB compression. The format
  210. also permits LZO and BZLIB compression.</li>
  211. <li>Sparse files will have the holes filled.</li>
  212. <li>MacOS finder and resource streams are ignored.</li>
  213. <li>Extended attributes are not currently provided.</li>
  214. <li>SELinux labels are not currently provided.</li>
  215. </ul>
  216. </p>
  217. <p>As of Apache Commons Compress 1.3 support for the dump format is
  218. read-only.</p></div>
  219. </div>
  220. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  221. <div class="bottomNav"><a name="navbar_bottom">
  222. <!-- -->
  223. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  224. <!-- -->
  225. </a>
  226. <ul class="navList" title="Navigation">
  227. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  228. <li class="navBarCell1Rev">Package</li>
  229. <li>Class</li>
  230. <li><a href="package-use.html">Use</a></li>
  231. <li><a href="package-tree.html">Tree</a></li>
  232. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  233. <li><a href="../../../../../../index-all.html">Index</a></li>
  234. <li><a href="../../../../../../help-doc.html">Help</a></li>
  235. </ul>
  236. </div>
  237. <div class="subNav">
  238. <ul class="navList">
  239. <li><a href="../../../../../../org/apache/commons/compress/archivers/cpio/package-summary.html">Prev Package</a></li>
  240. <li><a href="../../../../../../org/apache/commons/compress/archivers/jar/package-summary.html">Next Package</a></li>
  241. </ul>
  242. <ul class="navList">
  243. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/dump/package-summary.html" target="_top">Frames</a></li>
  244. <li><a href="package-summary.html" target="_top">No Frames</a></li>
  245. </ul>
  246. <ul class="navList" id="allclasses_navbar_bottom">
  247. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  248. </ul>
  249. <div>
  250. <script type="text/javascript"><!--
  251. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  252. if(window==top) {
  253. allClassesLink.style.display = "block";
  254. }
  255. else {
  256. allClassesLink.style.display = "none";
  257. }
  258. //-->
  259. </script>
  260. </div>
  261. <a name="skip-navbar_bottom">
  262. <!-- -->
  263. </a></div>
  264. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  265. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  266. </body>
  267. </html>