Apache_Hadoop_HDFS_3.3.3.xml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835
  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 Mon May 09 18:03:54 GMT 2022 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop HDFS 3.3.3"
  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-auth/target/hadoop-auth-3.3.3.jar:/maven/org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar:/maven/org/apache/httpcomponents/httpclient/4.5.13/httpclient-4.5.13.jar:/maven/org/apache/httpcomponents/httpcore/4.4.13/httpcore-4.4.13.jar:/maven/com/nimbusds/nimbus-jose-jwt/9.8.1/nimbus-jose-jwt-9.8.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.4.7/json-smart-2.4.7.jar:/maven/net/minidev/accessors-smart/2.4.7/accessors-smart-2.4.7.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/zookeeper/zookeeper/3.5.6/zookeeper-3.5.6.jar:/maven/org/apache/curator/curator-framework/4.2.0/curator-framework-4.2.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-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.3.3.jar:/maven/org/apache/hadoop/thirdparty/hadoop-shaded-protobuf_3_7/1.1.1/hadoop-shaded-protobuf_3_7-1.1.1.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/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/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/jakarta/activation/jakarta.activation-api/1.2.1/jakarta.activation-api-1.2.1.jar:/maven/org/eclipse/jetty/jetty-servlet/9.4.43.v20210629/jetty-servlet-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-security/9.4.43.v20210629/jetty-security-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-webapp/9.4.43.v20210629/jetty-webapp-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-xml/9.4.43.v20210629/jetty-xml-9.4.43.v20210629.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.4/commons-beanutils-1.9.4.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.12.0/commons-lang3-3.12.0.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/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.8.9/gson-2.8.9.jar:/maven/com/jcraft/jsch/0.1.55/jsch-0.1.55.jar:/maven/org/apache/curator/curator-client/4.2.0/curator-client-4.2.0.jar:/maven/org/apache/curator/curator-recipes/4.2.0/curator-recipes-4.2.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar:/maven/org/apache/commons/commons-compress/1.21/commons-compress-1.21.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/codehaus/woodstox/stax2-api/4.2.1/stax2-api-4.2.1.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.3.0/woodstox-core-5.3.0.jar:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/maven/org/xerial/snappy/snappy-java/1.1.8.2/snappy-java-1.1.8.2.jar:/build/source/hadoop-hdfs-project/hadoop-hdfs-client/target/hadoop-hdfs-client-3.3.3.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.13.2/jackson-annotations-2.13.2.jar:/maven/org/apache/zookeeper/zookeeper-jute/3.5.6/zookeeper-jute-3.5.6.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/org/apache/hadoop/thirdparty/hadoop-shaded-guava/1.1.1/hadoop-shaded-guava-1.1.1.jar:/maven/org/eclipse/jetty/jetty-server/9.4.43.v20210629/jetty-server-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-http/9.4.43.v20210629/jetty-http-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-io/9.4.43.v20210629/jetty-io-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util/9.4.43.v20210629/jetty-util-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util-ajax/9.4.43.v20210629/jetty-util-ajax-9.4.43.v20210629.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.15/commons-codec-1.15.jar:/maven/commons-io/commons-io/2.8.0/commons-io-2.8.0.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/ch/qos/reload4j/reload4j/1.2.18.3/reload4j-1.2.18.3.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/com/google/code/findbugs/findbugs/3.0.1/findbugs-3.0.1.jar:/maven/net/jcip/jcip-annotations/1.0/jcip-annotations-1.0.jar:/maven/com/google/code/findbugs/bcel-findbugs/6.0/bcel-findbugs-6.0.jar:/maven/com/google/code/findbugs/jFormatString/2.0.1/jFormatString-2.0.1.jar:/maven/dom4j/dom4j/1.6.1/dom4j-1.6.1.jar:/maven/org/ow2/asm/asm-debug-all/5.0.2/asm-debug-all-5.0.2.jar:/maven/org/ow2/asm/asm-commons/5.0.2/asm-commons-5.0.2.jar:/maven/org/ow2/asm/asm-tree/5.0.2/asm-tree-5.0.2.jar:/maven/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/maven/com/apple/AppleJavaExtensions/1.4/AppleJavaExtensions-1.4.jar:/maven/jaxen/jaxen/1.1.6/jaxen-1.1.6.jar:/maven/org/slf4j/slf4j-reload4j/1.7.36/slf4j-reload4j-1.7.36.jar:/maven/io/netty/netty/3.10.6.Final/netty-3.10.6.Final.jar:/maven/io/netty/netty-all/4.1.68.Final/netty-all-4.1.68.Final.jar:/maven/org/fusesource/leveldbjni/leveldbjni-all/1.8/leveldbjni-all-1.8.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.13.2.2/jackson-databind-2.13.2.2.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.13.2/jackson-core-2.13.2.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.3.3.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/maven/xerces/xercesImpl/2.12.1/xercesImpl-2.12.1.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.3.3 -->
  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. <method name="getHostAndPort" return="java.lang.String"
  55. abstract="false" native="false" synchronized="false"
  56. static="false" final="false" visibility="public"
  57. deprecated="not deprecated">
  58. <doc>
  59. <![CDATA[Get host and port of JournalNode.
  60. @return colon separated host and port.]]>
  61. </doc>
  62. </method>
  63. <method name="getClusterIds" return="java.util.List"
  64. abstract="false" native="false" synchronized="false"
  65. static="false" final="false" visibility="public"
  66. deprecated="not deprecated">
  67. <doc>
  68. <![CDATA[Get list of the clusters of JournalNode's journals
  69. as one JournalNode may support multiple clusters.
  70. @return list of clusters.]]>
  71. </doc>
  72. </method>
  73. <method name="getVersion" return="java.lang.String"
  74. abstract="false" native="false" synchronized="false"
  75. static="false" final="false" visibility="public"
  76. deprecated="not deprecated">
  77. <doc>
  78. <![CDATA[Gets the version of Hadoop.
  79. @return the version of Hadoop.]]>
  80. </doc>
  81. </method>
  82. <doc>
  83. <![CDATA[This is the JMX management interface for JournalNode information]]>
  84. </doc>
  85. </interface>
  86. <!-- end interface org.apache.hadoop.hdfs.qjournal.server.JournalNodeMXBean -->
  87. </package>
  88. <package name="org.apache.hadoop.hdfs.security.token.block">
  89. </package>
  90. <package name="org.apache.hadoop.hdfs.security.token.delegation">
  91. </package>
  92. <package name="org.apache.hadoop.hdfs.server.aliasmap">
  93. <!-- start class org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap -->
  94. <class name="InMemoryAliasMap" extends="java.lang.Object"
  95. abstract="false"
  96. static="false" final="false" visibility="public"
  97. deprecated="not deprecated">
  98. <implements name="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMapProtocol"/>
  99. <implements name="org.apache.hadoop.conf.Configurable"/>
  100. <method name="setConf"
  101. abstract="false" native="false" synchronized="false"
  102. static="false" final="false" visibility="public"
  103. deprecated="not deprecated">
  104. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  105. </method>
  106. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  107. abstract="false" native="false" synchronized="false"
  108. static="false" final="false" visibility="public"
  109. deprecated="not deprecated">
  110. </method>
  111. <method name="init" return="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap"
  112. abstract="false" native="false" synchronized="false"
  113. static="true" final="false" visibility="public"
  114. deprecated="not deprecated">
  115. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  116. <param name="blockPoolID" type="java.lang.String"/>
  117. <exception name="IOException" type="java.io.IOException"/>
  118. </method>
  119. <method name="list" return="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMapProtocol.IterationResult"
  120. abstract="false" native="false" synchronized="false"
  121. static="false" final="false" visibility="public"
  122. deprecated="not deprecated">
  123. <param name="marker" type="java.util.Optional"/>
  124. <exception name="IOException" type="java.io.IOException"/>
  125. </method>
  126. <method name="read" return="java.util.Optional"
  127. abstract="false" native="false" synchronized="false"
  128. static="false" final="false" visibility="public"
  129. deprecated="not deprecated">
  130. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  131. <exception name="IOException" type="java.io.IOException"/>
  132. </method>
  133. <method name="write"
  134. abstract="false" native="false" synchronized="false"
  135. static="false" final="false" visibility="public"
  136. deprecated="not deprecated">
  137. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  138. <param name="providedStorageLocation" type="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"/>
  139. <exception name="IOException" type="java.io.IOException"/>
  140. </method>
  141. <method name="getBlockPoolId" return="java.lang.String"
  142. abstract="false" native="false" synchronized="false"
  143. static="false" final="false" visibility="public"
  144. deprecated="not deprecated">
  145. </method>
  146. <method name="close"
  147. abstract="false" native="false" synchronized="false"
  148. static="false" final="false" visibility="public"
  149. deprecated="not deprecated">
  150. <exception name="IOException" type="java.io.IOException"/>
  151. </method>
  152. <method name="fromProvidedStorageLocationBytes" return="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  153. abstract="false" native="false" synchronized="false"
  154. static="true" final="false" visibility="public"
  155. deprecated="not deprecated">
  156. <param name="providedStorageLocationDbFormat" type="byte[]"/>
  157. <exception name="InvalidProtocolBufferException" type="org.apache.hadoop.thirdparty.protobuf.InvalidProtocolBufferException"/>
  158. </method>
  159. <method name="fromBlockBytes" return="org.apache.hadoop.hdfs.protocol.Block"
  160. abstract="false" native="false" synchronized="false"
  161. static="true" final="false" visibility="public"
  162. deprecated="not deprecated">
  163. <param name="blockDbFormat" type="byte[]"/>
  164. <exception name="InvalidProtocolBufferException" type="org.apache.hadoop.thirdparty.protobuf.InvalidProtocolBufferException"/>
  165. </method>
  166. <method name="toProtoBufBytes" return="byte[]"
  167. abstract="false" native="false" synchronized="false"
  168. static="true" final="false" visibility="public"
  169. deprecated="not deprecated">
  170. <param name="providedStorageLocation" type="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"/>
  171. <exception name="IOException" type="java.io.IOException"/>
  172. </method>
  173. <method name="toProtoBufBytes" return="byte[]"
  174. abstract="false" native="false" synchronized="false"
  175. static="true" final="false" visibility="public"
  176. deprecated="not deprecated">
  177. <param name="block" type="org.apache.hadoop.hdfs.protocol.Block"/>
  178. <exception name="IOException" type="java.io.IOException"/>
  179. </method>
  180. <method name="transferForBootstrap"
  181. abstract="false" native="false" synchronized="false"
  182. static="true" final="false" visibility="public"
  183. deprecated="not deprecated">
  184. <param name="response" type="javax.servlet.http.HttpServletResponse"/>
  185. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  186. <param name="aliasMap" type="org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap"/>
  187. <exception name="IOException" type="java.io.IOException"/>
  188. <doc>
  189. <![CDATA[Transfer this aliasmap for bootstrapping standby Namenodes. The map is
  190. transferred as a tar.gz archive. This archive needs to be extracted on the
  191. standby Namenode.
  192. @param response http response.
  193. @param conf configuration to use.
  194. @param aliasMap aliasmap to transfer.
  195. @throws IOException]]>
  196. </doc>
  197. </method>
  198. <method name="completeBootstrapTransfer"
  199. abstract="false" native="false" synchronized="false"
  200. static="true" final="false" visibility="public"
  201. deprecated="not deprecated">
  202. <param name="aliasMap" type="java.io.File"/>
  203. <exception name="IOException" type="java.io.IOException"/>
  204. <doc>
  205. <![CDATA[Extract the aliasmap archive to complete the bootstrap process. This method
  206. has to be called after the aliasmap archive is transfered from the primary
  207. Namenode.
  208. @param aliasMap location of the aliasmap.
  209. @throws IOException]]>
  210. </doc>
  211. </method>
  212. <doc>
  213. <![CDATA[InMemoryAliasMap is an implementation of the InMemoryAliasMapProtocol for
  214. use with LevelDB.]]>
  215. </doc>
  216. </class>
  217. <!-- end class org.apache.hadoop.hdfs.server.aliasmap.InMemoryAliasMap -->
  218. </package>
  219. <package name="org.apache.hadoop.hdfs.server.balancer">
  220. </package>
  221. <package name="org.apache.hadoop.hdfs.server.blockmanagement">
  222. </package>
  223. <package name="org.apache.hadoop.hdfs.server.common">
  224. <!-- start interface org.apache.hadoop.hdfs.server.common.BlockAlias -->
  225. <interface name="BlockAlias" abstract="true"
  226. static="false" final="false" visibility="public"
  227. deprecated="not deprecated">
  228. <method name="getBlock" return="org.apache.hadoop.hdfs.protocol.Block"
  229. abstract="true" native="false" synchronized="false"
  230. static="false" final="false" visibility="public"
  231. deprecated="not deprecated">
  232. </method>
  233. <doc>
  234. <![CDATA[Interface used to load provided blocks.]]>
  235. </doc>
  236. </interface>
  237. <!-- end interface org.apache.hadoop.hdfs.server.common.BlockAlias -->
  238. <!-- start class org.apache.hadoop.hdfs.server.common.FileRegion -->
  239. <class name="FileRegion" extends="java.lang.Object"
  240. abstract="false"
  241. static="false" final="false" visibility="public"
  242. deprecated="not deprecated">
  243. <implements name="org.apache.hadoop.hdfs.server.common.BlockAlias"/>
  244. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long, long"
  245. static="false" final="false" visibility="public"
  246. deprecated="not deprecated">
  247. </constructor>
  248. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long, long, byte[]"
  249. static="false" final="false" visibility="public"
  250. deprecated="not deprecated">
  251. </constructor>
  252. <constructor name="FileRegion" type="long, org.apache.hadoop.fs.Path, long, long"
  253. static="false" final="false" visibility="public"
  254. deprecated="not deprecated">
  255. </constructor>
  256. <constructor name="FileRegion" type="org.apache.hadoop.hdfs.protocol.Block, org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  257. static="false" final="false" visibility="public"
  258. deprecated="not deprecated">
  259. </constructor>
  260. <method name="getBlock" return="org.apache.hadoop.hdfs.protocol.Block"
  261. abstract="false" native="false" synchronized="false"
  262. static="false" final="false" visibility="public"
  263. deprecated="not deprecated">
  264. </method>
  265. <method name="getProvidedStorageLocation" return="org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation"
  266. abstract="false" native="false" synchronized="false"
  267. static="false" final="false" visibility="public"
  268. deprecated="not deprecated">
  269. </method>
  270. <method name="equals" return="boolean"
  271. abstract="false" native="false" synchronized="false"
  272. static="false" final="false" visibility="public"
  273. deprecated="not deprecated">
  274. <param name="o" type="java.lang.Object"/>
  275. </method>
  276. <method name="hashCode" return="int"
  277. abstract="false" native="false" synchronized="false"
  278. static="false" final="false" visibility="public"
  279. deprecated="not deprecated">
  280. </method>
  281. <doc>
  282. <![CDATA[This class is used to represent provided blocks that are file regions,
  283. i.e., can be described using (path, offset, length).]]>
  284. </doc>
  285. </class>
  286. <!-- end class org.apache.hadoop.hdfs.server.common.FileRegion -->
  287. </package>
  288. <package name="org.apache.hadoop.hdfs.server.common.blockaliasmap">
  289. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap -->
  290. <class name="BlockAliasMap" extends="java.lang.Object"
  291. abstract="true"
  292. static="false" final="false" visibility="public"
  293. deprecated="not deprecated">
  294. <constructor name="BlockAliasMap"
  295. static="false" final="false" visibility="public"
  296. deprecated="not deprecated">
  297. </constructor>
  298. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  299. abstract="true" native="false" synchronized="false"
  300. static="false" final="false" visibility="public"
  301. deprecated="not deprecated">
  302. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  303. <param name="blockPoolID" type="java.lang.String"/>
  304. <exception name="IOException" type="java.io.IOException"/>
  305. <doc>
  306. <![CDATA[Returns a reader to the alias map.
  307. @param opts reader options
  308. @param blockPoolID block pool id to use
  309. @return {@link Reader} to the alias map. If a Reader for the blockPoolID
  310. cannot be created, this will return null.
  311. @throws IOException]]>
  312. </doc>
  313. </method>
  314. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  315. abstract="true" native="false" synchronized="false"
  316. static="false" final="false" visibility="public"
  317. deprecated="not deprecated">
  318. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  319. <param name="blockPoolID" type="java.lang.String"/>
  320. <exception name="IOException" type="java.io.IOException"/>
  321. <doc>
  322. <![CDATA[Returns the writer for the alias map.
  323. @param opts writer options.
  324. @param blockPoolID block pool id to use
  325. @return {@link Writer} to the alias map.
  326. @throws IOException]]>
  327. </doc>
  328. </method>
  329. <method name="refresh"
  330. abstract="true" native="false" synchronized="false"
  331. static="false" final="false" visibility="public"
  332. deprecated="not deprecated">
  333. <exception name="IOException" type="java.io.IOException"/>
  334. <doc>
  335. <![CDATA[Refresh the alias map.
  336. @throws IOException]]>
  337. </doc>
  338. </method>
  339. <method name="close"
  340. abstract="true" native="false" synchronized="false"
  341. static="false" final="false" visibility="public"
  342. deprecated="not deprecated">
  343. <exception name="IOException" type="java.io.IOException"/>
  344. </method>
  345. <doc>
  346. <![CDATA[An abstract class used to read and write block maps for provided blocks.]]>
  347. </doc>
  348. </class>
  349. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap -->
  350. </package>
  351. <package name="org.apache.hadoop.hdfs.server.common.blockaliasmap.impl">
  352. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.LevelDBFileRegionAliasMap -->
  353. <class name="LevelDBFileRegionAliasMap" extends="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap"
  354. abstract="false"
  355. static="false" final="false" visibility="public"
  356. deprecated="not deprecated">
  357. <implements name="org.apache.hadoop.conf.Configurable"/>
  358. <constructor name="LevelDBFileRegionAliasMap"
  359. static="false" final="false" visibility="public"
  360. deprecated="not deprecated">
  361. </constructor>
  362. <method name="setConf"
  363. abstract="false" native="false" synchronized="false"
  364. static="false" final="false" visibility="public"
  365. deprecated="not deprecated">
  366. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  367. </method>
  368. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  369. abstract="false" native="false" synchronized="false"
  370. static="false" final="false" visibility="public"
  371. deprecated="not deprecated">
  372. </method>
  373. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  374. abstract="false" native="false" synchronized="false"
  375. static="false" final="false" visibility="public"
  376. deprecated="not deprecated">
  377. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  378. <param name="blockPoolID" type="java.lang.String"/>
  379. <exception name="IOException" type="java.io.IOException"/>
  380. </method>
  381. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  382. abstract="false" native="false" synchronized="false"
  383. static="false" final="false" visibility="public"
  384. deprecated="not deprecated">
  385. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  386. <param name="blockPoolID" type="java.lang.String"/>
  387. <exception name="IOException" type="java.io.IOException"/>
  388. </method>
  389. <method name="refresh"
  390. abstract="false" native="false" synchronized="false"
  391. static="false" final="false" visibility="public"
  392. deprecated="not deprecated">
  393. <exception name="IOException" type="java.io.IOException"/>
  394. </method>
  395. <method name="close"
  396. abstract="false" native="false" synchronized="false"
  397. static="false" final="false" visibility="public"
  398. deprecated="not deprecated">
  399. <exception name="IOException" type="java.io.IOException"/>
  400. </method>
  401. <field name="LOG" type="org.slf4j.Logger"
  402. transient="false" volatile="false"
  403. static="true" final="true" visibility="public"
  404. deprecated="not deprecated">
  405. </field>
  406. <doc>
  407. <![CDATA[A LevelDB based implementation of {@link BlockAliasMap}.]]>
  408. </doc>
  409. </class>
  410. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.LevelDBFileRegionAliasMap -->
  411. <!-- start class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.TextFileRegionAliasMap -->
  412. <class name="TextFileRegionAliasMap" extends="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap"
  413. abstract="false"
  414. static="false" final="false" visibility="public"
  415. deprecated="not deprecated">
  416. <implements name="org.apache.hadoop.conf.Configurable"/>
  417. <constructor name="TextFileRegionAliasMap"
  418. static="false" final="false" visibility="public"
  419. deprecated="not deprecated">
  420. </constructor>
  421. <method name="setConf"
  422. abstract="false" native="false" synchronized="false"
  423. static="false" final="false" visibility="public"
  424. deprecated="not deprecated">
  425. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  426. </method>
  427. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  428. abstract="false" native="false" synchronized="false"
  429. static="false" final="false" visibility="public"
  430. deprecated="not deprecated">
  431. </method>
  432. <method name="getReader" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader"
  433. abstract="false" native="false" synchronized="false"
  434. static="false" final="false" visibility="public"
  435. deprecated="not deprecated">
  436. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Reader.Options"/>
  437. <param name="blockPoolID" type="java.lang.String"/>
  438. <exception name="IOException" type="java.io.IOException"/>
  439. </method>
  440. <method name="getWriter" return="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer"
  441. abstract="false" native="false" synchronized="false"
  442. static="false" final="false" visibility="public"
  443. deprecated="not deprecated">
  444. <param name="opts" type="org.apache.hadoop.hdfs.server.common.blockaliasmap.BlockAliasMap.Writer.Options"/>
  445. <param name="blockPoolID" type="java.lang.String"/>
  446. <exception name="IOException" type="java.io.IOException"/>
  447. </method>
  448. <method name="refresh"
  449. abstract="false" native="false" synchronized="false"
  450. static="false" final="false" visibility="public"
  451. deprecated="not deprecated">
  452. <exception name="IOException" type="java.io.IOException"/>
  453. </method>
  454. <method name="close"
  455. abstract="false" native="false" synchronized="false"
  456. static="false" final="false" visibility="public"
  457. deprecated="not deprecated">
  458. <exception name="IOException" type="java.io.IOException"/>
  459. </method>
  460. <method name="blockPoolIDFromFileName" return="java.lang.String"
  461. abstract="false" native="false" synchronized="false"
  462. static="true" final="false" visibility="public"
  463. deprecated="not deprecated">
  464. <param name="file" type="org.apache.hadoop.fs.Path"/>
  465. </method>
  466. <method name="fileNameFromBlockPoolID" return="java.lang.String"
  467. abstract="false" native="false" synchronized="false"
  468. static="true" final="false" visibility="public"
  469. deprecated="not deprecated">
  470. <param name="blockPoolID" type="java.lang.String"/>
  471. </method>
  472. <field name="LOG" type="org.slf4j.Logger"
  473. transient="false" volatile="false"
  474. static="true" final="true" visibility="public"
  475. deprecated="not deprecated">
  476. </field>
  477. <doc>
  478. <![CDATA[This class is used for block maps stored as text files,
  479. with a specified delimiter.]]>
  480. </doc>
  481. </class>
  482. <!-- end class org.apache.hadoop.hdfs.server.common.blockaliasmap.impl.TextFileRegionAliasMap -->
  483. </package>
  484. <package name="org.apache.hadoop.hdfs.server.datanode">
  485. </package>
  486. <package name="org.apache.hadoop.hdfs.server.datanode.fsdataset">
  487. </package>
  488. <package name="org.apache.hadoop.hdfs.server.datanode.fsdataset.impl">
  489. </package>
  490. <package name="org.apache.hadoop.hdfs.server.datanode.metrics">
  491. </package>
  492. <package name="org.apache.hadoop.hdfs.server.datanode.web">
  493. </package>
  494. <package name="org.apache.hadoop.hdfs.server.datanode.web.webhdfs">
  495. </package>
  496. <package name="org.apache.hadoop.hdfs.server.diskbalancer">
  497. </package>
  498. <package name="org.apache.hadoop.hdfs.server.diskbalancer.command">
  499. </package>
  500. <package name="org.apache.hadoop.hdfs.server.diskbalancer.connectors">
  501. </package>
  502. <package name="org.apache.hadoop.hdfs.server.diskbalancer.datamodel">
  503. </package>
  504. <package name="org.apache.hadoop.hdfs.server.diskbalancer.planner">
  505. </package>
  506. <package name="org.apache.hadoop.hdfs.server.mover">
  507. </package>
  508. <package name="org.apache.hadoop.hdfs.server.namenode">
  509. <!-- start interface org.apache.hadoop.hdfs.server.namenode.AuditLogger -->
  510. <interface name="AuditLogger" abstract="true"
  511. static="false" final="false" visibility="public"
  512. deprecated="not deprecated">
  513. <method name="initialize"
  514. abstract="true" native="false" synchronized="false"
  515. static="false" final="false" visibility="public"
  516. deprecated="not deprecated">
  517. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  518. <doc>
  519. <![CDATA[Called during initialization of the logger.
  520. @param conf The configuration object.]]>
  521. </doc>
  522. </method>
  523. <method name="logAuditEvent"
  524. abstract="true" native="false" synchronized="false"
  525. static="false" final="false" visibility="public"
  526. deprecated="not deprecated">
  527. <param name="succeeded" type="boolean"/>
  528. <param name="userName" type="java.lang.String"/>
  529. <param name="addr" type="java.net.InetAddress"/>
  530. <param name="cmd" type="java.lang.String"/>
  531. <param name="src" type="java.lang.String"/>
  532. <param name="dst" type="java.lang.String"/>
  533. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  534. <doc>
  535. <![CDATA[Called to log an audit event.
  536. <p>
  537. This method must return as quickly as possible, since it's called
  538. in a critical section of the NameNode's operation.
  539. @param succeeded Whether authorization succeeded.
  540. @param userName Name of the user executing the request.
  541. @param addr Remote address of the request.
  542. @param cmd The requested command.
  543. @param src Path of affected source file.
  544. @param dst Path of affected destination file (if any).
  545. @param stat File information for operations that change the file's
  546. metadata (permissions, owner, times, etc).]]>
  547. </doc>
  548. </method>
  549. <doc>
  550. <![CDATA[Interface defining an audit logger.]]>
  551. </doc>
  552. </interface>
  553. <!-- end interface org.apache.hadoop.hdfs.server.namenode.AuditLogger -->
  554. <!-- start class org.apache.hadoop.hdfs.server.namenode.DefaultAuditLogger -->
  555. <class name="DefaultAuditLogger" extends="org.apache.hadoop.hdfs.server.namenode.HdfsAuditLogger"
  556. abstract="true"
  557. static="false" final="false" visibility="public"
  558. deprecated="not deprecated">
  559. <constructor name="DefaultAuditLogger"
  560. static="false" final="false" visibility="public"
  561. deprecated="not deprecated">
  562. </constructor>
  563. <method name="initialize"
  564. abstract="true" native="false" synchronized="false"
  565. static="false" final="false" visibility="public"
  566. deprecated="not deprecated">
  567. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  568. </method>
  569. <method name="logAuditMessage"
  570. abstract="true" native="false" synchronized="false"
  571. static="false" final="false" visibility="public"
  572. deprecated="not deprecated">
  573. <param name="message" type="java.lang.String"/>
  574. </method>
  575. <method name="logAuditEvent"
  576. abstract="true" native="false" synchronized="false"
  577. static="false" final="false" visibility="public"
  578. deprecated="not deprecated">
  579. <param name="succeeded" type="boolean"/>
  580. <param name="userName" type="java.lang.String"/>
  581. <param name="addr" type="java.net.InetAddress"/>
  582. <param name="cmd" type="java.lang.String"/>
  583. <param name="src" type="java.lang.String"/>
  584. <param name="dst" type="java.lang.String"/>
  585. <param name="status" type="org.apache.hadoop.fs.FileStatus"/>
  586. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  587. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  588. </method>
  589. <method name="logAuditEvent"
  590. abstract="true" native="false" synchronized="false"
  591. static="false" final="false" visibility="public"
  592. deprecated="not deprecated">
  593. <param name="succeeded" type="boolean"/>
  594. <param name="userName" type="java.lang.String"/>
  595. <param name="addr" type="java.net.InetAddress"/>
  596. <param name="cmd" type="java.lang.String"/>
  597. <param name="src" type="java.lang.String"/>
  598. <param name="dst" type="java.lang.String"/>
  599. <param name="status" type="org.apache.hadoop.fs.FileStatus"/>
  600. <param name="callerContext" type="org.apache.hadoop.ipc.CallerContext"/>
  601. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  602. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  603. </method>
  604. <field name="STRING_BUILDER" type="java.lang.ThreadLocal"
  605. transient="false" volatile="false"
  606. static="true" final="true" visibility="protected"
  607. deprecated="not deprecated">
  608. </field>
  609. <field name="isCallerContextEnabled" type="boolean"
  610. transient="false" volatile="true"
  611. static="false" final="false" visibility="protected"
  612. deprecated="not deprecated">
  613. </field>
  614. <field name="callerContextMaxLen" type="int"
  615. transient="false" volatile="false"
  616. static="false" final="false" visibility="protected"
  617. deprecated="not deprecated">
  618. <doc>
  619. <![CDATA[The maximum bytes a caller context string can have.]]>
  620. </doc>
  621. </field>
  622. <field name="callerSignatureMaxLen" type="int"
  623. transient="false" volatile="false"
  624. static="false" final="false" visibility="protected"
  625. deprecated="not deprecated">
  626. </field>
  627. <field name="logTokenTrackingId" type="boolean"
  628. transient="false" volatile="false"
  629. static="false" final="false" visibility="protected"
  630. deprecated="not deprecated">
  631. <doc>
  632. <![CDATA[adds a tracking ID for all audit log events.]]>
  633. </doc>
  634. </field>
  635. <field name="debugCmdSet" type="java.util.Set"
  636. transient="false" volatile="false"
  637. static="false" final="false" visibility="protected"
  638. deprecated="not deprecated">
  639. <doc>
  640. <![CDATA[List of commands to provide debug messages.]]>
  641. </doc>
  642. </field>
  643. <doc>
  644. <![CDATA[This class provides an interface for Namenode and Router to Audit events
  645. information. This class can be extended and can be used when no access logger
  646. is defined in the config file.]]>
  647. </doc>
  648. </class>
  649. <!-- end class org.apache.hadoop.hdfs.server.namenode.DefaultAuditLogger -->
  650. <!-- start class org.apache.hadoop.hdfs.server.namenode.HdfsAuditLogger -->
  651. <class name="HdfsAuditLogger" extends="java.lang.Object"
  652. abstract="true"
  653. static="false" final="false" visibility="public"
  654. deprecated="not deprecated">
  655. <implements name="org.apache.hadoop.hdfs.server.namenode.AuditLogger"/>
  656. <constructor name="HdfsAuditLogger"
  657. static="false" final="false" visibility="public"
  658. deprecated="not deprecated">
  659. </constructor>
  660. <method name="logAuditEvent"
  661. abstract="false" native="false" synchronized="false"
  662. static="false" final="false" visibility="public"
  663. deprecated="not deprecated">
  664. <param name="succeeded" type="boolean"/>
  665. <param name="userName" type="java.lang.String"/>
  666. <param name="addr" type="java.net.InetAddress"/>
  667. <param name="cmd" type="java.lang.String"/>
  668. <param name="src" type="java.lang.String"/>
  669. <param name="dst" type="java.lang.String"/>
  670. <param name="status" type="org.apache.hadoop.fs.FileStatus"/>
  671. </method>
  672. <method name="logAuditEvent"
  673. abstract="true" native="false" synchronized="false"
  674. static="false" final="false" visibility="public"
  675. deprecated="not deprecated">
  676. <param name="succeeded" type="boolean"/>
  677. <param name="userName" type="java.lang.String"/>
  678. <param name="addr" type="java.net.InetAddress"/>
  679. <param name="cmd" type="java.lang.String"/>
  680. <param name="src" type="java.lang.String"/>
  681. <param name="dst" type="java.lang.String"/>
  682. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  683. <param name="callerContext" type="org.apache.hadoop.ipc.CallerContext"/>
  684. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  685. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  686. <doc>
  687. <![CDATA[Same as
  688. {@link #logAuditEvent(boolean, String, InetAddress, String, String, String,
  689. FileStatus)} with additional parameters related to logging delegation token
  690. tracking IDs.
  691. @param succeeded Whether authorization succeeded.
  692. @param userName Name of the user executing the request.
  693. @param addr Remote address of the request.
  694. @param cmd The requested command.
  695. @param src Path of affected source file.
  696. @param dst Path of affected destination file (if any).
  697. @param stat File information for operations that change the file's metadata
  698. (permissions, owner, times, etc).
  699. @param callerContext Context information of the caller
  700. @param ugi UserGroupInformation of the current user, or null if not logging
  701. token tracking information
  702. @param dtSecretManager The token secret manager, or null if not logging
  703. token tracking information]]>
  704. </doc>
  705. </method>
  706. <method name="logAuditEvent"
  707. abstract="true" native="false" synchronized="false"
  708. static="false" final="false" visibility="public"
  709. deprecated="not deprecated">
  710. <param name="succeeded" type="boolean"/>
  711. <param name="userName" type="java.lang.String"/>
  712. <param name="addr" type="java.net.InetAddress"/>
  713. <param name="cmd" type="java.lang.String"/>
  714. <param name="src" type="java.lang.String"/>
  715. <param name="dst" type="java.lang.String"/>
  716. <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
  717. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  718. <param name="dtSecretManager" type="org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenSecretManager"/>
  719. <doc>
  720. <![CDATA[Same as
  721. {@link #logAuditEvent(boolean, String, InetAddress, String, String,
  722. String, FileStatus, CallerContext, UserGroupInformation,
  723. DelegationTokenSecretManager)} without {@link CallerContext} information.]]>
  724. </doc>
  725. </method>
  726. <doc>
  727. <![CDATA[Extension of {@link AuditLogger}.]]>
  728. </doc>
  729. </class>
  730. <!-- end class org.apache.hadoop.hdfs.server.namenode.HdfsAuditLogger -->
  731. <!-- start class org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider -->
  732. <class name="INodeAttributeProvider" extends="java.lang.Object"
  733. abstract="true"
  734. static="false" final="false" visibility="public"
  735. deprecated="not deprecated">
  736. <constructor name="INodeAttributeProvider"
  737. static="false" final="false" visibility="public"
  738. deprecated="not deprecated">
  739. </constructor>
  740. <method name="start"
  741. abstract="true" native="false" synchronized="false"
  742. static="false" final="false" visibility="public"
  743. deprecated="not deprecated">
  744. <doc>
  745. <![CDATA[Initialize the provider. This method is called at NameNode startup
  746. time.]]>
  747. </doc>
  748. </method>
  749. <method name="stop"
  750. abstract="true" native="false" synchronized="false"
  751. static="false" final="false" visibility="public"
  752. deprecated="not deprecated">
  753. <doc>
  754. <![CDATA[Shutdown the provider. This method is called at NameNode shutdown time.]]>
  755. </doc>
  756. </method>
  757. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  758. abstract="false" native="false" synchronized="false"
  759. static="false" final="false" visibility="public"
  760. deprecated="not deprecated">
  761. <param name="fullPath" type="java.lang.String"/>
  762. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  763. </method>
  764. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  765. abstract="true" native="false" synchronized="false"
  766. static="false" final="false" visibility="public"
  767. deprecated="not deprecated">
  768. <param name="pathElements" type="java.lang.String[]"/>
  769. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  770. </method>
  771. <method name="getAttributes" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"
  772. abstract="false" native="false" synchronized="false"
  773. static="false" final="false" visibility="public"
  774. deprecated="not deprecated">
  775. <param name="components" type="byte[][]"/>
  776. <param name="inode" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributes"/>
  777. </method>
  778. <method name="getExternalAccessControlEnforcer" return="org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AccessControlEnforcer"
  779. abstract="false" native="false" synchronized="false"
  780. static="false" final="false" visibility="public"
  781. deprecated="not deprecated">
  782. <param name="defaultEnforcer" type="org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AccessControlEnforcer"/>
  783. <doc>
  784. <![CDATA[Can be over-ridden by implementations to provide a custom Access Control
  785. Enforcer that can provide an alternate implementation of the
  786. default permission checking logic.
  787. @param defaultEnforcer The Default AccessControlEnforcer
  788. @return The AccessControlEnforcer to use]]>
  789. </doc>
  790. </method>
  791. </class>
  792. <!-- end class org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider -->
  793. </package>
  794. <package name="org.apache.hadoop.hdfs.server.namenode.ha">
  795. </package>
  796. <package name="org.apache.hadoop.hdfs.server.namenode.metrics">
  797. </package>
  798. <package name="org.apache.hadoop.hdfs.server.namenode.snapshot">
  799. </package>
  800. <package name="org.apache.hadoop.hdfs.server.namenode.top">
  801. </package>
  802. <package name="org.apache.hadoop.hdfs.server.namenode.top.metrics">
  803. </package>
  804. <package name="org.apache.hadoop.hdfs.server.namenode.top.window">
  805. </package>
  806. <package name="org.apache.hadoop.hdfs.server.namenode.web.resources">
  807. </package>
  808. <package name="org.apache.hadoop.hdfs.tools">
  809. </package>
  810. <package name="org.apache.hadoop.hdfs.tools.offlineEditsViewer">
  811. </package>
  812. <package name="org.apache.hadoop.hdfs.tools.offlineImageViewer">
  813. </package>
  814. <package name="org.apache.hadoop.hdfs.tools.snapshot">
  815. </package>
  816. <package name="org.apache.hadoop.hdfs.util">
  817. </package>
  818. <package name="org.apache.hadoop.hdfs.web">
  819. </package>
  820. <package name="org.apache.hadoop.hdfs.web.resources">
  821. </package>
  822. </api>