Apache_Hadoop_HDFS_3.2.1.xml 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Tue Sep 10 17:02:45 UTC 2019 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop HDFS 3.2.1"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-hdfs-project/hadoop-hdfs/target/hadoop-annotations.jar:/build/source/hadoop-hdfs-project/hadoop-hdfs/target/jdiff.jar -verbose -classpath /build/source/hadoop-hdfs-project/hadoop-hdfs/target/classes:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.2.1.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.2.1.jar:/maven/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/maven/org/apache/httpcomponents/httpclient/4.5.6/httpclient-4.5.6.jar:/maven/org/apache/httpcomponents/httpcore/4.4.10/httpcore-4.4.10.jar:/maven/com/nimbusds/nimbus-jose-jwt/4.41.1/nimbus-jose-jwt-4.41.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.3/json-smart-2.3.jar:/maven/net/minidev/accessors-smart/1.2/accessors-smart-1.2.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/zookeeper/zookeeper/3.4.13/zookeeper-3.4.13.jar:/maven/org/apache/curator/curator-framework/2.13.0/curator-framework-2.13.0.jar:/maven/org/apache/kerby/kerb-simplekdc/1.0.1/kerb-simplekdc-1.0.1.jar:/maven/org/apache/kerby/kerb-client/1.0.1/kerb-client-1.0.1.jar:/maven/org/apache/kerby/kerby-config/1.0.1/kerby-config-1.0.1.jar:/maven/org/apache/kerby/kerb-core/1.0.1/kerb-core-1.0.1.jar:/maven/org/apache/kerby/kerby-pkix/1.0.1/kerby-pkix-1.0.1.jar:/maven/org/apache/kerby/kerby-asn1/1.0.1/kerby-asn1-1.0.1.jar:/maven/org/apache/kerby/kerby-util/1.0.1/kerby-util-1.0.1.jar:/maven/org/apache/kerby/kerb-common/1.0.1/kerb-common-1.0.1.jar:/maven/org/apache/kerby/kerb-crypto/1.0.1/kerb-crypto-1.0.1.jar:/maven/org/apache/kerby/kerb-util/1.0.1/kerb-util-1.0.1.jar:/maven/org/apache/kerby/token-provider/1.0.1/token-provider-1.0.1.jar:/maven/org/apache/kerby/kerb-admin/1.0.1/kerb-admin-1.0.1.jar:/maven/org/apache/kerby/kerb-server/1.0.1/kerb-server-1.0.1.jar:/maven/org/apache/kerby/kerb-identity/1.0.1/kerb-identity-1.0.1.jar:/maven/org/apache/kerby/kerby-xdr/1.0.1/kerby-xdr-1.0.1.jar:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-3.2.1.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/commons-net/commons-net/3.6/commons-net-3.6.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/org/eclipse/jetty/jetty-servlet/9.3.24.v20180605/jetty-servlet-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-security/9.3.24.v20180605/jetty-security-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-webapp/9.3.24.v20180605/jetty-webapp-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-xml/9.3.24.v20180605/jetty-xml-9.3.24.v20180605.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19/jersey-servlet-1.19.jar:/maven/com/sun/jersey/jersey-json/1.19/jersey-json-1.19.jar:/maven/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/maven/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/maven/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/maven/commons-beanutils/commons-beanutils/1.9.3/commons-beanutils-1.9.3.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.7/commons-lang3-3.7.jar:/maven/org/apache/commons/commons-text/1.4/commons-text-1.4.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/maven/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/maven/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/maven/org/apache/curator/curator-client/2.13.0/curator-client-2.13.0.jar:/maven/org/apache/curator/curator-recipes/2.13.0/curator-recipes-2.13.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/maven/org/apache/commons/commons-compress/1.18/commons-compress-1.18.jar:/maven/org/codehaus/woodstox/stax2-api/3.1.4/stax2-api-3.1.4.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.0.3/woodstox-core-5.0.3.jar:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/build/source/hadoop-hdfs-project/hadoop-hdfs-client/target/hadoop-hdfs-client-3.2.1.jar:/maven/com/squareup/okhttp/okhttp/2.7.5/okhttp-2.7.5.jar:/maven/com/squareup/okio/okio/1.6.0/okio-1.6.0.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.9.8/jackson-annotations-2.9.8.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/com/google/guava/guava/27.0-jre/guava-27.0-jre.jar:/maven/com/google/guava/failureaccess/1.0/failureaccess-1.0.jar:/maven/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:/maven/org/checkerframework/checker-qual/2.5.2/checker-qual-2.5.2.jar:/maven/com/google/errorprone/error_prone_annotations/2.2.0/error_prone_annotations-2.2.0.jar:/maven/com/google/j2objc/j2objc-annotations/1.1/j2objc-annotations-1.1.jar:/maven/org/codehaus/mojo/animal-sniffer-annotations/1.17/animal-sniffer-annotations-1.17.jar:/maven/org/eclipse/jetty/jetty-server/9.3.24.v20180605/jetty-server-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-http/9.3.24.v20180605/jetty-http-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-io/9.3.24.v20180605/jetty-io-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-util/9.3.24.v20180605/jetty-util-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-util-ajax/9.3.24.v20180605/jetty-util-ajax-9.3.24.v20180605.jar:/maven/com/sun/jersey/jersey-core/1.19/jersey-core-1.19.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-server/1.19/jersey-server-1.19.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/commons-codec/commons-codec/1.11/commons-codec-1.11.jar:/maven/commons-io/commons-io/2.5/commons-io-2.5.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/commons-daemon/commons-daemon/1.0.13/commons-daemon-1.0.13.jar:/maven/log4j/log4j/1.2.17/log4j-1.2.17.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/maven/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/maven/io/netty/netty/3.10.5.Final/netty-3.10.5.Final.jar:/maven/io/netty/netty-all/4.0.52.Final/netty-all-4.0.52.Final.jar:/maven/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/maven/org/fusesource/leveldbjni/leveldbjni-all/1.8/leveldbjni-all-1.8.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.9.8/jackson-databind-2.9.8.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.9.8/jackson-core-2.9.8.jar:/maven/xerces/xercesImpl/2.11.0/xercesImpl-2.11.0.jar:/maven/xml-apis/xml-apis/1.4.01/xml-apis-1.4.01.jar -sourcepath /build/source/hadoop-hdfs-project/hadoop-hdfs/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-hdfs-project/hadoop-hdfs/target/hadoop-annotations.jar:/build/source/hadoop-hdfs-project/hadoop-hdfs/target/jdiff.jar -apidir /build/source/hadoop-hdfs-project/hadoop-hdfs/target/site/jdiff/xml -apiname Apache Hadoop HDFS 3.2.1 -->
  11. <package name="org.apache.hadoop.hdfs">
  12. <doc>
  13. <![CDATA[<p>A distributed implementation of {@link
  14. org.apache.hadoop.fs.FileSystem}. This is loosely modelled after
  15. Google's <a href="http://research.google.com/archive/gfs.html">GFS</a>.</p>
  16. <p>The most important difference is that unlike GFS, Hadoop DFS files
  17. have strictly one writer at any one time. Bytes are always appended
  18. to the end of the writer's stream. There is no notion of "record appends"
  19. or "mutations" that are then checked or reordered. Writers simply emit
  20. a byte stream. That byte stream is guaranteed to be stored in the
  21. order written.</p>]]>
  22. </doc>
  23. </package>
  24. <package name="org.apache.hadoop.hdfs.net">
  25. </package>
  26. <package name="org.apache.hadoop.hdfs.protocol">
  27. </package>
  28. <package name="org.apache.hadoop.hdfs.protocol.datatransfer">
  29. </package>
  30. <package name="org.apache.hadoop.hdfs.protocol.datatransfer.sasl">
  31. </package>
  32. <package name="org.apache.hadoop.hdfs.protocolPB">
  33. </package>
  34. <package name="org.apache.hadoop.hdfs.qjournal.client">
  35. </package>
  36. <package name="org.apache.hadoop.hdfs.qjournal.protocol">
  37. </package>
  38. <package name="org.apache.hadoop.hdfs.qjournal.protocolPB">
  39. </package>
  40. <package name="org.apache.hadoop.hdfs.qjournal.server">
  41. <!-- start interface org.apache.hadoop.hdfs.qjournal.server.JournalNodeMXBean -->
  42. <interface name="JournalNodeMXBean" abstract="true"
  43. static="false" final="false" visibility="public"
  44. deprecated="not deprecated">
  45. <method name="getJournalsStatus" return="java.lang.String"
  46. abstract="true" native="false" synchronized="false"
  47. static="false" final="false" visibility="public"
  48. deprecated="not deprecated">
  49. <doc>
  50. <![CDATA[Get status information (e.g., whether formatted) of JournalNode's journals.
  51. @return A string presenting status for each journal]]>
  52. </doc>
  53. </method>
  54. <doc>
  55. <![CDATA[This is the JMX management interface for JournalNode information]]>
  56. </doc>
  57. </interface>
  58. <!-- end interface org.apache.hadoop.hdfs.qjournal.server.JournalNodeMXBean -->
  59. </package>
  60. <package name="org.apache.hadoop.hdfs.security.token.block">
  61. </package>
  62. <package name="org.apache.hadoop.hdfs.security.token.delegation">
  63. </package>
  64. <package name="org.apache.hadoop.hdfs.server.aliasmap">
  65. <!-- start class org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap -->
  66. <class name="InMemoryAliasMap" extends="java.lang.Object"
  67. abstract="false"
  68. static="false" final="false" visibility="public"
  69. deprecated="not deprecated">
  70. <implements name="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMapProtocol"/>
  71. <implements name="org.apache.hadoop.conf.Configurable"/>
  72. <method name="setConf"
  73. abstract="false" native="false" synchronized="false"
  74. static="false" final="false" visibility="public"
  75. deprecated="not deprecated">
  76. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  77. </method>
  78. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  79. abstract="false" native="false" synchronized="false"
  80. static="false" final="false" visibility="public"
  81. deprecated="not deprecated">
  82. </method>
  83. <method name="init" return="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap"
  84. abstract="false" native="false" synchronized="false"
  85. static="true" final="false" visibility="public"
  86. deprecated="not deprecated">
  87. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  88. <param name="blockPoolID" type="java.lang.String"/>
  89. <exception name="IOException" type="java.io.IOException"/>
  90. </method>
  91. <method name="list" return="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMapProtocol.IterationResult"
  92. abstract="false" native="false" synchronized="false"
  93. static="false" final="false" visibility="public"
  94. deprecated="not deprecated">
  95. <param name="marker" type="java.util.Optional"/>
  96. <exception name="IOException" type="java.io.IOException"/>
  97. </method>
  98. <method name="read" return="java.util.Optional"
  99. abstract="false" native="false" synchronized="false"
  100. static="false" final="false" visibility="public"
  101. deprecated="not deprecated">
  102. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  103. <exception name="IOException" type="java.io.IOException"/>
  104. </method>
  105. <method name="write"
  106. abstract="false" native="false" synchronized="false"
  107. static="false" final="false" visibility="public"
  108. deprecated="not deprecated">
  109. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  110. <param name="providedStorageLocation" type="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"/>
  111. <exception name="IOException" type="java.io.IOException"/>
  112. </method>
  113. <method name="getBlockPoolId" return="java.lang.String"
  114. abstract="false" native="false" synchronized="false"
  115. static="false" final="false" visibility="public"
  116. deprecated="not deprecated">
  117. </method>
  118. <method name="close"
  119. abstract="false" native="false" synchronized="false"
  120. static="false" final="false" visibility="public"
  121. deprecated="not deprecated">
  122. <exception name="IOException" type="java.io.IOException"/>
  123. </method>
  124. <method name="fromProvidedStorageLocationBytes" return="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  125. abstract="false" native="false" synchronized="false"
  126. static="true" final="false" visibility="public"
  127. deprecated="not deprecated">
  128. <param name="providedStorageLocationDbFormat" type="byte[]"/>
  129. <exception name="InvalidProtocolBufferException" type="com.google.protobuf.InvalidProtocolBufferException"/>
  130. </method>
  131. <method name="fromBlockBytes" return="org.apache.hadoop.hdfs.protocol.Block"
  132. abstract="false" native="false" synchronized="false"
  133. static="true" final="false" visibility="public"
  134. deprecated="not deprecated">
  135. <param name="blockDbFormat" type="byte[]"/>
  136. <exception name="InvalidProtocolBufferException" type="com.google.protobuf.InvalidProtocolBufferException"/>
  137. </method>
  138. <method name="toProtoBufBytes" return="byte[]"
  139. abstract="false" native="false" synchronized="false"
  140. static="true" final="false" visibility="public"
  141. deprecated="not deprecated">
  142. <param name="providedStorageLocation" type="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"/>
  143. <exception name="IOException" type="java.io.IOException"/>
  144. </method>
  145. <method name="toProtoBufBytes" return="byte[]"
  146. abstract="false" native="false" synchronized="false"
  147. static="true" final="false" visibility="public"
  148. deprecated="not deprecated">
  149. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  150. <exception name="IOException" type="java.io.IOException"/>
  151. </method>
  152. <doc>
  153. <![CDATA[InMemoryAliasMap is an implementation of the InMemoryAliasMapProtocol for
  154. use with LevelDB.]]>
  155. </doc>
  156. </class>
  157. <!-- end class org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap -->
  158. </package>
  159. <package name="org.apache.hadoop.hdfs.server.balancer">
  160. </package>
  161. <package name="org.apache.hadoop.hdfs.server.blockmanagement">
  162. </package>
  163. <package name="org.apache.hadoop.hdfs.server.common">
  164. <!-- start interface org.apache.hadoop.hdfs.server.common.BlockAlias -->
  165. <interface name="BlockAlias" abstract="true"
  166. static="false" final="false" visibility="public"
  167. deprecated="not deprecated">
  168. <method name="getBlock" return="org.apache.hadoop.hdfs.protocol.Block"
  169. abstract="true" native="false" synchronized="false"
  170. static="false" final="false" visibility="public"
  171. deprecated="not deprecated">
  172. </method>
  173. <doc>
  174. <![CDATA[Interface used to load provided blocks.]]>
  175. </doc>
  176. </interface>
  177. <!-- end interface org.apache.hadoop.hdfs.server.common.BlockAlias -->
  178. <!-- start class org.apache.hadoop.hdfs.server.common.FileRegion -->
  179. <class name="FileRegion" extends="java.lang.Object"
  180. abstract="false"
  181. static="false" final="false" visibility="public"
  182. deprecated="not deprecated">
  183. <implements name="org.apache.hadoop.hdfs.server.common.BlockAlias"/>
  184. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long, long"
  185. static="false" final="false" visibility="public"
  186. deprecated="not deprecated">
  187. </constructor>
  188. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long, long, byte[]"
  189. static="false" final="false" visibility="public"
  190. deprecated="not deprecated">
  191. </constructor>
  192. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long"
  193. static="false" final="false" visibility="public"
  194. deprecated="not deprecated">
  195. </constructor>
  196. <constructor name="FileRegion" type="org.apache.hadoop.hdfs.protocol.Block, org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  197. static="false" final="false" visibility="public"
  198. deprecated="not deprecated">
  199. </constructor>
  200. <method name="getBlock" return="org.apache.hadoop.hdfs.protocol.Block"
  201. abstract="false" native="false" synchronized="false"
  202. static="false" final="false" visibility="public"
  203. deprecated="not deprecated">
  204. </method>
  205. <method name="getProvidedStorageLocation" return="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  206. abstract="false" native="false" synchronized="false"
  207. static="false" final="false" visibility="public"
  208. deprecated="not deprecated">
  209. </method>
  210. <method name="equals" return="boolean"
  211. abstract="false" native="false" synchronized="false"
  212. static="false" final="false" visibility="public"
  213. deprecated="not deprecated">
  214. <param name="o" type="java.lang.Object"/>
  215. </method>
  216. <method name="hashCode" return="int"
  217. abstract="false" native="false" synchronized="false"
  218. static="false" final="false" visibility="public"
  219. deprecated="not deprecated">
  220. </method>
  221. <doc>
  222. <![CDATA[This class is used to represent provided blocks that are file regions,
  223. i.e., can be described using (path, offset, length).]]>
  224. </doc>
  225. </class>
  226. <!-- end class org.apache.hadoop.hdfs.server.common.FileRegion -->
  227. </package>
  228. <package name="org.apache.hadoop.hdfs.server.common.blockaliasmap">
  229. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap -->
  230. <class name="BlockAliasMap" extends="java.lang.Object"
  231. abstract="true"
  232. static="false" final="false" visibility="public"
  233. deprecated="not deprecated">
  234. <constructor name="BlockAliasMap"
  235. static="false" final="false" visibility="public"
  236. deprecated="not deprecated">
  237. </constructor>
  238. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  239. abstract="true" native="false" synchronized="false"
  240. static="false" final="false" visibility="public"
  241. deprecated="not deprecated">
  242. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  243. <param name="blockPoolID" type="java.lang.String"/>
  244. <exception name="IOException" type="java.io.IOException"/>
  245. <doc>
  246. <![CDATA[Returns a reader to the alias map.
  247. @param opts reader options
  248. @param blockPoolID block pool id to use
  249. @return {@link Reader} to the alias map. If a Reader for the blockPoolID
  250. cannot be created, this will return null.
  251. @throws IOException]]>
  252. </doc>
  253. </method>
  254. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  255. abstract="true" native="false" synchronized="false"
  256. static="false" final="false" visibility="public"
  257. deprecated="not deprecated">
  258. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  259. <param name="blockPoolID" type="java.lang.String"/>
  260. <exception name="IOException" type="java.io.IOException"/>
  261. <doc>
  262. <![CDATA[Returns the writer for the alias map.
  263. @param opts writer options.
  264. @param blockPoolID block pool id to use
  265. @return {@link Writer} to the alias map.
  266. @throws IOException]]>
  267. </doc>
  268. </method>
  269. <method name="refresh"
  270. abstract="true" native="false" synchronized="false"
  271. static="false" final="false" visibility="public"
  272. deprecated="not deprecated">
  273. <exception name="IOException" type="java.io.IOException"/>
  274. <doc>
  275. <![CDATA[Refresh the alias map.
  276. @throws IOException]]>
  277. </doc>
  278. </method>
  279. <method name="close"
  280. abstract="true" native="false" synchronized="false"
  281. static="false" final="false" visibility="public"
  282. deprecated="not deprecated">
  283. <exception name="IOException" type="java.io.IOException"/>
  284. </method>
  285. <doc>
  286. <![CDATA[An abstract class used to read and write block maps for provided blocks.]]>
  287. </doc>
  288. </class>
  289. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap -->
  290. </package>
  291. <package name="org.apache.hadoop.hdfs.server.common.blockaliasmap.impl">
  292. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.LevelDBFileRegionAliasMap -->
  293. <class name="LevelDBFileRegionAliasMap" extends="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap"
  294. abstract="false"
  295. static="false" final="false" visibility="public"
  296. deprecated="not deprecated">
  297. <implements name="org.apache.hadoop.conf.Configurable"/>
  298. <constructor name="LevelDBFileRegionAliasMap"
  299. static="false" final="false" visibility="public"
  300. deprecated="not deprecated">
  301. </constructor>
  302. <method name="setConf"
  303. abstract="false" native="false" synchronized="false"
  304. static="false" final="false" visibility="public"
  305. deprecated="not deprecated">
  306. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  307. </method>
  308. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  309. abstract="false" native="false" synchronized="false"
  310. static="false" final="false" visibility="public"
  311. deprecated="not deprecated">
  312. </method>
  313. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  314. abstract="false" native="false" synchronized="false"
  315. static="false" final="false" visibility="public"
  316. deprecated="not deprecated">
  317. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  318. <param name="blockPoolID" type="java.lang.String"/>
  319. <exception name="IOException" type="java.io.IOException"/>
  320. </method>
  321. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  322. abstract="false" native="false" synchronized="false"
  323. static="false" final="false" visibility="public"
  324. deprecated="not deprecated">
  325. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  326. <param name="blockPoolID" type="java.lang.String"/>
  327. <exception name="IOException" type="java.io.IOException"/>
  328. </method>
  329. <method name="refresh"
  330. abstract="false" native="false" synchronized="false"
  331. static="false" final="false" visibility="public"
  332. deprecated="not deprecated">
  333. <exception name="IOException" type="java.io.IOException"/>
  334. </method>
  335. <method name="close"
  336. abstract="false" native="false" synchronized="false"
  337. static="false" final="false" visibility="public"
  338. deprecated="not deprecated">
  339. <exception name="IOException" type="java.io.IOException"/>
  340. </method>
  341. <field name="LOG" type="org.slf4j.Logger"
  342. transient="false" volatile="false"
  343. static="true" final="true" visibility="public"
  344. deprecated="not deprecated">
  345. </field>
  346. <doc>
  347. <![CDATA[A LevelDB based implementation of {@link BlockAliasMap}.]]>
  348. </doc>
  349. </class>
  350. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.LevelDBFileRegionAliasMap -->
  351. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.TextFileRegionAliasMap -->
  352. <class name="TextFileRegionAliasMap" extends="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap"
  353. abstract="false"
  354. static="false" final="false" visibility="public"
  355. deprecated="not deprecated">
  356. <implements name="org.apache.hadoop.conf.Configurable"/>
  357. <constructor name="TextFileRegionAliasMap"
  358. static="false" final="false" visibility="public"
  359. deprecated="not deprecated">
  360. </constructor>
  361. <method name="setConf"
  362. abstract="false" native="false" synchronized="false"
  363. static="false" final="false" visibility="public"
  364. deprecated="not deprecated">
  365. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  366. </method>
  367. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  368. abstract="false" native="false" synchronized="false"
  369. static="false" final="false" visibility="public"
  370. deprecated="not deprecated">
  371. </method>
  372. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  373. abstract="false" native="false" synchronized="false"
  374. static="false" final="false" visibility="public"
  375. deprecated="not deprecated">
  376. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  377. <param name="blockPoolID" type="java.lang.String"/>
  378. <exception name="IOException" type="java.io.IOException"/>
  379. </method>
  380. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  381. abstract="false" native="false" synchronized="false"
  382. static="false" final="false" visibility="public"
  383. deprecated="not deprecated">
  384. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  385. <param name="blockPoolID" type="java.lang.String"/>
  386. <exception name="IOException" type="java.io.IOException"/>
  387. </method>
  388. <method name="refresh"
  389. abstract="false" native="false" synchronized="false"
  390. static="false" final="false" visibility="public"
  391. deprecated="not deprecated">
  392. <exception name="IOException" type="java.io.IOException"/>
  393. </method>
  394. <method name="close"
  395. abstract="false" native="false" synchronized="false"
  396. static="false" final="false" visibility="public"
  397. deprecated="not deprecated">
  398. <exception name="IOException" type="java.io.IOException"/>
  399. </method>
  400. <method name="blockPoolIDFromFileName" return="java.lang.String"
  401. abstract="false" native="false" synchronized="false"
  402. static="true" final="false" visibility="public"
  403. deprecated="not deprecated">
  404. <param name="file" type="org.apache.hadoop.fs.Path"/>
  405. </method>
  406. <method name="fileNameFromBlockPoolID" return="java.lang.String"
  407. abstract="false" native="false" synchronized="false"
  408. static="true" final="false" visibility="public"
  409. deprecated="not deprecated">
  410. <param name="blockPoolID" type="java.lang.String"/>
  411. </method>
  412. <field name="LOG" type="org.slf4j.Logger"
  413. transient="false" volatile="false"
  414. static="true" final="true" visibility="public"
  415. deprecated="not deprecated">
  416. </field>
  417. <doc>
  418. <![CDATA[This class is used for block maps stored as text files,
  419. with a specified delimiter.]]>
  420. </doc>
  421. </class>
  422. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.TextFileRegionAliasMap -->
  423. </package>
  424. <package name="org.apache.hadoop.hdfs.server.datanode">
  425. </package>
  426. <package name="org.apache.hadoop.hdfs.server.datanode.fsdataset">
  427. </package>
  428. <package name="org.apache.hadoop.hdfs.server.datanode.fsdataset.impl">
  429. </package>
  430. <package name="org.apache.hadoop.hdfs.server.datanode.metrics">
  431. </package>
  432. <package name="org.apache.hadoop.hdfs.server.datanode.web">
  433. </package>
  434. <package name="org.apache.hadoop.hdfs.server.datanode.web.webhdfs">
  435. </package>
  436. <package name="org.apache.hadoop.hdfs.server.diskbalancer">
  437. </package>
  438. <package name="org.apache.hadoop.hdfs.server.diskbalancer.command">
  439. </package>
  440. <package name="org.apache.hadoop.hdfs.server.diskbalancer.connectors">
  441. </package>
  442. <package name="org.apache.hadoop.hdfs.server.diskbalancer.datamodel">
  443. </package>
  444. <package name="org.apache.hadoop.hdfs.server.diskbalancer.planner">
  445. </package>
  446. <package name="org.apache.hadoop.hdfs.server.mover">
  447. </package>
  448. <package name="org.apache.hadoop.hdfs.server.namenode">
  449. <!-- start interface org.apache.hadoop.hdfs.server.namenode.AuditLogger -->
  450. <interface name="AuditLogger" abstract="true"
  451. static="false" final="false" visibility="public"
  452. deprecated="not deprecated">
  453. <method name="initialize"
  454. abstract="true" native="false" synchronized="false"
  455. static="false" final="false" visibility="public"
  456. deprecated="not deprecated">
  457. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  458. <doc>
  459. <![CDATA[Called during initialization of the logger.
  460. @param conf The configuration object.]]>
  461. </doc>
  462. </method>
  463. <method name="logAuditEvent"
  464. abstract="true" native="false" synchronized="false"
  465. static="false" final="false" visibility="public"
  466. deprecated="not deprecated">
  467. <param name="succeeded" type="boolean"/>
  468. <param name="userName" type="java.lang.String"/>
  469. <param name="addr" type="java.net.InetAddress"/>
  470. <param name="cmd" type="java.lang.String"/>
  471. <param name="src" type="java.lang.String"/>
  472. <param name="dst" type="java.lang.String"/>
  473. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  474. <doc>
  475. <![CDATA[Called to log an audit event.
  476. <p>
  477. This method must return as quickly as possible, since it's called
  478. in a critical section of the NameNode's operation.
  479. @param succeeded Whether authorization succeeded.
  480. @param userName Name of the user executing the request.
  481. @param addr Remote address of the request.
  482. @param cmd The requested command.
  483. @param src Path of affected source file.
  484. @param dst Path of affected destination file (if any).
  485. @param stat File information for operations that change the file's
  486. metadata (permissions, owner, times, etc).]]>
  487. </doc>
  488. </method>
  489. <doc>
  490. <![CDATA[Interface defining an audit logger.]]>
  491. </doc>
  492. </interface>
  493. <!-- end interface org.apache.hadoop.hdfs.server.namenode.AuditLogger -->
  494. <!-- start class org.apache.hadoop.hdfs.server.namenode.HdfsAuditLogger -->
  495. <class name="HdfsAuditLogger" extends="java.lang.Object"
  496. abstract="true"
  497. static="false" final="false" visibility="public"
  498. deprecated="not deprecated">
  499. <implements name="org.apache.hadoop.hdfs.server.namenode.AuditLogger"/>
  500. <constructor name="HdfsAuditLogger"
  501. static="false" final="false" visibility="public"
  502. deprecated="not deprecated">
  503. </constructor>
  504. <method name="logAuditEvent"
  505. abstract="false" native="false" synchronized="false"
  506. static="false" final="false" visibility="public"
  507. deprecated="not deprecated">
  508. <param name="succeeded" type="boolean"/>
  509. <param name="userName" type="java.lang.String"/>
  510. <param name="addr" type="java.net.InetAddress"/>
  511. <param name="cmd" type="java.lang.String"/>
  512. <param name="src" type="java.lang.String"/>
  513. <param name="dst" type="java.lang.String"/>
  514. <param name="status" type="org.apache.hadoop.fs.FileStatus"/>
  515. </method>
  516. <method name="logAuditEvent"
  517. abstract="true" native="false" synchronized="false"
  518. static="false" final="false" visibility="public"
  519. deprecated="not deprecated">
  520. <param name="succeeded" type="boolean"/>
  521. <param name="userName" type="java.lang.String"/>
  522. <param name="addr" type="java.net.InetAddress"/>
  523. <param name="cmd" type="java.lang.String"/>
  524. <param name="src" type="java.lang.String"/>
  525. <param name="dst" type="java.lang.String"/>
  526. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  527. <param name="callerContext" type="org.apache.hadoop.ipc.CallerContext"/>
  528. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  529. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  530. <doc>
  531. <![CDATA[Same as
  532. {@link #logAuditEvent(boolean, String, InetAddress, String, String, String,
  533. FileStatus)} with additional parameters related to logging delegation token
  534. tracking IDs.
  535. @param succeeded Whether authorization succeeded.
  536. @param userName Name of the user executing the request.
  537. @param addr Remote address of the request.
  538. @param cmd The requested command.
  539. @param src Path of affected source file.
  540. @param dst Path of affected destination file (if any).
  541. @param stat File information for operations that change the file's metadata
  542. (permissions, owner, times, etc).
  543. @param callerContext Context information of the caller
  544. @param ugi UserGroupInformation of the current user, or null if not logging
  545. token tracking information
  546. @param dtSecretManager The token secret manager, or null if not logging
  547. token tracking information]]>
  548. </doc>
  549. </method>
  550. <method name="logAuditEvent"
  551. abstract="true" native="false" synchronized="false"
  552. static="false" final="false" visibility="public"
  553. deprecated="not deprecated">
  554. <param name="succeeded" type="boolean"/>
  555. <param name="userName" type="java.lang.String"/>
  556. <param name="addr" type="java.net.InetAddress"/>
  557. <param name="cmd" type="java.lang.String"/>
  558. <param name="src" type="java.lang.String"/>
  559. <param name="dst" type="java.lang.String"/>
  560. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  561. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  562. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  563. <doc>
  564. <![CDATA[Same as
  565. {@link #logAuditEvent(boolean, String, InetAddress, String, String,
  566. String, FileStatus, CallerContext, UserGroupInformation,
  567. DelegationTokenSecretManager)} without {@link CallerContext} information.]]>
  568. </doc>
  569. </method>
  570. <doc>
  571. <![CDATA[Extension of {@link AuditLogger}.]]>
  572. </doc>
  573. </class>
  574. <!-- end class org.apache.hadoop.hdfs.server.namenode.HdfsAuditLogger -->
  575. <!-- start class org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider -->
  576. <class name="INodeAttributeProvider" extends="java.lang.Object"
  577. abstract="true"
  578. static="false" final="false" visibility="public"
  579. deprecated="not deprecated">
  580. <constructor name="INodeAttributeProvider"
  581. static="false" final="false" visibility="public"
  582. deprecated="not deprecated">
  583. </constructor>
  584. <method name="start"
  585. abstract="true" native="false" synchronized="false"
  586. static="false" final="false" visibility="public"
  587. deprecated="not deprecated">
  588. <doc>
  589. <![CDATA[Initialize the provider. This method is called at NameNode startup
  590. time.]]>
  591. </doc>
  592. </method>
  593. <method name="stop"
  594. abstract="true" native="false" synchronized="false"
  595. static="false" final="false" visibility="public"
  596. deprecated="not deprecated">
  597. <doc>
  598. <![CDATA[Shutdown the provider. This method is called at NameNode shutdown time.]]>
  599. </doc>
  600. </method>
  601. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  602. abstract="false" native="false" synchronized="false"
  603. static="false" final="false" visibility="public"
  604. deprecated="not deprecated">
  605. <param name="fullPath" type="java.lang.String"/>
  606. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  607. </method>
  608. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  609. abstract="true" native="false" synchronized="false"
  610. static="false" final="false" visibility="public"
  611. deprecated="not deprecated">
  612. <param name="pathElements" type="java.lang.String[]"/>
  613. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  614. </method>
  615. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  616. abstract="false" native="false" synchronized="false"
  617. static="false" final="false" visibility="public"
  618. deprecated="not deprecated">
  619. <param name="components" type="byte[][]"/>
  620. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  621. </method>
  622. <method name="getExternalAccessControlEnforcer" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AccessControlEnforcer"
  623. abstract="false" native="false" synchronized="false"
  624. static="false" final="false" visibility="public"
  625. deprecated="not deprecated">
  626. <param name="defaultEnforcer" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AccessControlEnforcer"/>
  627. <doc>
  628. <![CDATA[Can be over-ridden by implementations to provide a custom Access Control
  629. Enforcer that can provide an alternate implementation of the
  630. default permission checking logic.
  631. @param defaultEnforcer The Default AccessControlEnforcer
  632. @return The AccessControlEnforcer to use]]>
  633. </doc>
  634. </method>
  635. </class>
  636. <!-- end class org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider -->
  637. </package>
  638. <package name="org.apache.hadoop.hdfs.server.namenode.ha">
  639. </package>
  640. <package name="org.apache.hadoop.hdfs.server.namenode.metrics">
  641. </package>
  642. <package name="org.apache.hadoop.hdfs.server.namenode.snapshot">
  643. </package>
  644. <package name="org.apache.hadoop.hdfs.server.namenode.top">
  645. </package>
  646. <package name="org.apache.hadoop.hdfs.server.namenode.top.metrics">
  647. </package>
  648. <package name="org.apache.hadoop.hdfs.server.namenode.top.window">
  649. </package>
  650. <package name="org.apache.hadoop.hdfs.server.namenode.web.resources">
  651. </package>
  652. <package name="org.apache.hadoop.hdfs.tools">
  653. </package>
  654. <package name="org.apache.hadoop.hdfs.tools.offlineEditsViewer">
  655. </package>
  656. <package name="org.apache.hadoop.hdfs.tools.offlineImageViewer">
  657. </package>
  658. <package name="org.apache.hadoop.hdfs.tools.snapshot">
  659. </package>
  660. <package name="org.apache.hadoop.hdfs.util">
  661. </package>
  662. <package name="org.apache.hadoop.hdfs.web">
  663. </package>
  664. <package name="org.apache.hadoop.hdfs.web.resources">
  665. </package>
  666. </api>