Apache_Hadoop_YARN_Common_2.10.0.xml 135 KB

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