Apache_Hadoop_YARN_Common_2.8.3.xml 121 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665
  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 Dec 05 05:29:28 UTC 2017 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN Common 2.8.3"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -verbose -classpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/classes:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-2.8.3.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/maven/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/maven/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/maven/commons-net/commons-net/3.1/commons-net-3.1.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/maven/org/mortbay/jetty/jetty-sslengine/6.1.26/jetty-sslengine-6.1.26.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/maven/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/maven/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/maven/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/maven/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/maven/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/maven/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/maven/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/maven/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.8.3.jar:/maven/com/nimbusds/nimbus-jose-jwt/3.9/nimbus-jose-jwt-3.9.jar:/maven/net/jcip/jcip-annotations/1.0/jcip-annotations-1.0.jar:/maven/net/minidev/json-smart/1.1.1/json-smart-1.1.1.jar:/maven/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/maven/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/maven/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/maven/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/maven/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/maven/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/maven/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/maven/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/maven/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/maven/org/apache/htrace/htrace-core4/4.0.1-incubating/htrace-core4-4.0.1-incubating.jar:/maven/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/maven/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-yarn-api-2.8.3.jar:/maven/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/maven/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/maven/javax/activation/activation/1.1/activation-1.1.jar:/maven/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/maven/org/tukaani/xz/1.0/xz-1.0.jar:/maven/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/maven/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/maven/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/maven/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/maven/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/maven/com/sun/jersey/jersey-client/1.9/jersey-client-1.9.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/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.8.3.jar:/usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar:/maven/com/google/inject/extensions/guice-servlet/3.0/guice-servlet-3.0.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/commons-io/commons-io/2.4/commons-io-2.4.jar:/maven/com/google/inject/guice/3.0/guice-3.0.jar:/maven/javax/inject/javax.inject/1/javax.inject-1.jar:/maven/aopalliance/aopalliance/1.0/aopalliance-1.0.jar:/maven/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/maven/asm/asm/3.2/asm-3.2.jar:/maven/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.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/com/sun/jersey/contribs/jersey-guice/1.9/jersey-guice-1.9.jar:/maven/log4j/log4j/1.2.17/log4j-1.2.17.jar -sourcepath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java -apidir /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/site/jdiff/xml -apiname Apache Hadoop YARN Common 2.8.3 -->
  11. <package name="org.apache.hadoop.yarn">
  12. <!-- start class org.apache.hadoop.yarn.ContainerLogAppender -->
  13. <class name="ContainerLogAppender" extends="org.apache.log4j.FileAppender"
  14. abstract="false"
  15. static="false" final="false" visibility="public"
  16. deprecated="not deprecated">
  17. <implements name="java.io.Flushable"/>
  18. <constructor name="ContainerLogAppender"
  19. static="false" final="false" visibility="public"
  20. deprecated="not deprecated">
  21. </constructor>
  22. <method name="activateOptions"
  23. abstract="false" native="false" synchronized="false"
  24. static="false" final="false" visibility="public"
  25. deprecated="not deprecated">
  26. </method>
  27. <method name="append"
  28. abstract="false" native="false" synchronized="false"
  29. static="false" final="false" visibility="public"
  30. deprecated="not deprecated">
  31. <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
  32. </method>
  33. <method name="flush"
  34. abstract="false" native="false" synchronized="false"
  35. static="false" final="false" visibility="public"
  36. deprecated="not deprecated">
  37. </method>
  38. <method name="close"
  39. abstract="false" native="false" synchronized="true"
  40. static="false" final="false" visibility="public"
  41. deprecated="not deprecated">
  42. </method>
  43. <method name="getContainerLogDir" return="java.lang.String"
  44. abstract="false" native="false" synchronized="false"
  45. static="false" final="false" visibility="public"
  46. deprecated="not deprecated">
  47. <doc>
  48. <![CDATA[Getter/Setter methods for log4j.]]>
  49. </doc>
  50. </method>
  51. <method name="setContainerLogDir"
  52. abstract="false" native="false" synchronized="false"
  53. static="false" final="false" visibility="public"
  54. deprecated="not deprecated">
  55. <param name="containerLogDir" type="java.lang.String"/>
  56. </method>
  57. <method name="getContainerLogFile" return="java.lang.String"
  58. abstract="false" native="false" synchronized="false"
  59. static="false" final="false" visibility="public"
  60. deprecated="not deprecated">
  61. </method>
  62. <method name="setContainerLogFile"
  63. abstract="false" native="false" synchronized="false"
  64. static="false" final="false" visibility="public"
  65. deprecated="not deprecated">
  66. <param name="containerLogFile" type="java.lang.String"/>
  67. </method>
  68. <method name="getTotalLogFileSize" return="long"
  69. abstract="false" native="false" synchronized="false"
  70. static="false" final="false" visibility="public"
  71. deprecated="not deprecated">
  72. </method>
  73. <method name="setTotalLogFileSize"
  74. abstract="false" native="false" synchronized="false"
  75. static="false" final="false" visibility="public"
  76. deprecated="not deprecated">
  77. <param name="logSize" type="long"/>
  78. </method>
  79. <doc>
  80. <![CDATA[A simple log4j-appender for container's logs.]]>
  81. </doc>
  82. </class>
  83. <!-- end class org.apache.hadoop.yarn.ContainerLogAppender -->
  84. <!-- start class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  85. <class name="ContainerRollingLogAppender" extends="org.apache.log4j.RollingFileAppender"
  86. abstract="false"
  87. static="false" final="false" visibility="public"
  88. deprecated="not deprecated">
  89. <implements name="java.io.Flushable"/>
  90. <constructor name="ContainerRollingLogAppender"
  91. static="false" final="false" visibility="public"
  92. deprecated="not deprecated">
  93. </constructor>
  94. <method name="activateOptions"
  95. abstract="false" native="false" synchronized="false"
  96. static="false" final="false" visibility="public"
  97. deprecated="not deprecated">
  98. </method>
  99. <method name="flush"
  100. abstract="false" native="false" synchronized="false"
  101. static="false" final="false" visibility="public"
  102. deprecated="not deprecated">
  103. </method>
  104. <method name="getContainerLogDir" return="java.lang.String"
  105. abstract="false" native="false" synchronized="false"
  106. static="false" final="false" visibility="public"
  107. deprecated="not deprecated">
  108. <doc>
  109. <![CDATA[Getter/Setter methods for log4j.]]>
  110. </doc>
  111. </method>
  112. <method name="setContainerLogDir"
  113. abstract="false" native="false" synchronized="false"
  114. static="false" final="false" visibility="public"
  115. deprecated="not deprecated">
  116. <param name="containerLogDir" type="java.lang.String"/>
  117. </method>
  118. <method name="getContainerLogFile" return="java.lang.String"
  119. abstract="false" native="false" synchronized="false"
  120. static="false" final="false" visibility="public"
  121. deprecated="not deprecated">
  122. </method>
  123. <method name="setContainerLogFile"
  124. abstract="false" native="false" synchronized="false"
  125. static="false" final="false" visibility="public"
  126. deprecated="not deprecated">
  127. <param name="containerLogFile" type="java.lang.String"/>
  128. </method>
  129. <doc>
  130. <![CDATA[A simple log4j-appender for container's logs.]]>
  131. </doc>
  132. </class>
  133. <!-- end class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  134. <!-- start class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  135. <class name="YarnUncaughtExceptionHandler" extends="java.lang.Object"
  136. abstract="false"
  137. static="false" final="false" visibility="public"
  138. deprecated="not deprecated">
  139. <implements name="java.lang.Thread.UncaughtExceptionHandler"/>
  140. <constructor name="YarnUncaughtExceptionHandler"
  141. static="false" final="false" visibility="public"
  142. deprecated="not deprecated">
  143. </constructor>
  144. <method name="uncaughtException"
  145. abstract="false" native="false" synchronized="false"
  146. static="false" final="false" visibility="public"
  147. deprecated="not deprecated">
  148. <param name="t" type="java.lang.Thread"/>
  149. <param name="e" type="java.lang.Throwable"/>
  150. </method>
  151. <doc>
  152. <![CDATA[This class is intended to be installed by calling
  153. {@link Thread#setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)}
  154. In the main entry point. It is intended to try and cleanly shut down
  155. programs using the Yarn Event framework.
  156. Note: Right now it only will shut down the program if a Error is caught, but
  157. not any other exception. Anything else is just logged.]]>
  158. </doc>
  159. </class>
  160. <!-- end class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  161. </package>
  162. <package name="org.apache.hadoop.yarn.api">
  163. </package>
  164. <package name="org.apache.hadoop.yarn.client">
  165. <!-- start class org.apache.hadoop.yarn.client.AHSProxy -->
  166. <class name="AHSProxy" extends="java.lang.Object"
  167. abstract="false"
  168. static="false" final="false" visibility="public"
  169. deprecated="not deprecated">
  170. <constructor name="AHSProxy"
  171. static="false" final="false" visibility="public"
  172. deprecated="not deprecated">
  173. </constructor>
  174. <method name="createAHSProxy" return="T"
  175. abstract="false" native="false" synchronized="false"
  176. static="true" final="false" visibility="public"
  177. deprecated="not deprecated">
  178. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  179. <param name="protocol" type="java.lang.Class"/>
  180. <param name="ahsAddress" type="java.net.InetSocketAddress"/>
  181. <exception name="IOException" type="java.io.IOException"/>
  182. </method>
  183. <method name="getProxy" return="T"
  184. abstract="false" native="false" synchronized="false"
  185. static="true" final="false" visibility="protected"
  186. deprecated="not deprecated">
  187. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  188. <param name="protocol" type="java.lang.Class"/>
  189. <param name="rmAddress" type="java.net.InetSocketAddress"/>
  190. <exception name="IOException" type="java.io.IOException"/>
  191. </method>
  192. </class>
  193. <!-- end class org.apache.hadoop.yarn.client.AHSProxy -->
  194. <!-- start class org.apache.hadoop.yarn.client.ClientRMProxy -->
  195. <class name="ClientRMProxy" extends="org.apache.hadoop.yarn.client.RMProxy"
  196. abstract="false"
  197. static="false" final="false" visibility="public"
  198. deprecated="not deprecated">
  199. <method name="createRMProxy" return="T"
  200. abstract="false" native="false" synchronized="false"
  201. static="true" final="false" visibility="public"
  202. deprecated="not deprecated">
  203. <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
  204. <param name="protocol" type="java.lang.Class"/>
  205. <exception name="IOException" type="java.io.IOException"/>
  206. <doc>
  207. <![CDATA[Create a proxy to the ResourceManager for the specified protocol.
  208. @param configuration Configuration with all the required information.
  209. @param protocol Client protocol for which proxy is being requested.
  210. @param <T> Type of proxy.
  211. @return Proxy to the ResourceManager for the specified client protocol.
  212. @throws IOException]]>
  213. </doc>
  214. </method>
  215. <method name="getRMDelegationTokenService" return="org.apache.hadoop.io.Text"
  216. abstract="false" native="false" synchronized="false"
  217. static="true" final="false" visibility="public"
  218. deprecated="not deprecated">
  219. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  220. <doc>
  221. <![CDATA[Get the token service name to be used for RMDelegationToken. Depending
  222. on whether HA is enabled or not, this method generates the appropriate
  223. service name as a comma-separated list of service addresses.
  224. @param conf Configuration corresponding to the cluster we need the
  225. RMDelegationToken for
  226. @return - Service name for RMDelegationToken]]>
  227. </doc>
  228. </method>
  229. <method name="getAMRMTokenService" return="org.apache.hadoop.io.Text"
  230. abstract="false" native="false" synchronized="false"
  231. static="true" final="false" visibility="public"
  232. deprecated="not deprecated">
  233. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  234. </method>
  235. <method name="getTokenService" return="org.apache.hadoop.io.Text"
  236. abstract="false" native="false" synchronized="false"
  237. static="true" final="false" visibility="public"
  238. deprecated="not deprecated">
  239. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  240. <param name="address" type="java.lang.String"/>
  241. <param name="defaultAddr" type="java.lang.String"/>
  242. <param name="defaultPort" type="int"/>
  243. </method>
  244. </class>
  245. <!-- end class org.apache.hadoop.yarn.client.ClientRMProxy -->
  246. <!-- start class org.apache.hadoop.yarn.client.NMProxy -->
  247. <class name="NMProxy" extends="org.apache.hadoop.yarn.client.ServerProxy"
  248. abstract="false"
  249. static="false" final="false" visibility="public"
  250. deprecated="not deprecated">
  251. <constructor name="NMProxy"
  252. static="false" final="false" visibility="public"
  253. deprecated="not deprecated">
  254. </constructor>
  255. <method name="createNMProxy" return="T"
  256. abstract="false" native="false" synchronized="false"
  257. static="true" final="false" visibility="public"
  258. deprecated="not deprecated">
  259. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  260. <param name="protocol" type="java.lang.Class"/>
  261. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  262. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  263. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  264. </method>
  265. </class>
  266. <!-- end class org.apache.hadoop.yarn.client.NMProxy -->
  267. <!-- start class org.apache.hadoop.yarn.client.RMProxy -->
  268. <class name="RMProxy" extends="java.lang.Object"
  269. abstract="false"
  270. static="false" final="false" visibility="public"
  271. deprecated="not deprecated">
  272. <constructor name="RMProxy"
  273. static="false" final="false" visibility="protected"
  274. deprecated="not deprecated">
  275. </constructor>
  276. <method name="createRMProxy" return="T"
  277. abstract="false" native="false" synchronized="false"
  278. static="true" final="false" visibility="public"
  279. deprecated="This method is deprecated and is not used by YARN internally any more.
  280. To create a proxy to the RM, use ClientRMProxy#createRMProxy or
  281. ServerRMProxy#createRMProxy.
  282. Create a proxy to the ResourceManager at the specified address.">
  283. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  284. <param name="protocol" type="java.lang.Class"/>
  285. <param name="rmAddress" type="java.net.InetSocketAddress"/>
  286. <exception name="IOException" type="java.io.IOException"/>
  287. <doc>
  288. <![CDATA[@deprecated
  289. This method is deprecated and is not used by YARN internally any more.
  290. To create a proxy to the RM, use ClientRMProxy#createRMProxy or
  291. ServerRMProxy#createRMProxy.
  292. Create a proxy to the ResourceManager at the specified address.
  293. @param conf Configuration to generate retry policy
  294. @param protocol Protocol for the proxy
  295. @param rmAddress Address of the ResourceManager
  296. @param <T> Type information of the proxy
  297. @return Proxy to the RM
  298. @throws IOException]]>
  299. </doc>
  300. </method>
  301. </class>
  302. <!-- end class org.apache.hadoop.yarn.client.RMProxy -->
  303. <!-- start class org.apache.hadoop.yarn.client.ServerProxy -->
  304. <class name="ServerProxy" extends="java.lang.Object"
  305. abstract="false"
  306. static="false" final="false" visibility="public"
  307. deprecated="not deprecated">
  308. <constructor name="ServerProxy"
  309. static="false" final="false" visibility="public"
  310. deprecated="not deprecated">
  311. </constructor>
  312. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  313. abstract="false" native="false" synchronized="false"
  314. static="true" final="false" visibility="protected"
  315. deprecated="not deprecated">
  316. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  317. <param name="maxWaitTimeStr" type="java.lang.String"/>
  318. <param name="defMaxWaitTime" type="long"/>
  319. <param name="connectRetryIntervalStr" type="java.lang.String"/>
  320. <param name="defRetryInterval" type="long"/>
  321. </method>
  322. <method name="createRetriableProxy" return="T"
  323. abstract="false" native="false" synchronized="false"
  324. static="true" final="false" visibility="protected"
  325. deprecated="not deprecated">
  326. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  327. <param name="protocol" type="java.lang.Class"/>
  328. <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
  329. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  330. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  331. <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
  332. </method>
  333. </class>
  334. <!-- end class org.apache.hadoop.yarn.client.ServerProxy -->
  335. </package>
  336. <package name="org.apache.hadoop.yarn.client.api">
  337. <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
  338. <class name="TimelineClient" extends="org.apache.hadoop.service.AbstractService"
  339. abstract="true"
  340. static="false" final="false" visibility="public"
  341. deprecated="not deprecated">
  342. <implements name="java.io.Flushable"/>
  343. <constructor name="TimelineClient" type="java.lang.String"
  344. static="false" final="false" visibility="protected"
  345. deprecated="not deprecated">
  346. </constructor>
  347. <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
  348. abstract="false" native="false" synchronized="false"
  349. static="true" final="false" visibility="public"
  350. deprecated="not deprecated">
  351. <doc>
  352. <![CDATA[Create a timeline client. The current UGI when the user initialize the
  353. client will be used to do the put and the delegation token operations. The
  354. current user may use {@link UserGroupInformation#doAs} another user to
  355. construct and initialize a timeline client if the following operations are
  356. supposed to be conducted by that user.
  357. @return a timeline client]]>
  358. </doc>
  359. </method>
  360. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  361. abstract="true" native="false" synchronized="false"
  362. static="false" final="false" visibility="public"
  363. deprecated="not deprecated">
  364. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  365. <exception name="IOException" type="java.io.IOException"/>
  366. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  367. <doc>
  368. <![CDATA[<p>
  369. Send the information of a number of conceptual entities to the timeline
  370. server. It is a blocking API. The method will not return until it gets the
  371. response from the timeline server.
  372. </p>
  373. @param entities
  374. the collection of {@link TimelineEntity}
  375. @return the error information if the sent entities are not correctly stored
  376. @throws IOException
  377. @throws YarnException]]>
  378. </doc>
  379. </method>
  380. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  381. abstract="true" native="false" synchronized="false"
  382. static="false" final="false" visibility="public"
  383. deprecated="not deprecated">
  384. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  385. <param name="groupId" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  386. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  387. <exception name="IOException" type="java.io.IOException"/>
  388. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  389. <doc>
  390. <![CDATA[<p>
  391. Send the information of a number of conceptual entities to the timeline
  392. server. It is a blocking API. The method will not return until it gets the
  393. response from the timeline server.
  394. This API is only for timeline service v1.5
  395. </p>
  396. @param appAttemptId {@link ApplicationAttemptId}
  397. @param groupId {@link TimelineEntityGroupId}
  398. @param entities
  399. the collection of {@link TimelineEntity}
  400. @return the error information if the sent entities are not correctly stored
  401. @throws IOException
  402. @throws YarnException]]>
  403. </doc>
  404. </method>
  405. <method name="putDomain"
  406. abstract="true" native="false" synchronized="false"
  407. static="false" final="false" visibility="public"
  408. deprecated="not deprecated">
  409. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  410. <exception name="IOException" type="java.io.IOException"/>
  411. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  412. <doc>
  413. <![CDATA[<p>
  414. Send the information of a domain to the timeline server. It is a
  415. blocking API. The method will not return until it gets the response from
  416. the timeline server.
  417. </p>
  418. @param domain
  419. an {@link TimelineDomain} object
  420. @throws IOException
  421. @throws YarnException]]>
  422. </doc>
  423. </method>
  424. <method name="putDomain"
  425. abstract="true" native="false" synchronized="false"
  426. static="false" final="false" visibility="public"
  427. deprecated="not deprecated">
  428. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  429. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  430. <exception name="IOException" type="java.io.IOException"/>
  431. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  432. <doc>
  433. <![CDATA[<p>
  434. Send the information of a domain to the timeline server. It is a
  435. blocking API. The method will not return until it gets the response from
  436. the timeline server.
  437. This API is only for timeline service v1.5
  438. </p>
  439. @param domain
  440. an {@link TimelineDomain} object
  441. @param appAttemptId {@link ApplicationAttemptId}
  442. @throws IOException
  443. @throws YarnException]]>
  444. </doc>
  445. </method>
  446. <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
  447. abstract="true" native="false" synchronized="false"
  448. static="false" final="false" visibility="public"
  449. deprecated="not deprecated">
  450. <param name="renewer" type="java.lang.String"/>
  451. <exception name="IOException" type="java.io.IOException"/>
  452. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  453. <doc>
  454. <![CDATA[<p>
  455. Get a delegation token so as to be able to talk to the timeline server in a
  456. secure way.
  457. </p>
  458. @param renewer
  459. Address of the renewer who can renew these tokens when needed by
  460. securely talking to the timeline server
  461. @return a delegation token ({@link Token}) that can be used to talk to the
  462. timeline server
  463. @throws IOException
  464. @throws YarnException]]>
  465. </doc>
  466. </method>
  467. <method name="renewDelegationToken" return="long"
  468. abstract="true" native="false" synchronized="false"
  469. static="false" final="false" visibility="public"
  470. deprecated="not deprecated">
  471. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  472. <exception name="IOException" type="java.io.IOException"/>
  473. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  474. <doc>
  475. <![CDATA[<p>
  476. Renew a timeline delegation token.
  477. </p>
  478. @param timelineDT
  479. the delegation token to renew
  480. @return the new expiration time
  481. @throws IOException
  482. @throws YarnException]]>
  483. </doc>
  484. </method>
  485. <method name="cancelDelegationToken"
  486. abstract="true" native="false" synchronized="false"
  487. static="false" final="false" visibility="public"
  488. deprecated="not deprecated">
  489. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  490. <exception name="IOException" type="java.io.IOException"/>
  491. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  492. <doc>
  493. <![CDATA[<p>
  494. Cancel a timeline delegation token.
  495. </p>
  496. @param timelineDT
  497. the delegation token to cancel
  498. @throws IOException
  499. @throws YarnException]]>
  500. </doc>
  501. </method>
  502. <doc>
  503. <![CDATA[A client library that can be used to post some information in terms of a
  504. number of conceptual entities.]]>
  505. </doc>
  506. </class>
  507. <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
  508. </package>
  509. <package name="org.apache.hadoop.yarn.client.api.impl">
  510. </package>
  511. <package name="org.apache.hadoop.yarn.event">
  512. <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
  513. <class name="AbstractEvent" extends="java.lang.Object"
  514. abstract="true"
  515. static="false" final="false" visibility="public"
  516. deprecated="not deprecated">
  517. <implements name="org.apache.hadoop.yarn.event.Event"/>
  518. <constructor name="AbstractEvent" type="TYPE"
  519. static="false" final="false" visibility="public"
  520. deprecated="not deprecated">
  521. </constructor>
  522. <constructor name="AbstractEvent" type="TYPE, long"
  523. static="false" final="false" visibility="public"
  524. deprecated="not deprecated">
  525. </constructor>
  526. <method name="getTimestamp" return="long"
  527. abstract="false" native="false" synchronized="false"
  528. static="false" final="false" visibility="public"
  529. deprecated="not deprecated">
  530. </method>
  531. <method name="getType" return="TYPE"
  532. abstract="false" native="false" synchronized="false"
  533. static="false" final="false" visibility="public"
  534. deprecated="not deprecated">
  535. </method>
  536. <method name="toString" return="java.lang.String"
  537. abstract="false" native="false" synchronized="false"
  538. static="false" final="false" visibility="public"
  539. deprecated="not deprecated">
  540. </method>
  541. <doc>
  542. <![CDATA[Parent class of all the events. All events extend this class.]]>
  543. </doc>
  544. </class>
  545. <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
  546. <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  547. <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
  548. abstract="false"
  549. static="false" final="false" visibility="public"
  550. deprecated="not deprecated">
  551. <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
  552. <constructor name="AsyncDispatcher"
  553. static="false" final="false" visibility="public"
  554. deprecated="not deprecated">
  555. </constructor>
  556. <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
  557. static="false" final="false" visibility="public"
  558. deprecated="not deprecated">
  559. </constructor>
  560. <method name="serviceInit"
  561. abstract="false" native="false" synchronized="false"
  562. static="false" final="false" visibility="protected"
  563. deprecated="not deprecated">
  564. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  565. <exception name="Exception" type="java.lang.Exception"/>
  566. </method>
  567. <method name="serviceStart"
  568. abstract="false" native="false" synchronized="false"
  569. static="false" final="false" visibility="protected"
  570. deprecated="not deprecated">
  571. <exception name="Exception" type="java.lang.Exception"/>
  572. </method>
  573. <method name="setDrainEventsOnStop"
  574. abstract="false" native="false" synchronized="false"
  575. static="false" final="false" visibility="public"
  576. deprecated="not deprecated">
  577. </method>
  578. <method name="serviceStop"
  579. abstract="false" native="false" synchronized="false"
  580. static="false" final="false" visibility="protected"
  581. deprecated="not deprecated">
  582. <exception name="Exception" type="java.lang.Exception"/>
  583. </method>
  584. <method name="dispatch"
  585. abstract="false" native="false" synchronized="false"
  586. static="false" final="false" visibility="protected"
  587. deprecated="not deprecated">
  588. <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
  589. </method>
  590. <method name="register"
  591. abstract="false" native="false" synchronized="false"
  592. static="false" final="false" visibility="public"
  593. deprecated="not deprecated">
  594. <param name="eventType" type="java.lang.Class"/>
  595. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  596. </method>
  597. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  598. abstract="false" native="false" synchronized="false"
  599. static="false" final="false" visibility="public"
  600. deprecated="not deprecated">
  601. </method>
  602. <method name="isEventThreadWaiting" return="boolean"
  603. abstract="false" native="false" synchronized="false"
  604. static="false" final="false" visibility="protected"
  605. deprecated="not deprecated">
  606. </method>
  607. <method name="isDrained" return="boolean"
  608. abstract="false" native="false" synchronized="false"
  609. static="false" final="false" visibility="protected"
  610. deprecated="not deprecated">
  611. </method>
  612. <field name="eventDispatchers" type="java.util.Map"
  613. transient="false" volatile="false"
  614. static="false" final="true" visibility="protected"
  615. deprecated="not deprecated">
  616. </field>
  617. <doc>
  618. <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
  619. does that. Potentially there could be multiple channels for each event type
  620. class and a thread pool can be used to dispatch the events.]]>
  621. </doc>
  622. </class>
  623. <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  624. <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
  625. <interface name="Dispatcher" abstract="true"
  626. static="false" final="false" visibility="public"
  627. deprecated="not deprecated">
  628. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  629. abstract="false" native="false" synchronized="false"
  630. static="false" final="false" visibility="public"
  631. deprecated="not deprecated">
  632. </method>
  633. <method name="register"
  634. abstract="false" native="false" synchronized="false"
  635. static="false" final="false" visibility="public"
  636. deprecated="not deprecated">
  637. <param name="eventType" type="java.lang.Class"/>
  638. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  639. </method>
  640. <field name="DISPATCHER_EXIT_ON_ERROR_KEY" type="java.lang.String"
  641. transient="false" volatile="false"
  642. static="true" final="true" visibility="public"
  643. deprecated="not deprecated">
  644. </field>
  645. <field name="DEFAULT_DISPATCHER_EXIT_ON_ERROR" type="boolean"
  646. transient="false" volatile="false"
  647. static="true" final="true" visibility="public"
  648. deprecated="not deprecated">
  649. </field>
  650. <doc>
  651. <![CDATA[Event Dispatcher interface. It dispatches events to registered
  652. event handlers based on event types.]]>
  653. </doc>
  654. </interface>
  655. <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
  656. <!-- start interface org.apache.hadoop.yarn.event.Event -->
  657. <interface name="Event" abstract="true"
  658. static="false" final="false" visibility="public"
  659. deprecated="not deprecated">
  660. <method name="getType" return="TYPE"
  661. abstract="false" native="false" synchronized="false"
  662. static="false" final="false" visibility="public"
  663. deprecated="not deprecated">
  664. </method>
  665. <method name="getTimestamp" return="long"
  666. abstract="false" native="false" synchronized="false"
  667. static="false" final="false" visibility="public"
  668. deprecated="not deprecated">
  669. </method>
  670. <method name="toString" return="java.lang.String"
  671. abstract="false" native="false" synchronized="false"
  672. static="false" final="false" visibility="public"
  673. deprecated="not deprecated">
  674. </method>
  675. <doc>
  676. <![CDATA[Interface defining events api.]]>
  677. </doc>
  678. </interface>
  679. <!-- end interface org.apache.hadoop.yarn.event.Event -->
  680. <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
  681. <interface name="EventHandler" abstract="true"
  682. static="false" final="false" visibility="public"
  683. deprecated="not deprecated">
  684. <method name="handle"
  685. abstract="false" native="false" synchronized="false"
  686. static="false" final="false" visibility="public"
  687. deprecated="not deprecated">
  688. <param name="event" type="T"/>
  689. </method>
  690. <doc>
  691. <![CDATA[Interface for handling events of type T
  692. @param <T> parameterized event of type T]]>
  693. </doc>
  694. </interface>
  695. <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
  696. </package>
  697. <package name="org.apache.hadoop.yarn.factories">
  698. </package>
  699. <package name="org.apache.hadoop.yarn.factory.providers">
  700. </package>
  701. <package name="org.apache.hadoop.yarn.logaggregation">
  702. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  703. <class name="AggregatedLogFormat" extends="java.lang.Object"
  704. abstract="false"
  705. static="false" final="false" visibility="public"
  706. deprecated="not deprecated">
  707. <constructor name="AggregatedLogFormat"
  708. static="false" final="false" visibility="public"
  709. deprecated="not deprecated">
  710. </constructor>
  711. </class>
  712. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  713. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  714. <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
  715. abstract="false"
  716. static="true" final="false" visibility="public"
  717. deprecated="not deprecated">
  718. <implements name="org.apache.hadoop.io.Writable"/>
  719. <constructor name="AggregatedLogFormat.LogKey"
  720. static="false" final="false" visibility="public"
  721. deprecated="not deprecated">
  722. </constructor>
  723. <constructor name="AggregatedLogFormat.LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
  724. static="false" final="false" visibility="public"
  725. deprecated="not deprecated">
  726. </constructor>
  727. <constructor name="AggregatedLogFormat.LogKey" type="java.lang.String"
  728. static="false" final="false" visibility="public"
  729. deprecated="not deprecated">
  730. </constructor>
  731. <method name="hashCode" return="int"
  732. abstract="false" native="false" synchronized="false"
  733. static="false" final="false" visibility="public"
  734. deprecated="not deprecated">
  735. </method>
  736. <method name="equals" return="boolean"
  737. abstract="false" native="false" synchronized="false"
  738. static="false" final="false" visibility="public"
  739. deprecated="not deprecated">
  740. <param name="obj" type="java.lang.Object"/>
  741. </method>
  742. <method name="toString" return="java.lang.String"
  743. abstract="false" native="false" synchronized="false"
  744. static="false" final="false" visibility="public"
  745. deprecated="not deprecated">
  746. </method>
  747. </class>
  748. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  749. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  750. <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
  751. abstract="false"
  752. static="true" final="false" visibility="public"
  753. deprecated="not deprecated">
  754. <constructor name="AggregatedLogFormat.LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
  755. static="false" final="false" visibility="public"
  756. deprecated="not deprecated">
  757. <exception name="IOException" type="java.io.IOException"/>
  758. </constructor>
  759. <method name="getApplicationOwner" return="java.lang.String"
  760. abstract="false" native="false" synchronized="false"
  761. static="false" final="false" visibility="public"
  762. deprecated="not deprecated">
  763. <exception name="IOException" type="java.io.IOException"/>
  764. <doc>
  765. <![CDATA[Returns the owner of the application.
  766. @return the application owner.
  767. @throws IOException]]>
  768. </doc>
  769. </method>
  770. <method name="getApplicationAcls" return="java.util.Map"
  771. abstract="false" native="false" synchronized="false"
  772. static="false" final="false" visibility="public"
  773. deprecated="not deprecated">
  774. <exception name="IOException" type="java.io.IOException"/>
  775. <doc>
  776. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  777. found.
  778. @return a map of the Application ACLs.
  779. @throws IOException]]>
  780. </doc>
  781. </method>
  782. <method name="next" return="java.io.DataInputStream"
  783. abstract="false" native="false" synchronized="false"
  784. static="false" final="false" visibility="public"
  785. deprecated="not deprecated">
  786. <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  787. <exception name="IOException" type="java.io.IOException"/>
  788. <doc>
  789. <![CDATA[Read the next key and return the value-stream.
  790. @param key
  791. @return the valueStream if there are more keys or null otherwise.
  792. @throws IOException]]>
  793. </doc>
  794. </method>
  795. <method name="readAcontainerLogs"
  796. abstract="false" native="false" synchronized="false"
  797. static="true" final="false" visibility="public"
  798. deprecated="not deprecated">
  799. <param name="valueStream" type="java.io.DataInputStream"/>
  800. <param name="writer" type="java.io.Writer"/>
  801. <param name="logUploadedTime" type="long"/>
  802. <exception name="IOException" type="java.io.IOException"/>
  803. <doc>
  804. <![CDATA[Writes all logs for a single container to the provided writer.
  805. @param valueStream
  806. @param writer
  807. @param logUploadedTime
  808. @throws IOException]]>
  809. </doc>
  810. </method>
  811. <method name="readAcontainerLogs"
  812. abstract="false" native="false" synchronized="false"
  813. static="true" final="false" visibility="public"
  814. deprecated="not deprecated">
  815. <param name="valueStream" type="java.io.DataInputStream"/>
  816. <param name="writer" type="java.io.Writer"/>
  817. <exception name="IOException" type="java.io.IOException"/>
  818. <doc>
  819. <![CDATA[Writes all logs for a single container to the provided writer.
  820. @param valueStream
  821. @param writer
  822. @throws IOException]]>
  823. </doc>
  824. </method>
  825. <method name="readAContainerLogsForALogType"
  826. abstract="false" native="false" synchronized="false"
  827. static="true" final="false" visibility="public"
  828. deprecated="not deprecated">
  829. <param name="valueStream" type="java.io.DataInputStream"/>
  830. <param name="out" type="java.io.PrintStream"/>
  831. <param name="logUploadedTime" type="long"/>
  832. <exception name="IOException" type="java.io.IOException"/>
  833. <doc>
  834. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  835. all types for a single container.
  836. @param valueStream
  837. @param out
  838. @param logUploadedTime
  839. @throws IOException]]>
  840. </doc>
  841. </method>
  842. <method name="readAContainerLogsForALogType"
  843. abstract="false" native="false" synchronized="false"
  844. static="true" final="false" visibility="public"
  845. deprecated="not deprecated">
  846. <param name="valueStream" type="java.io.DataInputStream"/>
  847. <param name="out" type="java.io.PrintStream"/>
  848. <exception name="IOException" type="java.io.IOException"/>
  849. <doc>
  850. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  851. all types for a single container.
  852. @param valueStream
  853. @param out
  854. @throws IOException]]>
  855. </doc>
  856. </method>
  857. <method name="readContainerLogsForALogType" return="int"
  858. abstract="false" native="false" synchronized="false"
  859. static="true" final="false" visibility="public"
  860. deprecated="not deprecated">
  861. <param name="valueStream" type="java.io.DataInputStream"/>
  862. <param name="out" type="java.io.PrintStream"/>
  863. <param name="logUploadedTime" type="long"/>
  864. <param name="logType" type="java.util.List"/>
  865. <exception name="IOException" type="java.io.IOException"/>
  866. <doc>
  867. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  868. the specific types for a single container.
  869. @param valueStream
  870. @param out
  871. @param logUploadedTime
  872. @param logType
  873. @throws IOException]]>
  874. </doc>
  875. </method>
  876. <method name="close"
  877. abstract="false" native="false" synchronized="false"
  878. static="false" final="false" visibility="public"
  879. deprecated="not deprecated">
  880. </method>
  881. </class>
  882. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  883. </package>
  884. <package name="org.apache.hadoop.yarn.nodelabels">
  885. </package>
  886. <package name="org.apache.hadoop.yarn.nodelabels.event">
  887. </package>
  888. <package name="org.apache.hadoop.yarn.security">
  889. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  890. <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  891. abstract="false"
  892. static="false" final="false" visibility="public"
  893. deprecated="not deprecated">
  894. <constructor name="AMRMTokenIdentifier"
  895. static="false" final="false" visibility="public"
  896. deprecated="not deprecated">
  897. </constructor>
  898. <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
  899. static="false" final="false" visibility="public"
  900. deprecated="not deprecated">
  901. </constructor>
  902. <method name="write"
  903. abstract="false" native="false" synchronized="false"
  904. static="false" final="false" visibility="public"
  905. deprecated="not deprecated">
  906. <param name="out" type="java.io.DataOutput"/>
  907. <exception name="IOException" type="java.io.IOException"/>
  908. </method>
  909. <method name="readFields"
  910. abstract="false" native="false" synchronized="false"
  911. static="false" final="false" visibility="public"
  912. deprecated="not deprecated">
  913. <param name="in" type="java.io.DataInput"/>
  914. <exception name="IOException" type="java.io.IOException"/>
  915. </method>
  916. <method name="getKind" return="org.apache.hadoop.io.Text"
  917. abstract="false" native="false" synchronized="false"
  918. static="false" final="false" visibility="public"
  919. deprecated="not deprecated">
  920. </method>
  921. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  922. abstract="false" native="false" synchronized="false"
  923. static="false" final="false" visibility="public"
  924. deprecated="not deprecated">
  925. </method>
  926. <method name="getKeyId" return="int"
  927. abstract="false" native="false" synchronized="false"
  928. static="false" final="false" visibility="public"
  929. deprecated="not deprecated">
  930. </method>
  931. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
  932. abstract="false" native="false" synchronized="false"
  933. static="false" final="false" visibility="public"
  934. deprecated="not deprecated">
  935. </method>
  936. <method name="hashCode" return="int"
  937. abstract="false" native="false" synchronized="false"
  938. static="false" final="false" visibility="public"
  939. deprecated="not deprecated">
  940. </method>
  941. <method name="equals" return="boolean"
  942. abstract="false" native="false" synchronized="false"
  943. static="false" final="false" visibility="public"
  944. deprecated="not deprecated">
  945. <param name="other" type="java.lang.Object"/>
  946. </method>
  947. <method name="toString" return="java.lang.String"
  948. abstract="false" native="false" synchronized="false"
  949. static="false" final="false" visibility="public"
  950. deprecated="not deprecated">
  951. </method>
  952. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  953. transient="false" volatile="false"
  954. static="true" final="true" visibility="public"
  955. deprecated="not deprecated">
  956. </field>
  957. <doc>
  958. <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
  959. ApplicationMasters to authenticate to the ResourceManager.]]>
  960. </doc>
  961. </class>
  962. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  963. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  964. <class name="AMRMTokenSelector" extends="java.lang.Object"
  965. abstract="false"
  966. static="false" final="false" visibility="public"
  967. deprecated="not deprecated">
  968. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  969. <constructor name="AMRMTokenSelector"
  970. static="false" final="false" visibility="public"
  971. deprecated="not deprecated">
  972. </constructor>
  973. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  974. abstract="false" native="false" synchronized="false"
  975. static="false" final="false" visibility="public"
  976. deprecated="not deprecated">
  977. <param name="service" type="org.apache.hadoop.io.Text"/>
  978. <param name="tokens" type="java.util.Collection"/>
  979. </method>
  980. </class>
  981. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  982. <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  983. <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  984. abstract="false"
  985. static="false" final="false" visibility="public"
  986. deprecated="not deprecated">
  987. <constructor name="ContainerManagerSecurityInfo"
  988. static="false" final="false" visibility="public"
  989. deprecated="not deprecated">
  990. </constructor>
  991. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  992. abstract="false" native="false" synchronized="false"
  993. static="false" final="false" visibility="public"
  994. deprecated="not deprecated">
  995. <param name="protocol" type="java.lang.Class"/>
  996. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  997. </method>
  998. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  999. abstract="false" native="false" synchronized="false"
  1000. static="false" final="false" visibility="public"
  1001. deprecated="not deprecated">
  1002. <param name="protocol" type="java.lang.Class"/>
  1003. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1004. </method>
  1005. </class>
  1006. <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1007. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1008. <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1009. abstract="false"
  1010. static="false" final="false" visibility="public"
  1011. deprecated="not deprecated">
  1012. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long"
  1013. static="false" final="false" visibility="public"
  1014. deprecated="not deprecated">
  1015. </constructor>
  1016. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext"
  1017. static="false" final="false" visibility="public"
  1018. deprecated="Use one of the other constructors instead.">
  1019. <doc>
  1020. <![CDATA[Creates a instance.
  1021. @param appSubmitter appSubmitter
  1022. @param containerID container ID
  1023. @param creationTime creation time
  1024. @param expiryTimeStamp expiry timestamp
  1025. @param hostName hostname
  1026. @param logAggregationContext log aggregation context
  1027. @param masterKeyId master key ID
  1028. @param priority priority
  1029. @param r resource needed by the container
  1030. @param rmIdentifier ResourceManager identifier
  1031. @deprecated Use one of the other constructors instead.]]>
  1032. </doc>
  1033. </constructor>
  1034. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String"
  1035. static="false" final="false" visibility="public"
  1036. deprecated="not deprecated">
  1037. </constructor>
  1038. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType"
  1039. static="false" final="false" visibility="public"
  1040. deprecated="not deprecated">
  1041. </constructor>
  1042. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType"
  1043. static="false" final="false" visibility="public"
  1044. deprecated="not deprecated">
  1045. </constructor>
  1046. <constructor name="ContainerTokenIdentifier"
  1047. static="false" final="false" visibility="public"
  1048. deprecated="not deprecated">
  1049. <doc>
  1050. <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
  1051. </doc>
  1052. </constructor>
  1053. <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
  1054. abstract="false" native="false" synchronized="false"
  1055. static="false" final="false" visibility="public"
  1056. deprecated="not deprecated">
  1057. </method>
  1058. <method name="getApplicationSubmitter" return="java.lang.String"
  1059. abstract="false" native="false" synchronized="false"
  1060. static="false" final="false" visibility="public"
  1061. deprecated="not deprecated">
  1062. </method>
  1063. <method name="getNmHostAddress" return="java.lang.String"
  1064. abstract="false" native="false" synchronized="false"
  1065. static="false" final="false" visibility="public"
  1066. deprecated="not deprecated">
  1067. </method>
  1068. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  1069. abstract="false" native="false" synchronized="false"
  1070. static="false" final="false" visibility="public"
  1071. deprecated="not deprecated">
  1072. </method>
  1073. <method name="getExpiryTimeStamp" return="long"
  1074. abstract="false" native="false" synchronized="false"
  1075. static="false" final="false" visibility="public"
  1076. deprecated="not deprecated">
  1077. </method>
  1078. <method name="getMasterKeyId" return="int"
  1079. abstract="false" native="false" synchronized="false"
  1080. static="false" final="false" visibility="public"
  1081. deprecated="not deprecated">
  1082. </method>
  1083. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1084. abstract="false" native="false" synchronized="false"
  1085. static="false" final="false" visibility="public"
  1086. deprecated="not deprecated">
  1087. </method>
  1088. <method name="getCreationTime" return="long"
  1089. abstract="false" native="false" synchronized="false"
  1090. static="false" final="false" visibility="public"
  1091. deprecated="not deprecated">
  1092. </method>
  1093. <method name="getRMIdentifier" return="long"
  1094. abstract="false" native="false" synchronized="false"
  1095. static="false" final="false" visibility="public"
  1096. deprecated="not deprecated">
  1097. <doc>
  1098. <![CDATA[Get the RMIdentifier of RM in which containers are allocated
  1099. @return RMIdentifier]]>
  1100. </doc>
  1101. </method>
  1102. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  1103. abstract="false" native="false" synchronized="false"
  1104. static="false" final="false" visibility="public"
  1105. deprecated="not deprecated">
  1106. <doc>
  1107. <![CDATA[Get the ContainerType of container to allocate.
  1108. @return ContainerType]]>
  1109. </doc>
  1110. </method>
  1111. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
  1112. abstract="false" native="false" synchronized="false"
  1113. static="false" final="false" visibility="public"
  1114. deprecated="not deprecated">
  1115. </method>
  1116. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  1117. abstract="false" native="false" synchronized="false"
  1118. static="false" final="false" visibility="public"
  1119. deprecated="not deprecated">
  1120. </method>
  1121. <method name="write"
  1122. abstract="false" native="false" synchronized="false"
  1123. static="false" final="false" visibility="public"
  1124. deprecated="not deprecated">
  1125. <param name="out" type="java.io.DataOutput"/>
  1126. <exception name="IOException" type="java.io.IOException"/>
  1127. </method>
  1128. <method name="readFields"
  1129. abstract="false" native="false" synchronized="false"
  1130. static="false" final="false" visibility="public"
  1131. deprecated="not deprecated">
  1132. <param name="in" type="java.io.DataInput"/>
  1133. <exception name="IOException" type="java.io.IOException"/>
  1134. </method>
  1135. <method name="getKind" return="org.apache.hadoop.io.Text"
  1136. abstract="false" native="false" synchronized="false"
  1137. static="false" final="false" visibility="public"
  1138. deprecated="not deprecated">
  1139. </method>
  1140. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1141. abstract="false" native="false" synchronized="false"
  1142. static="false" final="false" visibility="public"
  1143. deprecated="not deprecated">
  1144. </method>
  1145. <method name="getVersion" return="int"
  1146. abstract="false" native="false" synchronized="false"
  1147. static="false" final="false" visibility="public"
  1148. deprecated="not deprecated">
  1149. <doc>
  1150. <![CDATA[Get the Container version
  1151. @return container version]]>
  1152. </doc>
  1153. </method>
  1154. <method name="getNodeLabelExpression" return="java.lang.String"
  1155. abstract="false" native="false" synchronized="false"
  1156. static="false" final="false" visibility="public"
  1157. deprecated="not deprecated">
  1158. <doc>
  1159. <![CDATA[Get the node-label-expression in the original ResourceRequest]]>
  1160. </doc>
  1161. </method>
  1162. <method name="hashCode" return="int"
  1163. abstract="false" native="false" synchronized="false"
  1164. static="false" final="false" visibility="public"
  1165. deprecated="not deprecated">
  1166. </method>
  1167. <method name="equals" return="boolean"
  1168. abstract="false" native="false" synchronized="false"
  1169. static="false" final="false" visibility="public"
  1170. deprecated="not deprecated">
  1171. <param name="other" type="java.lang.Object"/>
  1172. </method>
  1173. <method name="toString" return="java.lang.String"
  1174. abstract="false" native="false" synchronized="false"
  1175. static="false" final="false" visibility="public"
  1176. deprecated="not deprecated">
  1177. </method>
  1178. <field name="KIND" type="org.apache.hadoop.io.Text"
  1179. transient="false" volatile="false"
  1180. static="true" final="true" visibility="public"
  1181. deprecated="not deprecated">
  1182. </field>
  1183. <doc>
  1184. <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
  1185. {@link Resource} needed by the container and the target NMs host-address.]]>
  1186. </doc>
  1187. </class>
  1188. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1189. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1190. <class name="ContainerTokenSelector" extends="java.lang.Object"
  1191. abstract="false"
  1192. static="false" final="false" visibility="public"
  1193. deprecated="not deprecated">
  1194. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1195. <constructor name="ContainerTokenSelector"
  1196. static="false" final="false" visibility="public"
  1197. deprecated="not deprecated">
  1198. </constructor>
  1199. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1200. abstract="false" native="false" synchronized="false"
  1201. static="false" final="false" visibility="public"
  1202. deprecated="not deprecated">
  1203. <param name="service" type="org.apache.hadoop.io.Text"/>
  1204. <param name="tokens" type="java.util.Collection"/>
  1205. </method>
  1206. </class>
  1207. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1208. <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1209. <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1210. abstract="false"
  1211. static="false" final="false" visibility="public"
  1212. deprecated="not deprecated">
  1213. <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
  1214. static="false" final="false" visibility="public"
  1215. deprecated="not deprecated">
  1216. </constructor>
  1217. <constructor name="NMTokenIdentifier"
  1218. static="false" final="false" visibility="public"
  1219. deprecated="not deprecated">
  1220. <doc>
  1221. <![CDATA[Default constructor needed by RPC/Secret manager]]>
  1222. </doc>
  1223. </constructor>
  1224. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1225. abstract="false" native="false" synchronized="false"
  1226. static="false" final="false" visibility="public"
  1227. deprecated="not deprecated">
  1228. </method>
  1229. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  1230. abstract="false" native="false" synchronized="false"
  1231. static="false" final="false" visibility="public"
  1232. deprecated="not deprecated">
  1233. </method>
  1234. <method name="getApplicationSubmitter" return="java.lang.String"
  1235. abstract="false" native="false" synchronized="false"
  1236. static="false" final="false" visibility="public"
  1237. deprecated="not deprecated">
  1238. </method>
  1239. <method name="getKeyId" return="int"
  1240. abstract="false" native="false" synchronized="false"
  1241. static="false" final="false" visibility="public"
  1242. deprecated="not deprecated">
  1243. </method>
  1244. <method name="write"
  1245. abstract="false" native="false" synchronized="false"
  1246. static="false" final="false" visibility="public"
  1247. deprecated="not deprecated">
  1248. <param name="out" type="java.io.DataOutput"/>
  1249. <exception name="IOException" type="java.io.IOException"/>
  1250. </method>
  1251. <method name="readFields"
  1252. abstract="false" native="false" synchronized="false"
  1253. static="false" final="false" visibility="public"
  1254. deprecated="not deprecated">
  1255. <param name="in" type="java.io.DataInput"/>
  1256. <exception name="IOException" type="java.io.IOException"/>
  1257. </method>
  1258. <method name="getKind" return="org.apache.hadoop.io.Text"
  1259. abstract="false" native="false" synchronized="false"
  1260. static="false" final="false" visibility="public"
  1261. deprecated="not deprecated">
  1262. </method>
  1263. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1264. abstract="false" native="false" synchronized="false"
  1265. static="false" final="false" visibility="public"
  1266. deprecated="not deprecated">
  1267. </method>
  1268. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
  1269. abstract="false" native="false" synchronized="false"
  1270. static="false" final="false" visibility="public"
  1271. deprecated="not deprecated">
  1272. </method>
  1273. <method name="hashCode" return="int"
  1274. abstract="false" native="false" synchronized="false"
  1275. static="false" final="false" visibility="public"
  1276. deprecated="not deprecated">
  1277. </method>
  1278. <method name="equals" return="boolean"
  1279. abstract="false" native="false" synchronized="false"
  1280. static="false" final="false" visibility="public"
  1281. deprecated="not deprecated">
  1282. <param name="other" type="java.lang.Object"/>
  1283. </method>
  1284. <method name="toString" return="java.lang.String"
  1285. abstract="false" native="false" synchronized="false"
  1286. static="false" final="false" visibility="public"
  1287. deprecated="not deprecated">
  1288. </method>
  1289. <field name="KIND" type="org.apache.hadoop.io.Text"
  1290. transient="false" volatile="false"
  1291. static="true" final="true" visibility="public"
  1292. deprecated="not deprecated">
  1293. </field>
  1294. </class>
  1295. <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1296. <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1297. <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1298. abstract="false"
  1299. static="false" final="false" visibility="public"
  1300. deprecated="not deprecated">
  1301. <constructor name="SchedulerSecurityInfo"
  1302. static="false" final="false" visibility="public"
  1303. deprecated="not deprecated">
  1304. </constructor>
  1305. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1306. abstract="false" native="false" synchronized="false"
  1307. static="false" final="false" visibility="public"
  1308. deprecated="not deprecated">
  1309. <param name="protocol" type="java.lang.Class"/>
  1310. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1311. </method>
  1312. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1313. abstract="false" native="false" synchronized="false"
  1314. static="false" final="false" visibility="public"
  1315. deprecated="not deprecated">
  1316. <param name="protocol" type="java.lang.Class"/>
  1317. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1318. </method>
  1319. </class>
  1320. <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1321. </package>
  1322. <package name="org.apache.hadoop.yarn.security.admin">
  1323. <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  1324. <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1325. abstract="false"
  1326. static="false" final="false" visibility="public"
  1327. deprecated="not deprecated">
  1328. <constructor name="AdminSecurityInfo"
  1329. static="false" final="false" visibility="public"
  1330. deprecated="not deprecated">
  1331. </constructor>
  1332. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1333. abstract="false" native="false" synchronized="false"
  1334. static="false" final="false" visibility="public"
  1335. deprecated="not deprecated">
  1336. <param name="protocol" type="java.lang.Class"/>
  1337. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1338. </method>
  1339. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1340. abstract="false" native="false" synchronized="false"
  1341. static="false" final="false" visibility="public"
  1342. deprecated="not deprecated">
  1343. <param name="protocol" type="java.lang.Class"/>
  1344. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1345. </method>
  1346. </class>
  1347. <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  1348. </package>
  1349. <package name="org.apache.hadoop.yarn.security.client">
  1350. <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  1351. <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
  1352. abstract="true"
  1353. static="false" final="false" visibility="public"
  1354. deprecated="not deprecated">
  1355. <constructor name="BaseClientToAMTokenSecretManager"
  1356. static="false" final="false" visibility="public"
  1357. deprecated="not deprecated">
  1358. </constructor>
  1359. <doc>
  1360. <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
  1361. issued to clients by the RM using the underlying master-key shared by RM to
  1362. the AMs on their launch. All the methods are called by either Hadoop RPC or
  1363. YARN, so this class is strictly for the purpose of inherit/extend and
  1364. register with Hadoop RPC.]]>
  1365. </doc>
  1366. </class>
  1367. <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  1368. <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  1369. <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1370. abstract="false"
  1371. static="false" final="false" visibility="public"
  1372. deprecated="not deprecated">
  1373. <constructor name="ClientRMSecurityInfo"
  1374. static="false" final="false" visibility="public"
  1375. deprecated="not deprecated">
  1376. </constructor>
  1377. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1378. abstract="false" native="false" synchronized="false"
  1379. static="false" final="false" visibility="public"
  1380. deprecated="not deprecated">
  1381. <param name="protocol" type="java.lang.Class"/>
  1382. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1383. </method>
  1384. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1385. abstract="false" native="false" synchronized="false"
  1386. static="false" final="false" visibility="public"
  1387. deprecated="not deprecated">
  1388. <param name="protocol" type="java.lang.Class"/>
  1389. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1390. </method>
  1391. </class>
  1392. <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  1393. <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  1394. <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1395. abstract="false"
  1396. static="false" final="false" visibility="public"
  1397. deprecated="not deprecated">
  1398. <constructor name="ClientTimelineSecurityInfo"
  1399. static="false" final="false" visibility="public"
  1400. deprecated="not deprecated">
  1401. </constructor>
  1402. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1403. abstract="false" native="false" synchronized="false"
  1404. static="false" final="false" visibility="public"
  1405. deprecated="not deprecated">
  1406. <param name="protocol" type="java.lang.Class"/>
  1407. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1408. </method>
  1409. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1410. abstract="false" native="false" synchronized="false"
  1411. static="false" final="false" visibility="public"
  1412. deprecated="not deprecated">
  1413. <param name="protocol" type="java.lang.Class"/>
  1414. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1415. </method>
  1416. </class>
  1417. <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  1418. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  1419. <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1420. abstract="false"
  1421. static="false" final="false" visibility="public"
  1422. deprecated="not deprecated">
  1423. <constructor name="ClientToAMTokenIdentifier"
  1424. static="false" final="false" visibility="public"
  1425. deprecated="not deprecated">
  1426. </constructor>
  1427. <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
  1428. static="false" final="false" visibility="public"
  1429. deprecated="not deprecated">
  1430. </constructor>
  1431. <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1432. abstract="false" native="false" synchronized="false"
  1433. static="false" final="false" visibility="public"
  1434. deprecated="not deprecated">
  1435. </method>
  1436. <method name="getClientName" return="java.lang.String"
  1437. abstract="false" native="false" synchronized="false"
  1438. static="false" final="false" visibility="public"
  1439. deprecated="not deprecated">
  1440. </method>
  1441. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
  1442. abstract="false" native="false" synchronized="false"
  1443. static="false" final="false" visibility="public"
  1444. deprecated="not deprecated">
  1445. </method>
  1446. <method name="write"
  1447. abstract="false" native="false" synchronized="false"
  1448. static="false" final="false" visibility="public"
  1449. deprecated="not deprecated">
  1450. <param name="out" type="java.io.DataOutput"/>
  1451. <exception name="IOException" type="java.io.IOException"/>
  1452. </method>
  1453. <method name="readFields"
  1454. abstract="false" native="false" synchronized="false"
  1455. static="false" final="false" visibility="public"
  1456. deprecated="not deprecated">
  1457. <param name="in" type="java.io.DataInput"/>
  1458. <exception name="IOException" type="java.io.IOException"/>
  1459. </method>
  1460. <method name="getKind" return="org.apache.hadoop.io.Text"
  1461. abstract="false" native="false" synchronized="false"
  1462. static="false" final="false" visibility="public"
  1463. deprecated="not deprecated">
  1464. </method>
  1465. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1466. abstract="false" native="false" synchronized="false"
  1467. static="false" final="false" visibility="public"
  1468. deprecated="not deprecated">
  1469. </method>
  1470. <method name="hashCode" return="int"
  1471. abstract="false" native="false" synchronized="false"
  1472. static="false" final="false" visibility="public"
  1473. deprecated="not deprecated">
  1474. </method>
  1475. <method name="equals" return="boolean"
  1476. abstract="false" native="false" synchronized="false"
  1477. static="false" final="false" visibility="public"
  1478. deprecated="not deprecated">
  1479. <param name="other" type="java.lang.Object"/>
  1480. </method>
  1481. <method name="toString" return="java.lang.String"
  1482. abstract="false" native="false" synchronized="false"
  1483. static="false" final="false" visibility="public"
  1484. deprecated="not deprecated">
  1485. </method>
  1486. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1487. transient="false" volatile="false"
  1488. static="true" final="true" visibility="public"
  1489. deprecated="not deprecated">
  1490. </field>
  1491. </class>
  1492. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  1493. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  1494. <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
  1495. abstract="false"
  1496. static="false" final="false" visibility="public"
  1497. deprecated="not deprecated">
  1498. <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
  1499. static="false" final="false" visibility="public"
  1500. deprecated="not deprecated">
  1501. </constructor>
  1502. <method name="retrievePassword" return="byte[]"
  1503. abstract="false" native="false" synchronized="false"
  1504. static="false" final="false" visibility="public"
  1505. deprecated="not deprecated">
  1506. <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
  1507. <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
  1508. </method>
  1509. <method name="getMasterKey" return="javax.crypto.SecretKey"
  1510. abstract="false" native="false" synchronized="false"
  1511. static="false" final="false" visibility="public"
  1512. deprecated="not deprecated">
  1513. <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1514. </method>
  1515. <method name="setMasterKey"
  1516. abstract="false" native="false" synchronized="false"
  1517. static="false" final="false" visibility="public"
  1518. deprecated="not deprecated">
  1519. <param name="key" type="byte[]"/>
  1520. </method>
  1521. <doc>
  1522. <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
  1523. clients by the RM using the underlying master-key shared by RM to the AMs on
  1524. their launch. All the methods are called by either Hadoop RPC or YARN, so
  1525. this class is strictly for the purpose of inherit/extend and register with
  1526. Hadoop RPC.]]>
  1527. </doc>
  1528. </class>
  1529. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  1530. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  1531. <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  1532. abstract="false"
  1533. static="false" final="false" visibility="public"
  1534. deprecated="not deprecated">
  1535. <constructor name="RMDelegationTokenIdentifier"
  1536. static="false" final="false" visibility="public"
  1537. deprecated="not deprecated">
  1538. </constructor>
  1539. <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  1540. static="false" final="false" visibility="public"
  1541. deprecated="not deprecated">
  1542. <doc>
  1543. <![CDATA[Create a new delegation token identifier
  1544. @param owner the effective username of the token owner
  1545. @param renewer the username of the renewer
  1546. @param realUser the real username of the token owner]]>
  1547. </doc>
  1548. </constructor>
  1549. <method name="getKind" return="org.apache.hadoop.io.Text"
  1550. abstract="false" native="false" synchronized="false"
  1551. static="false" final="false" visibility="public"
  1552. deprecated="not deprecated">
  1553. </method>
  1554. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1555. transient="false" volatile="false"
  1556. static="true" final="true" visibility="public"
  1557. deprecated="not deprecated">
  1558. </field>
  1559. <doc>
  1560. <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
  1561. Resource Manager.]]>
  1562. </doc>
  1563. </class>
  1564. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  1565. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  1566. <class name="RMDelegationTokenSelector" extends="java.lang.Object"
  1567. abstract="false"
  1568. static="false" final="false" visibility="public"
  1569. deprecated="not deprecated">
  1570. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1571. <constructor name="RMDelegationTokenSelector"
  1572. static="false" final="false" visibility="public"
  1573. deprecated="not deprecated">
  1574. </constructor>
  1575. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1576. abstract="false" native="false" synchronized="false"
  1577. static="false" final="false" visibility="public"
  1578. deprecated="not deprecated">
  1579. <param name="service" type="org.apache.hadoop.io.Text"/>
  1580. <param name="tokens" type="java.util.Collection"/>
  1581. </method>
  1582. </class>
  1583. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  1584. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  1585. <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  1586. abstract="false"
  1587. static="false" final="false" visibility="public"
  1588. deprecated="not deprecated">
  1589. <constructor name="TimelineDelegationTokenIdentifier"
  1590. static="false" final="false" visibility="public"
  1591. deprecated="not deprecated">
  1592. </constructor>
  1593. <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  1594. static="false" final="false" visibility="public"
  1595. deprecated="not deprecated">
  1596. <doc>
  1597. <![CDATA[Create a new timeline delegation token identifier
  1598. @param owner the effective username of the token owner
  1599. @param renewer the username of the renewer
  1600. @param realUser the real username of the token owner]]>
  1601. </doc>
  1602. </constructor>
  1603. <method name="getKind" return="org.apache.hadoop.io.Text"
  1604. abstract="false" native="false" synchronized="false"
  1605. static="false" final="false" visibility="public"
  1606. deprecated="not deprecated">
  1607. </method>
  1608. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1609. transient="false" volatile="false"
  1610. static="true" final="true" visibility="public"
  1611. deprecated="not deprecated">
  1612. </field>
  1613. </class>
  1614. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  1615. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  1616. <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
  1617. abstract="false"
  1618. static="false" final="false" visibility="public"
  1619. deprecated="not deprecated">
  1620. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1621. <constructor name="TimelineDelegationTokenSelector"
  1622. static="false" final="false" visibility="public"
  1623. deprecated="not deprecated">
  1624. </constructor>
  1625. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1626. abstract="false" native="false" synchronized="false"
  1627. static="false" final="false" visibility="public"
  1628. deprecated="not deprecated">
  1629. <param name="service" type="org.apache.hadoop.io.Text"/>
  1630. <param name="tokens" type="java.util.Collection"/>
  1631. </method>
  1632. </class>
  1633. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  1634. </package>
  1635. <package name="org.apache.hadoop.yarn.server.api">
  1636. </package>
  1637. <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
  1638. </package>
  1639. <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
  1640. </package>
  1641. <package name="org.apache.hadoop.yarn.sharedcache">
  1642. <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  1643. <interface name="SharedCacheChecksum" abstract="true"
  1644. static="false" final="false" visibility="public"
  1645. deprecated="not deprecated">
  1646. <method name="computeChecksum" return="java.lang.String"
  1647. abstract="false" native="false" synchronized="false"
  1648. static="false" final="false" visibility="public"
  1649. deprecated="not deprecated">
  1650. <param name="in" type="java.io.InputStream"/>
  1651. <exception name="IOException" type="java.io.IOException"/>
  1652. <doc>
  1653. <![CDATA[Calculate the checksum of the passed input stream.
  1654. @param in <code>InputStream</code> to be checksumed
  1655. @return the message digest of the input stream
  1656. @throws IOException]]>
  1657. </doc>
  1658. </method>
  1659. </interface>
  1660. <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  1661. <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  1662. <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
  1663. abstract="false"
  1664. static="false" final="false" visibility="public"
  1665. deprecated="not deprecated">
  1666. <constructor name="SharedCacheChecksumFactory"
  1667. static="false" final="false" visibility="public"
  1668. deprecated="not deprecated">
  1669. </constructor>
  1670. <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
  1671. abstract="false" native="false" synchronized="false"
  1672. static="true" final="false" visibility="public"
  1673. deprecated="not deprecated">
  1674. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1675. <doc>
  1676. <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
  1677. algorithm implementation
  1678. (see <code>yarn.sharedcache.checksum.algo.impl</code>)
  1679. @return <code>SharedCacheChecksum</code> object]]>
  1680. </doc>
  1681. </method>
  1682. </class>
  1683. <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  1684. </package>
  1685. <package name="org.apache.hadoop.yarn.state">
  1686. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  1687. <class name="InvalidStateTransitionException" extends="org.apache.hadoop.yarn.state.InvalidStateTransitonException"
  1688. abstract="false"
  1689. static="false" final="false" visibility="public"
  1690. deprecated="not deprecated">
  1691. <constructor name="InvalidStateTransitionException" type="java.lang.Enum, java.lang.Enum"
  1692. static="false" final="false" visibility="public"
  1693. deprecated="not deprecated">
  1694. </constructor>
  1695. <doc>
  1696. <![CDATA[The exception that happens when you call invalid state transition.]]>
  1697. </doc>
  1698. </class>
  1699. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  1700. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  1701. <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  1702. abstract="false"
  1703. static="false" final="false" visibility="public"
  1704. deprecated="Use {@link InvalidStateTransitionException} instead.">
  1705. <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
  1706. static="false" final="false" visibility="public"
  1707. deprecated="not deprecated">
  1708. </constructor>
  1709. <method name="getCurrentState" return="java.lang.Enum"
  1710. abstract="false" native="false" synchronized="false"
  1711. static="false" final="false" visibility="public"
  1712. deprecated="not deprecated">
  1713. </method>
  1714. <method name="getEvent" return="java.lang.Enum"
  1715. abstract="false" native="false" synchronized="false"
  1716. static="false" final="false" visibility="public"
  1717. deprecated="not deprecated">
  1718. </method>
  1719. <doc>
  1720. <![CDATA[@deprecated Use {@link InvalidStateTransitionException} instead.]]>
  1721. </doc>
  1722. </class>
  1723. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  1724. <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  1725. <interface name="MultipleArcTransition" abstract="true"
  1726. static="false" final="false" visibility="public"
  1727. deprecated="not deprecated">
  1728. <method name="transition" return="STATE"
  1729. abstract="false" native="false" synchronized="false"
  1730. static="false" final="false" visibility="public"
  1731. deprecated="not deprecated">
  1732. <param name="operand" type="OPERAND"/>
  1733. <param name="event" type="EVENT"/>
  1734. <doc>
  1735. <![CDATA[Transition hook.
  1736. @return the postState. Post state must be one of the
  1737. valid post states registered in StateMachine.
  1738. @param operand the entity attached to the FSM, whose internal
  1739. state may change.
  1740. @param event causal event]]>
  1741. </doc>
  1742. </method>
  1743. <doc>
  1744. <![CDATA[Hook for Transition.
  1745. Post state is decided by Transition hook. Post state must be one of the
  1746. valid post states registered in StateMachine.]]>
  1747. </doc>
  1748. </interface>
  1749. <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  1750. <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  1751. <interface name="SingleArcTransition" abstract="true"
  1752. static="false" final="false" visibility="public"
  1753. deprecated="not deprecated">
  1754. <method name="transition"
  1755. abstract="false" native="false" synchronized="false"
  1756. static="false" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. <param name="operand" type="OPERAND"/>
  1759. <param name="event" type="EVENT"/>
  1760. <doc>
  1761. <![CDATA[Transition hook.
  1762. @param operand the entity attached to the FSM, whose internal
  1763. state may change.
  1764. @param event causal event]]>
  1765. </doc>
  1766. </method>
  1767. <doc>
  1768. <![CDATA[Hook for Transition. This lead to state machine to move to
  1769. the post state as registered in the state machine.]]>
  1770. </doc>
  1771. </interface>
  1772. <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  1773. <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
  1774. <interface name="StateMachine" abstract="true"
  1775. static="false" final="false" visibility="public"
  1776. deprecated="not deprecated">
  1777. <method name="getCurrentState" return="STATE"
  1778. abstract="false" native="false" synchronized="false"
  1779. static="false" final="false" visibility="public"
  1780. deprecated="not deprecated">
  1781. </method>
  1782. <method name="doTransition" return="STATE"
  1783. abstract="false" native="false" synchronized="false"
  1784. static="false" final="false" visibility="public"
  1785. deprecated="not deprecated">
  1786. <param name="eventType" type="EVENTTYPE"/>
  1787. <param name="event" type="EVENT"/>
  1788. <exception name="InvalidStateTransitionException" type="org.apache.hadoop.yarn.state.InvalidStateTransitionException"/>
  1789. </method>
  1790. </interface>
  1791. <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
  1792. <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
  1793. <class name="StateMachineFactory" extends="java.lang.Object"
  1794. abstract="false"
  1795. static="false" final="true" visibility="public"
  1796. deprecated="not deprecated">
  1797. <constructor name="StateMachineFactory" type="STATE"
  1798. static="false" final="false" visibility="public"
  1799. deprecated="not deprecated">
  1800. <doc>
  1801. <![CDATA[Constructor
  1802. This is the only constructor in the API.]]>
  1803. </doc>
  1804. </constructor>
  1805. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1806. abstract="false" native="false" synchronized="false"
  1807. static="false" final="false" visibility="public"
  1808. deprecated="not deprecated">
  1809. <param name="preState" type="STATE"/>
  1810. <param name="postState" type="STATE"/>
  1811. <param name="eventType" type="EVENTTYPE"/>
  1812. <doc>
  1813. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  1814. transition added as a new legal transition. This overload
  1815. has no hook object.
  1816. Note that the returned StateMachineFactory is a distinct
  1817. object.
  1818. This method is part of the API.
  1819. @param preState pre-transition state
  1820. @param postState post-transition state
  1821. @param eventType stimulus for the transition]]>
  1822. </doc>
  1823. </method>
  1824. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1825. abstract="false" native="false" synchronized="false"
  1826. static="false" final="false" visibility="public"
  1827. deprecated="not deprecated">
  1828. <param name="preState" type="STATE"/>
  1829. <param name="postState" type="STATE"/>
  1830. <param name="eventTypes" type="java.util.Set"/>
  1831. <doc>
  1832. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  1833. transition added as a new legal transition. This overload
  1834. has no hook object.
  1835. Note that the returned StateMachineFactory is a distinct
  1836. object.
  1837. This method is part of the API.
  1838. @param preState pre-transition state
  1839. @param postState post-transition state
  1840. @param eventTypes List of stimuli for the transitions]]>
  1841. </doc>
  1842. </method>
  1843. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1844. abstract="false" native="false" synchronized="false"
  1845. static="false" final="false" visibility="public"
  1846. deprecated="not deprecated">
  1847. <param name="preState" type="STATE"/>
  1848. <param name="postState" type="STATE"/>
  1849. <param name="eventTypes" type="java.util.Set"/>
  1850. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  1851. <doc>
  1852. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  1853. transition added as a new legal transition
  1854. Note that the returned StateMachineFactory is a distinct
  1855. object.
  1856. This method is part of the API.
  1857. @param preState pre-transition state
  1858. @param postState post-transition state
  1859. @param eventTypes List of stimuli for the transitions
  1860. @param hook transition hook]]>
  1861. </doc>
  1862. </method>
  1863. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1864. abstract="false" native="false" synchronized="false"
  1865. static="false" final="false" visibility="public"
  1866. deprecated="not deprecated">
  1867. <param name="preState" type="STATE"/>
  1868. <param name="postState" type="STATE"/>
  1869. <param name="eventType" type="EVENTTYPE"/>
  1870. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  1871. <doc>
  1872. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  1873. transition added as a new legal transition
  1874. Note that the returned StateMachineFactory is a distinct object.
  1875. This method is part of the API.
  1876. @param preState pre-transition state
  1877. @param postState post-transition state
  1878. @param eventType stimulus for the transition
  1879. @param hook transition hook]]>
  1880. </doc>
  1881. </method>
  1882. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1883. abstract="false" native="false" synchronized="false"
  1884. static="false" final="false" visibility="public"
  1885. deprecated="not deprecated">
  1886. <param name="preState" type="STATE"/>
  1887. <param name="postStates" type="java.util.Set"/>
  1888. <param name="eventType" type="EVENTTYPE"/>
  1889. <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
  1890. <doc>
  1891. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  1892. transition added as a new legal transition
  1893. Note that the returned StateMachineFactory is a distinct object.
  1894. This method is part of the API.
  1895. @param preState pre-transition state
  1896. @param postStates valid post-transition states
  1897. @param eventType stimulus for the transition
  1898. @param hook transition hook]]>
  1899. </doc>
  1900. </method>
  1901. <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  1902. abstract="false" native="false" synchronized="false"
  1903. static="false" final="false" visibility="public"
  1904. deprecated="not deprecated">
  1905. <doc>
  1906. <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
  1907. you won't need any synchronization to build a state machine
  1908. Note that the returned StateMachineFactory is a distinct object.
  1909. This method is part of the API.
  1910. The only way you could distinguish the returned
  1911. StateMachineFactory from {@code this} would be by
  1912. measuring the performance of the derived
  1913. {@code StateMachine} you can get from it.
  1914. Calling this is optional. It doesn't change the semantics of the factory,
  1915. if you call it then when you use the factory there is no synchronization.]]>
  1916. </doc>
  1917. </method>
  1918. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  1919. abstract="false" native="false" synchronized="false"
  1920. static="false" final="false" visibility="public"
  1921. deprecated="not deprecated">
  1922. <param name="operand" type="OPERAND"/>
  1923. <param name="initialState" type="STATE"/>
  1924. </method>
  1925. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  1926. abstract="false" native="false" synchronized="false"
  1927. static="false" final="false" visibility="public"
  1928. deprecated="not deprecated">
  1929. <param name="operand" type="OPERAND"/>
  1930. </method>
  1931. <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
  1932. abstract="false" native="false" synchronized="false"
  1933. static="false" final="false" visibility="public"
  1934. deprecated="not deprecated">
  1935. <param name="name" type="java.lang.String"/>
  1936. <doc>
  1937. <![CDATA[Generate a graph represents the state graph of this StateMachine
  1938. @param name graph name
  1939. @return Graph object generated]]>
  1940. </doc>
  1941. </method>
  1942. <doc>
  1943. <![CDATA[State machine topology.
  1944. This object is semantically immutable. If you have a
  1945. StateMachineFactory there's no operation in the API that changes
  1946. its semantic properties.
  1947. @param <OPERAND> The object type on which this state machine operates.
  1948. @param <STATE> The state of the entity.
  1949. @param <EVENTTYPE> The external eventType to be handled.
  1950. @param <EVENT> The event object.]]>
  1951. </doc>
  1952. </class>
  1953. <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
  1954. </package>
  1955. <package name="org.apache.hadoop.yarn.util">
  1956. <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  1957. <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
  1958. abstract="true"
  1959. static="false" final="false" visibility="public"
  1960. deprecated="not deprecated">
  1961. <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
  1962. static="false" final="false" visibility="public"
  1963. deprecated="not deprecated">
  1964. </constructor>
  1965. <constructor name="AbstractLivelinessMonitor" type="java.lang.String"
  1966. static="false" final="false" visibility="public"
  1967. deprecated="not deprecated">
  1968. </constructor>
  1969. <method name="serviceStart"
  1970. abstract="false" native="false" synchronized="false"
  1971. static="false" final="false" visibility="protected"
  1972. deprecated="not deprecated">
  1973. <exception name="Exception" type="java.lang.Exception"/>
  1974. </method>
  1975. <method name="serviceStop"
  1976. abstract="false" native="false" synchronized="false"
  1977. static="false" final="false" visibility="protected"
  1978. deprecated="not deprecated">
  1979. <exception name="Exception" type="java.lang.Exception"/>
  1980. </method>
  1981. <method name="expire"
  1982. abstract="true" native="false" synchronized="false"
  1983. static="false" final="false" visibility="protected"
  1984. deprecated="not deprecated">
  1985. <param name="ob" type="O"/>
  1986. </method>
  1987. <method name="setExpireInterval"
  1988. abstract="false" native="false" synchronized="false"
  1989. static="false" final="false" visibility="protected"
  1990. deprecated="not deprecated">
  1991. <param name="expireInterval" type="int"/>
  1992. </method>
  1993. <method name="setMonitorInterval"
  1994. abstract="false" native="false" synchronized="false"
  1995. static="false" final="false" visibility="protected"
  1996. deprecated="not deprecated">
  1997. <param name="monitorInterval" type="int"/>
  1998. </method>
  1999. <method name="receivedPing"
  2000. abstract="false" native="false" synchronized="true"
  2001. static="false" final="false" visibility="public"
  2002. deprecated="not deprecated">
  2003. <param name="ob" type="O"/>
  2004. </method>
  2005. <method name="register"
  2006. abstract="false" native="false" synchronized="true"
  2007. static="false" final="false" visibility="public"
  2008. deprecated="not deprecated">
  2009. <param name="ob" type="O"/>
  2010. </method>
  2011. <method name="unregister"
  2012. abstract="false" native="false" synchronized="true"
  2013. static="false" final="false" visibility="public"
  2014. deprecated="not deprecated">
  2015. <param name="ob" type="O"/>
  2016. </method>
  2017. <method name="resetTimer"
  2018. abstract="false" native="false" synchronized="true"
  2019. static="false" final="false" visibility="public"
  2020. deprecated="not deprecated">
  2021. </method>
  2022. <field name="DEFAULT_EXPIRE" type="int"
  2023. transient="false" volatile="false"
  2024. static="true" final="true" visibility="public"
  2025. deprecated="not deprecated">
  2026. </field>
  2027. <doc>
  2028. <![CDATA[A simple liveliness monitor with which clients can register, trust the
  2029. component to monitor liveliness, get a call-back on expiry and then finally
  2030. unregister.]]>
  2031. </doc>
  2032. </class>
  2033. <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2034. <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2035. <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
  2036. abstract="false"
  2037. static="false" final="false" visibility="public"
  2038. deprecated="not deprecated">
  2039. <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
  2040. static="false" final="false" visibility="public"
  2041. deprecated="not deprecated">
  2042. </constructor>
  2043. <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
  2044. static="false" final="false" visibility="public"
  2045. deprecated="not deprecated">
  2046. <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
  2047. </constructor>
  2048. <doc>
  2049. <![CDATA[This type has been deprecated in favor of
  2050. {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
  2051. ApplicationClassLoader should use that type instead.]]>
  2052. </doc>
  2053. </class>
  2054. <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2055. <!-- start interface org.apache.hadoop.yarn.util.Clock -->
  2056. <interface name="Clock" abstract="true"
  2057. static="false" final="false" visibility="public"
  2058. deprecated="not deprecated">
  2059. <method name="getTime" return="long"
  2060. abstract="false" native="false" synchronized="false"
  2061. static="false" final="false" visibility="public"
  2062. deprecated="not deprecated">
  2063. </method>
  2064. <doc>
  2065. <![CDATA[A simple clock interface that gives you time.]]>
  2066. </doc>
  2067. </interface>
  2068. <!-- end interface org.apache.hadoop.yarn.util.Clock -->
  2069. <!-- start class org.apache.hadoop.yarn.util.ConverterUtils -->
  2070. <class name="ConverterUtils" extends="java.lang.Object"
  2071. abstract="false"
  2072. static="false" final="false" visibility="public"
  2073. deprecated="not deprecated">
  2074. <constructor name="ConverterUtils"
  2075. static="false" final="false" visibility="public"
  2076. deprecated="not deprecated">
  2077. </constructor>
  2078. <method name="getPathFromYarnURL" return="org.apache.hadoop.fs.Path"
  2079. abstract="false" native="false" synchronized="false"
  2080. static="true" final="false" visibility="public"
  2081. deprecated="not deprecated">
  2082. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  2083. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  2084. <doc>
  2085. <![CDATA[return a hadoop path from a given url
  2086. This method is deprecated, use {@link URL#toPath()} instead.
  2087. @param url
  2088. url to convert
  2089. @return path from {@link URL}
  2090. @throws URISyntaxException]]>
  2091. </doc>
  2092. </method>
  2093. <method name="getYarnUrlFromPath" return="org.apache.hadoop.yarn.api.records.URL"
  2094. abstract="false" native="false" synchronized="false"
  2095. static="true" final="false" visibility="public"
  2096. deprecated="not deprecated">
  2097. <param name="path" type="org.apache.hadoop.fs.Path"/>
  2098. </method>
  2099. <method name="getYarnUrlFromURI" return="org.apache.hadoop.yarn.api.records.URL"
  2100. abstract="false" native="false" synchronized="false"
  2101. static="true" final="false" visibility="public"
  2102. deprecated="not deprecated">
  2103. <param name="uri" type="java.net.URI"/>
  2104. </method>
  2105. <method name="toString" return="java.lang.String"
  2106. abstract="false" native="false" synchronized="false"
  2107. static="true" final="false" visibility="public"
  2108. deprecated="not deprecated">
  2109. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2110. </method>
  2111. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2112. abstract="false" native="false" synchronized="false"
  2113. static="true" final="false" visibility="public"
  2114. deprecated="not deprecated">
  2115. <param name="recordFactory" type="org.apache.hadoop.yarn.factories.RecordFactory"/>
  2116. <param name="applicationIdStr" type="java.lang.String"/>
  2117. </method>
  2118. <method name="toString" return="java.lang.String"
  2119. abstract="false" native="false" synchronized="false"
  2120. static="true" final="false" visibility="public"
  2121. deprecated="not deprecated">
  2122. <param name="cId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2123. </method>
  2124. <method name="toNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  2125. abstract="false" native="false" synchronized="false"
  2126. static="true" final="false" visibility="public"
  2127. deprecated="not deprecated">
  2128. <param name="nodeIdStr" type="java.lang.String"/>
  2129. </method>
  2130. <method name="toContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2131. abstract="false" native="false" synchronized="false"
  2132. static="true" final="false" visibility="public"
  2133. deprecated="not deprecated">
  2134. <param name="containerIdStr" type="java.lang.String"/>
  2135. </method>
  2136. <method name="toApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2137. abstract="false" native="false" synchronized="false"
  2138. static="true" final="false" visibility="public"
  2139. deprecated="not deprecated">
  2140. <param name="applicationAttemptIdStr" type="java.lang.String"/>
  2141. </method>
  2142. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2143. abstract="false" native="false" synchronized="false"
  2144. static="true" final="false" visibility="public"
  2145. deprecated="not deprecated">
  2146. <param name="appIdStr" type="java.lang.String"/>
  2147. </method>
  2148. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  2149. abstract="false" native="false" synchronized="false"
  2150. static="true" final="false" visibility="public"
  2151. deprecated="not deprecated">
  2152. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  2153. <param name="serviceAddr" type="java.net.InetSocketAddress"/>
  2154. <doc>
  2155. <![CDATA[Convert a protobuf token into a rpc token and set its service. Supposed
  2156. to be used for tokens other than RMDelegationToken. For
  2157. RMDelegationToken, use
  2158. {@link #convertFromYarn(org.apache.hadoop.yarn.api.records.Token,
  2159. org.apache.hadoop.io.Text)} instead.
  2160. @param protoToken the yarn token
  2161. @param serviceAddr the connect address for the service
  2162. @return rpc token]]>
  2163. </doc>
  2164. </method>
  2165. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  2166. abstract="false" native="false" synchronized="false"
  2167. static="true" final="false" visibility="public"
  2168. deprecated="not deprecated">
  2169. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  2170. <param name="service" type="org.apache.hadoop.io.Text"/>
  2171. <doc>
  2172. <![CDATA[Convert a protobuf token into a rpc token and set its service.
  2173. @param protoToken the yarn token
  2174. @param service the service for the token]]>
  2175. </doc>
  2176. </method>
  2177. <field name="APPLICATION_PREFIX" type="java.lang.String"
  2178. transient="false" volatile="false"
  2179. static="true" final="true" visibility="public"
  2180. deprecated="not deprecated">
  2181. </field>
  2182. <field name="CONTAINER_PREFIX" type="java.lang.String"
  2183. transient="false" volatile="false"
  2184. static="true" final="true" visibility="public"
  2185. deprecated="not deprecated">
  2186. </field>
  2187. <field name="APPLICATION_ATTEMPT_PREFIX" type="java.lang.String"
  2188. transient="false" volatile="false"
  2189. static="true" final="true" visibility="public"
  2190. deprecated="not deprecated">
  2191. </field>
  2192. <doc>
  2193. <![CDATA[This class contains a set of utilities which help converting data structures
  2194. from/to 'serializableFormat' to/from hadoop/nativejava data structures.]]>
  2195. </doc>
  2196. </class>
  2197. <!-- end class org.apache.hadoop.yarn.util.ConverterUtils -->
  2198. <!-- start class org.apache.hadoop.yarn.util.MonotonicClock -->
  2199. <class name="MonotonicClock" extends="java.lang.Object"
  2200. abstract="false"
  2201. static="false" final="false" visibility="public"
  2202. deprecated="not deprecated">
  2203. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  2204. <constructor name="MonotonicClock"
  2205. static="false" final="false" visibility="public"
  2206. deprecated="not deprecated">
  2207. </constructor>
  2208. <method name="getTime" return="long"
  2209. abstract="false" native="false" synchronized="false"
  2210. static="false" final="false" visibility="public"
  2211. deprecated="not deprecated">
  2212. <doc>
  2213. <![CDATA[Get current time from some arbitrary time base in the past, counting in
  2214. milliseconds, and not affected by settimeofday or similar system clock
  2215. changes.
  2216. @return a monotonic clock that counts in milliseconds.]]>
  2217. </doc>
  2218. </method>
  2219. <doc>
  2220. <![CDATA[A monotonic clock from some arbitrary time base in the past, counting in
  2221. milliseconds, and not affected by settimeofday or similar system clock
  2222. changes.
  2223. This is appropriate to use when computing how much longer to wait for an
  2224. interval to expire.
  2225. This function can return a negative value and it must be handled correctly
  2226. by callers. See the documentation of System#nanoTime for caveats.]]>
  2227. </doc>
  2228. </class>
  2229. <!-- end class org.apache.hadoop.yarn.util.MonotonicClock -->
  2230. <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  2231. <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
  2232. abstract="true"
  2233. static="false" final="false" visibility="public"
  2234. deprecated="not deprecated">
  2235. <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
  2236. static="false" final="false" visibility="public"
  2237. deprecated="not deprecated">
  2238. <doc>
  2239. <![CDATA[Create process-tree instance with specified root process.
  2240. Subclass must override this.
  2241. @param root process-tree root-process]]>
  2242. </doc>
  2243. </constructor>
  2244. <method name="updateProcessTree"
  2245. abstract="true" native="false" synchronized="false"
  2246. static="false" final="false" visibility="public"
  2247. deprecated="not deprecated">
  2248. <doc>
  2249. <![CDATA[Update the process-tree with latest state.
  2250. Each call to this function should increment the age of the running
  2251. processes that already exist in the process tree. Age is used other API's
  2252. of the interface.]]>
  2253. </doc>
  2254. </method>
  2255. <method name="getProcessTreeDump" return="java.lang.String"
  2256. abstract="true" native="false" synchronized="false"
  2257. static="false" final="false" visibility="public"
  2258. deprecated="not deprecated">
  2259. <doc>
  2260. <![CDATA[Get a dump of the process-tree.
  2261. @return a string concatenating the dump of information of all the processes
  2262. in the process-tree]]>
  2263. </doc>
  2264. </method>
  2265. <method name="getVirtualMemorySize" return="long"
  2266. abstract="false" native="false" synchronized="false"
  2267. static="false" final="false" visibility="public"
  2268. deprecated="not deprecated">
  2269. <doc>
  2270. <![CDATA[Get the virtual memory used by all the processes in the
  2271. process-tree.
  2272. @return virtual memory used by the process-tree in bytes,
  2273. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2274. </doc>
  2275. </method>
  2276. <method name="getCumulativeVmem" return="long"
  2277. abstract="false" native="false" synchronized="false"
  2278. static="false" final="false" visibility="public"
  2279. deprecated="not deprecated">
  2280. <doc>
  2281. <![CDATA[Get the virtual memory used by all the processes in the
  2282. process-tree.
  2283. @return virtual memory used by the process-tree in bytes,
  2284. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2285. </doc>
  2286. </method>
  2287. <method name="getRssMemorySize" return="long"
  2288. abstract="false" native="false" synchronized="false"
  2289. static="false" final="false" visibility="public"
  2290. deprecated="not deprecated">
  2291. <doc>
  2292. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2293. in the process-tree.
  2294. @return rss memory used by the process-tree in bytes,
  2295. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2296. </doc>
  2297. </method>
  2298. <method name="getCumulativeRssmem" return="long"
  2299. abstract="false" native="false" synchronized="false"
  2300. static="false" final="false" visibility="public"
  2301. deprecated="not deprecated">
  2302. <doc>
  2303. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2304. in the process-tree.
  2305. @return rss memory used by the process-tree in bytes,
  2306. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2307. </doc>
  2308. </method>
  2309. <method name="getVirtualMemorySize" return="long"
  2310. abstract="false" native="false" synchronized="false"
  2311. static="false" final="false" visibility="public"
  2312. deprecated="not deprecated">
  2313. <param name="olderThanAge" type="int"/>
  2314. <doc>
  2315. <![CDATA[Get the virtual memory used by all the processes in the
  2316. process-tree that are older than the passed in age.
  2317. @param olderThanAge processes above this age are included in the
  2318. memory addition
  2319. @return virtual memory used by the process-tree in bytes for
  2320. processes older than the specified age, {@link #UNAVAILABLE} if it
  2321. cannot be calculated.]]>
  2322. </doc>
  2323. </method>
  2324. <method name="getCumulativeVmem" return="long"
  2325. abstract="false" native="false" synchronized="false"
  2326. static="false" final="false" visibility="public"
  2327. deprecated="not deprecated">
  2328. <param name="olderThanAge" type="int"/>
  2329. <doc>
  2330. <![CDATA[Get the virtual memory used by all the processes in the
  2331. process-tree that are older than the passed in age.
  2332. @param olderThanAge processes above this age are included in the
  2333. memory addition
  2334. @return virtual memory used by the process-tree in bytes for
  2335. processes older than the specified age, {@link #UNAVAILABLE} if it
  2336. cannot be calculated.]]>
  2337. </doc>
  2338. </method>
  2339. <method name="getRssMemorySize" return="long"
  2340. abstract="false" native="false" synchronized="false"
  2341. static="false" final="false" visibility="public"
  2342. deprecated="not deprecated">
  2343. <param name="olderThanAge" type="int"/>
  2344. <doc>
  2345. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2346. in the process-tree that are older than the passed in age.
  2347. @param olderThanAge processes above this age are included in the
  2348. memory addition
  2349. @return rss memory used by the process-tree in bytes for
  2350. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  2351. calculated.]]>
  2352. </doc>
  2353. </method>
  2354. <method name="getCumulativeRssmem" return="long"
  2355. abstract="false" native="false" synchronized="false"
  2356. static="false" final="false" visibility="public"
  2357. deprecated="not deprecated">
  2358. <param name="olderThanAge" type="int"/>
  2359. <doc>
  2360. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2361. in the process-tree that are older than the passed in age.
  2362. @param olderThanAge processes above this age are included in the
  2363. memory addition
  2364. @return rss memory used by the process-tree in bytes for
  2365. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  2366. calculated.]]>
  2367. </doc>
  2368. </method>
  2369. <method name="getCumulativeCpuTime" return="long"
  2370. abstract="false" native="false" synchronized="false"
  2371. static="false" final="false" visibility="public"
  2372. deprecated="not deprecated">
  2373. <doc>
  2374. <![CDATA[Get the CPU time in millisecond used by all the processes in the
  2375. process-tree since the process-tree was created
  2376. @return cumulative CPU time in millisecond since the process-tree
  2377. created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2378. </doc>
  2379. </method>
  2380. <method name="getCpuUsagePercent" return="float"
  2381. abstract="false" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. <doc>
  2385. <![CDATA[Get the CPU usage by all the processes in the process-tree based on
  2386. average between samples as a ratio of overall CPU cycles similar to top.
  2387. Thus, if 2 out of 4 cores are used this should return 200.0.
  2388. @return percentage CPU usage since the process-tree was created,
  2389. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2390. </doc>
  2391. </method>
  2392. <method name="checkPidPgrpidForMatch" return="boolean"
  2393. abstract="true" native="false" synchronized="false"
  2394. static="false" final="false" visibility="public"
  2395. deprecated="not deprecated">
  2396. <doc>
  2397. <![CDATA[Verify that the tree process id is same as its process group id.
  2398. @return true if the process id matches else return false.]]>
  2399. </doc>
  2400. </method>
  2401. <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
  2402. abstract="false" native="false" synchronized="false"
  2403. static="true" final="false" visibility="public"
  2404. deprecated="not deprecated">
  2405. <param name="pid" type="java.lang.String"/>
  2406. <param name="clazz" type="java.lang.Class"/>
  2407. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2408. <doc>
  2409. <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
  2410. from the class name and configure it. If class name is null, this method
  2411. will try and return a process tree plugin available for this system.
  2412. @param pid process pid of the root of the process tree
  2413. @param clazz class-name
  2414. @param conf configure the plugin with this.
  2415. @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
  2416. is not available for this system.]]>
  2417. </doc>
  2418. </method>
  2419. <field name="UNAVAILABLE" type="int"
  2420. transient="false" volatile="false"
  2421. static="true" final="true" visibility="public"
  2422. deprecated="not deprecated">
  2423. </field>
  2424. <doc>
  2425. <![CDATA[Interface class to obtain process resource usage
  2426. NOTE: This class should not be used by external users, but only by external
  2427. developers to extend and include their own process-tree implementation,
  2428. especially for platforms other than Linux and Windows.]]>
  2429. </doc>
  2430. </class>
  2431. <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  2432. <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
  2433. <class name="SystemClock" extends="java.lang.Object"
  2434. abstract="false"
  2435. static="false" final="false" visibility="public"
  2436. deprecated="not deprecated">
  2437. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  2438. <constructor name="SystemClock"
  2439. static="false" final="false" visibility="public"
  2440. deprecated="not deprecated">
  2441. </constructor>
  2442. <method name="getTime" return="long"
  2443. abstract="false" native="false" synchronized="false"
  2444. static="false" final="false" visibility="public"
  2445. deprecated="not deprecated">
  2446. </method>
  2447. <doc>
  2448. <![CDATA[Implementation of {@link Clock} that gives the current time from the system
  2449. clock in milliseconds.
  2450. NOTE: Do not use this to calculate a duration of expire or interval to sleep,
  2451. because it will be broken by settimeofday. Please use {@link MonotonicClock}
  2452. instead.]]>
  2453. </doc>
  2454. </class>
  2455. <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
  2456. <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
  2457. <class name="UTCClock" extends="java.lang.Object"
  2458. abstract="false"
  2459. static="false" final="false" visibility="public"
  2460. deprecated="not deprecated">
  2461. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  2462. <constructor name="UTCClock"
  2463. static="false" final="false" visibility="public"
  2464. deprecated="not deprecated">
  2465. </constructor>
  2466. <method name="getTime" return="long"
  2467. abstract="false" native="false" synchronized="false"
  2468. static="false" final="false" visibility="public"
  2469. deprecated="not deprecated">
  2470. </method>
  2471. <doc>
  2472. <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
  2473. milliseconds.]]>
  2474. </doc>
  2475. </class>
  2476. <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
  2477. </package>
  2478. <package name="org.apache.hadoop.yarn.util.resource">
  2479. </package>
  2480. <package name="org.apache.hadoop.yarn.util.timeline">
  2481. <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  2482. <class name="TimelineUtils" extends="java.lang.Object"
  2483. abstract="false"
  2484. static="false" final="false" visibility="public"
  2485. deprecated="not deprecated">
  2486. <constructor name="TimelineUtils"
  2487. static="false" final="false" visibility="public"
  2488. deprecated="not deprecated">
  2489. </constructor>
  2490. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  2491. abstract="false" native="false" synchronized="false"
  2492. static="true" final="false" visibility="public"
  2493. deprecated="not deprecated">
  2494. <param name="o" type="java.lang.Object"/>
  2495. <exception name="JsonGenerationException" type="org.codehaus.jackson.JsonGenerationException"/>
  2496. <exception name="JsonMappingException" type="org.codehaus.jackson.map.JsonMappingException"/>
  2497. <exception name="IOException" type="java.io.IOException"/>
  2498. <doc>
  2499. <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
  2500. @param o
  2501. an object to serialize
  2502. @return a JSON string
  2503. @throws IOException
  2504. @throws JsonMappingException
  2505. @throws JsonGenerationException]]>
  2506. </doc>
  2507. </method>
  2508. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  2509. abstract="false" native="false" synchronized="false"
  2510. static="true" final="false" visibility="public"
  2511. deprecated="not deprecated">
  2512. <param name="o" type="java.lang.Object"/>
  2513. <param name="pretty" type="boolean"/>
  2514. <exception name="JsonGenerationException" type="org.codehaus.jackson.JsonGenerationException"/>
  2515. <exception name="JsonMappingException" type="org.codehaus.jackson.map.JsonMappingException"/>
  2516. <exception name="IOException" type="java.io.IOException"/>
  2517. <doc>
  2518. <![CDATA[Serialize a POJO object into a JSON string
  2519. @param o
  2520. an object to serialize
  2521. @param pretty
  2522. whether in a pretty format or not
  2523. @return a JSON string
  2524. @throws IOException
  2525. @throws JsonMappingException
  2526. @throws JsonGenerationException]]>
  2527. </doc>
  2528. </method>
  2529. <method name="timelineServiceEnabled" return="boolean"
  2530. abstract="false" native="false" synchronized="false"
  2531. static="true" final="false" visibility="public"
  2532. deprecated="not deprecated">
  2533. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2534. <doc>
  2535. <![CDATA[Returns whether the timeline service is enabled via configuration.
  2536. @param conf the configuration
  2537. @return whether the timeline service is enabled.]]>
  2538. </doc>
  2539. </method>
  2540. <method name="getTimelineServiceVersion" return="float"
  2541. abstract="false" native="false" synchronized="false"
  2542. static="true" final="false" visibility="public"
  2543. deprecated="not deprecated">
  2544. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2545. <doc>
  2546. <![CDATA[Returns the timeline service version. It does not check whether the
  2547. timeline service itself is enabled.
  2548. @param conf the configuration
  2549. @return the timeline service version as a float.]]>
  2550. </doc>
  2551. </method>
  2552. <method name="timelineServiceV1_5Enabled" return="boolean"
  2553. abstract="false" native="false" synchronized="false"
  2554. static="true" final="false" visibility="public"
  2555. deprecated="not deprecated">
  2556. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2557. <doc>
  2558. <![CDATA[Returns whether the timeline service v.1.5 is enabled via configuration.
  2559. @param conf the configuration
  2560. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  2561. version equal to 1.5.]]>
  2562. </doc>
  2563. </method>
  2564. <method name="createTimelineAbout" return="org.apache.hadoop.yarn.api.records.timeline.TimelineAbout"
  2565. abstract="false" native="false" synchronized="false"
  2566. static="true" final="false" visibility="public"
  2567. deprecated="not deprecated">
  2568. <param name="about" type="java.lang.String"/>
  2569. </method>
  2570. <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
  2571. abstract="false" native="false" synchronized="false"
  2572. static="true" final="false" visibility="public"
  2573. deprecated="not deprecated">
  2574. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2575. </method>
  2576. <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
  2577. abstract="false" native="false" synchronized="false"
  2578. static="true" final="false" visibility="public"
  2579. deprecated="not deprecated">
  2580. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2581. </method>
  2582. <doc>
  2583. <![CDATA[The helper class for the timeline module.]]>
  2584. </doc>
  2585. </class>
  2586. <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  2587. </package>
  2588. <package name="org.apache.hadoop.yarn.webapp.util">
  2589. </package>
  2590. </api>