Apache_Hadoop_YARN_Common_2.7.2.xml 152 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323
  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 Thu May 12 17:47:43 PDT 2016 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="hadoop-yarn-common 2.7.2"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -verbose -classpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/classes:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-common-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/vinodkv/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/vinodkv/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/vinodkv/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/vinodkv/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/vinodkv/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/vinodkv/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/vinodkv/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/vinodkv/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/vinodkv/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-log4j12/1.7.10/slf4j-log4j12-1.7.10.jar:/Users/vinodkv/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/vinodkv/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/vinodkv/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/vinodkv/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/Users/vinodkv/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/Users/vinodkv/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/Users/vinodkv/.m2/repository/org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar:/Users/vinodkv/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/vinodkv/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-yarn-api-2.7.2.jar:/Users/vinodkv/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/vinodkv/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/vinodkv/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/vinodkv/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/vinodkv/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/vinodkv/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/vinodkv/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-client/1.9/jersey-client-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/vinodkv/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/vinodkv/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/vinodkv/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.7.2.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home/lib/tools.jar:/Users/vinodkv/.m2/repository/com/google/inject/extensions/guice-servlet/3.0/guice-servlet-3.0.jar:/Users/vinodkv/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/Users/vinodkv/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/vinodkv/.m2/repository/com/google/inject/guice/3.0/guice-3.0.jar:/Users/vinodkv/.m2/repository/javax/inject/javax.inject/1/javax.inject-1.jar:/Users/vinodkv/.m2/repository/aopalliance/aopalliance/1.0/aopalliance-1.0.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/vinodkv/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/vinodkv/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/contribs/jersey-guice/1.9/jersey-guice-1.9.jar:/Users/vinodkv/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar -sourcepath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java -apidir /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/site/jdiff/xml -apiname hadoop-yarn-common 2.7.2 -->
  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.RMHAServiceTarget -->
  268. <class name="RMHAServiceTarget" extends="org.apache.hadoop.ha.HAServiceTarget"
  269. abstract="false"
  270. static="false" final="false" visibility="public"
  271. deprecated="not deprecated">
  272. <constructor name="RMHAServiceTarget" type="org.apache.hadoop.yarn.conf.YarnConfiguration"
  273. static="false" final="false" visibility="public"
  274. deprecated="not deprecated">
  275. <exception name="IOException" type="java.io.IOException"/>
  276. </constructor>
  277. <method name="getAddress" return="java.net.InetSocketAddress"
  278. abstract="false" native="false" synchronized="false"
  279. static="false" final="false" visibility="public"
  280. deprecated="not deprecated">
  281. </method>
  282. <method name="getZKFCAddress" return="java.net.InetSocketAddress"
  283. abstract="false" native="false" synchronized="false"
  284. static="false" final="false" visibility="public"
  285. deprecated="not deprecated">
  286. </method>
  287. <method name="getFencer" return="org.apache.hadoop.ha.NodeFencer"
  288. abstract="false" native="false" synchronized="false"
  289. static="false" final="false" visibility="public"
  290. deprecated="not deprecated">
  291. </method>
  292. <method name="checkFencingConfigured"
  293. abstract="false" native="false" synchronized="false"
  294. static="false" final="false" visibility="public"
  295. deprecated="not deprecated">
  296. <exception name="BadFencingConfigurationException" type="org.apache.hadoop.ha.BadFencingConfigurationException"/>
  297. </method>
  298. <method name="isAutoFailoverEnabled" return="boolean"
  299. abstract="false" native="false" synchronized="false"
  300. static="false" final="false" visibility="public"
  301. deprecated="not deprecated">
  302. </method>
  303. </class>
  304. <!-- end class org.apache.hadoop.yarn.client.RMHAServiceTarget -->
  305. <!-- start class org.apache.hadoop.yarn.client.RMProxy -->
  306. <class name="RMProxy" extends="java.lang.Object"
  307. abstract="false"
  308. static="false" final="false" visibility="public"
  309. deprecated="not deprecated">
  310. <constructor name="RMProxy"
  311. static="false" final="false" visibility="protected"
  312. deprecated="not deprecated">
  313. </constructor>
  314. <method name="createRMProxy" return="T"
  315. abstract="false" native="false" synchronized="false"
  316. static="true" final="false" visibility="public"
  317. deprecated="This method is deprecated and is not used by YARN internally any more.
  318. To create a proxy to the RM, use ClientRMProxy#createRMProxy or
  319. ServerRMProxy#createRMProxy.
  320. Create a proxy to the ResourceManager at the specified address.">
  321. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  322. <param name="protocol" type="java.lang.Class"/>
  323. <param name="rmAddress" type="java.net.InetSocketAddress"/>
  324. <exception name="IOException" type="java.io.IOException"/>
  325. <doc>
  326. <![CDATA[@deprecated
  327. This method is deprecated and is not used by YARN internally any more.
  328. To create a proxy to the RM, use ClientRMProxy#createRMProxy or
  329. ServerRMProxy#createRMProxy.
  330. Create a proxy to the ResourceManager at the specified address.
  331. @param conf Configuration to generate retry policy
  332. @param protocol Protocol for the proxy
  333. @param rmAddress Address of the ResourceManager
  334. @param <T> Type information of the proxy
  335. @return Proxy to the RM
  336. @throws IOException]]>
  337. </doc>
  338. </method>
  339. </class>
  340. <!-- end class org.apache.hadoop.yarn.client.RMProxy -->
  341. <!-- start class org.apache.hadoop.yarn.client.ServerProxy -->
  342. <class name="ServerProxy" extends="java.lang.Object"
  343. abstract="false"
  344. static="false" final="false" visibility="public"
  345. deprecated="not deprecated">
  346. <constructor name="ServerProxy"
  347. static="false" final="false" visibility="public"
  348. deprecated="not deprecated">
  349. </constructor>
  350. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  351. abstract="false" native="false" synchronized="false"
  352. static="true" final="false" visibility="protected"
  353. deprecated="not deprecated">
  354. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  355. <param name="maxWaitTimeStr" type="java.lang.String"/>
  356. <param name="defMaxWaitTime" type="long"/>
  357. <param name="connectRetryIntervalStr" type="java.lang.String"/>
  358. <param name="defRetryInterval" type="long"/>
  359. </method>
  360. <method name="createRetriableProxy" return="T"
  361. abstract="false" native="false" synchronized="false"
  362. static="true" final="false" visibility="protected"
  363. deprecated="not deprecated">
  364. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  365. <param name="protocol" type="java.lang.Class"/>
  366. <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
  367. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  368. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  369. <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
  370. </method>
  371. </class>
  372. <!-- end class org.apache.hadoop.yarn.client.ServerProxy -->
  373. </package>
  374. <package name="org.apache.hadoop.yarn.client.api">
  375. <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
  376. <class name="TimelineClient" extends="org.apache.hadoop.service.AbstractService"
  377. abstract="true"
  378. static="false" final="false" visibility="public"
  379. deprecated="not deprecated">
  380. <constructor name="TimelineClient" type="java.lang.String"
  381. static="false" final="false" visibility="protected"
  382. deprecated="not deprecated">
  383. </constructor>
  384. <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
  385. abstract="false" native="false" synchronized="false"
  386. static="true" final="false" visibility="public"
  387. deprecated="not deprecated">
  388. <doc>
  389. <![CDATA[Create a timeline client. The current UGI when the user initialize the
  390. client will be used to do the put and the delegation token operations. The
  391. current user may use {@link UserGroupInformation#doAs} another user to
  392. construct and initialize a timeline client if the following operations are
  393. supposed to be conducted by that user.
  394. @return a timeline client]]>
  395. </doc>
  396. </method>
  397. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  398. abstract="true" native="false" synchronized="false"
  399. static="false" final="false" visibility="public"
  400. deprecated="not deprecated">
  401. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  402. <exception name="IOException" type="java.io.IOException"/>
  403. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  404. <doc>
  405. <![CDATA[<p>
  406. Send the information of a number of conceptual entities to the timeline
  407. server. It is a blocking API. The method will not return until it gets the
  408. response from the timeline server.
  409. </p>
  410. @param entities
  411. the collection of {@link TimelineEntity}
  412. @return the error information if the sent entities are not correctly stored
  413. @throws IOException
  414. @throws YarnException]]>
  415. </doc>
  416. </method>
  417. <method name="putDomain"
  418. abstract="true" native="false" synchronized="false"
  419. static="false" final="false" visibility="public"
  420. deprecated="not deprecated">
  421. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  422. <exception name="IOException" type="java.io.IOException"/>
  423. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  424. <doc>
  425. <![CDATA[<p>
  426. Send the information of a domain to the timeline server. It is a
  427. blocking API. The method will not return until it gets the response from
  428. the timeline server.
  429. </p>
  430. @param domain
  431. an {@link TimelineDomain} object
  432. @throws IOException
  433. @throws YarnException]]>
  434. </doc>
  435. </method>
  436. <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
  437. abstract="true" native="false" synchronized="false"
  438. static="false" final="false" visibility="public"
  439. deprecated="not deprecated">
  440. <param name="renewer" type="java.lang.String"/>
  441. <exception name="IOException" type="java.io.IOException"/>
  442. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  443. <doc>
  444. <![CDATA[<p>
  445. Get a delegation token so as to be able to talk to the timeline server in a
  446. secure way.
  447. </p>
  448. @param renewer
  449. Address of the renewer who can renew these tokens when needed by
  450. securely talking to the timeline server
  451. @return a delegation token ({@link Token}) that can be used to talk to the
  452. timeline server
  453. @throws IOException
  454. @throws YarnException]]>
  455. </doc>
  456. </method>
  457. <method name="renewDelegationToken" return="long"
  458. abstract="true" native="false" synchronized="false"
  459. static="false" final="false" visibility="public"
  460. deprecated="not deprecated">
  461. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  462. <exception name="IOException" type="java.io.IOException"/>
  463. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  464. <doc>
  465. <![CDATA[<p>
  466. Renew a timeline delegation token.
  467. </p>
  468. @param timelineDT
  469. the delegation token to renew
  470. @return the new expiration time
  471. @throws IOException
  472. @throws YarnException]]>
  473. </doc>
  474. </method>
  475. <method name="cancelDelegationToken"
  476. abstract="true" native="false" synchronized="false"
  477. static="false" final="false" visibility="public"
  478. deprecated="not deprecated">
  479. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  480. <exception name="IOException" type="java.io.IOException"/>
  481. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  482. <doc>
  483. <![CDATA[<p>
  484. Cancel a timeline delegation token.
  485. </p>
  486. @param timelineDT
  487. the delegation token to cancel
  488. @throws IOException
  489. @throws YarnException]]>
  490. </doc>
  491. </method>
  492. <doc>
  493. <![CDATA[A client library that can be used to post some information in terms of a
  494. number of conceptual entities.]]>
  495. </doc>
  496. </class>
  497. <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
  498. </package>
  499. <package name="org.apache.hadoop.yarn.client.api.impl">
  500. </package>
  501. <package name="org.apache.hadoop.yarn.event">
  502. <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
  503. <class name="AbstractEvent" extends="java.lang.Object"
  504. abstract="true"
  505. static="false" final="false" visibility="public"
  506. deprecated="not deprecated">
  507. <implements name="org.apache.hadoop.yarn.event.Event"/>
  508. <constructor name="AbstractEvent" type="TYPE"
  509. static="false" final="false" visibility="public"
  510. deprecated="not deprecated">
  511. </constructor>
  512. <constructor name="AbstractEvent" type="TYPE, long"
  513. static="false" final="false" visibility="public"
  514. deprecated="not deprecated">
  515. </constructor>
  516. <method name="getTimestamp" return="long"
  517. abstract="false" native="false" synchronized="false"
  518. static="false" final="false" visibility="public"
  519. deprecated="not deprecated">
  520. </method>
  521. <method name="getType" return="TYPE"
  522. abstract="false" native="false" synchronized="false"
  523. static="false" final="false" visibility="public"
  524. deprecated="not deprecated">
  525. </method>
  526. <method name="toString" return="java.lang.String"
  527. abstract="false" native="false" synchronized="false"
  528. static="false" final="false" visibility="public"
  529. deprecated="not deprecated">
  530. </method>
  531. <doc>
  532. <![CDATA[Parent class of all the events. All events extend this class.]]>
  533. </doc>
  534. </class>
  535. <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
  536. <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  537. <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
  538. abstract="false"
  539. static="false" final="false" visibility="public"
  540. deprecated="not deprecated">
  541. <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
  542. <constructor name="AsyncDispatcher"
  543. static="false" final="false" visibility="public"
  544. deprecated="not deprecated">
  545. </constructor>
  546. <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
  547. static="false" final="false" visibility="public"
  548. deprecated="not deprecated">
  549. </constructor>
  550. <method name="serviceInit"
  551. abstract="false" native="false" synchronized="false"
  552. static="false" final="false" visibility="protected"
  553. deprecated="not deprecated">
  554. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  555. <exception name="Exception" type="java.lang.Exception"/>
  556. </method>
  557. <method name="serviceStart"
  558. abstract="false" native="false" synchronized="false"
  559. static="false" final="false" visibility="protected"
  560. deprecated="not deprecated">
  561. <exception name="Exception" type="java.lang.Exception"/>
  562. </method>
  563. <method name="setDrainEventsOnStop"
  564. abstract="false" native="false" synchronized="false"
  565. static="false" final="false" visibility="public"
  566. deprecated="not deprecated">
  567. </method>
  568. <method name="serviceStop"
  569. abstract="false" native="false" synchronized="false"
  570. static="false" final="false" visibility="protected"
  571. deprecated="not deprecated">
  572. <exception name="Exception" type="java.lang.Exception"/>
  573. </method>
  574. <method name="dispatch"
  575. abstract="false" native="false" synchronized="false"
  576. static="false" final="false" visibility="protected"
  577. deprecated="not deprecated">
  578. <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
  579. </method>
  580. <method name="register"
  581. abstract="false" native="false" synchronized="false"
  582. static="false" final="false" visibility="public"
  583. deprecated="not deprecated">
  584. <param name="eventType" type="java.lang.Class"/>
  585. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  586. </method>
  587. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  588. abstract="false" native="false" synchronized="false"
  589. static="false" final="false" visibility="public"
  590. deprecated="not deprecated">
  591. </method>
  592. <method name="isEventThreadWaiting" return="boolean"
  593. abstract="false" native="false" synchronized="false"
  594. static="false" final="false" visibility="protected"
  595. deprecated="not deprecated">
  596. </method>
  597. <method name="isDrained" return="boolean"
  598. abstract="false" native="false" synchronized="false"
  599. static="false" final="false" visibility="protected"
  600. deprecated="not deprecated">
  601. </method>
  602. <field name="eventDispatchers" type="java.util.Map"
  603. transient="false" volatile="false"
  604. static="false" final="true" visibility="protected"
  605. deprecated="not deprecated">
  606. </field>
  607. <doc>
  608. <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
  609. does that. Potentially there could be multiple channels for each event type
  610. class and a thread pool can be used to dispatch the events.]]>
  611. </doc>
  612. </class>
  613. <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  614. <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
  615. <interface name="Dispatcher" abstract="true"
  616. static="false" final="false" visibility="public"
  617. deprecated="not deprecated">
  618. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  619. abstract="false" native="false" synchronized="false"
  620. static="false" final="false" visibility="public"
  621. deprecated="not deprecated">
  622. </method>
  623. <method name="register"
  624. abstract="false" native="false" synchronized="false"
  625. static="false" final="false" visibility="public"
  626. deprecated="not deprecated">
  627. <param name="eventType" type="java.lang.Class"/>
  628. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  629. </method>
  630. <field name="DISPATCHER_EXIT_ON_ERROR_KEY" type="java.lang.String"
  631. transient="false" volatile="false"
  632. static="true" final="true" visibility="public"
  633. deprecated="not deprecated">
  634. </field>
  635. <field name="DEFAULT_DISPATCHER_EXIT_ON_ERROR" type="boolean"
  636. transient="false" volatile="false"
  637. static="true" final="true" visibility="public"
  638. deprecated="not deprecated">
  639. </field>
  640. <doc>
  641. <![CDATA[Event Dispatcher interface. It dispatches events to registered
  642. event handlers based on event types.]]>
  643. </doc>
  644. </interface>
  645. <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
  646. <!-- start interface org.apache.hadoop.yarn.event.Event -->
  647. <interface name="Event" abstract="true"
  648. static="false" final="false" visibility="public"
  649. deprecated="not deprecated">
  650. <method name="getType" return="TYPE"
  651. abstract="false" native="false" synchronized="false"
  652. static="false" final="false" visibility="public"
  653. deprecated="not deprecated">
  654. </method>
  655. <method name="getTimestamp" return="long"
  656. abstract="false" native="false" synchronized="false"
  657. static="false" final="false" visibility="public"
  658. deprecated="not deprecated">
  659. </method>
  660. <method name="toString" return="java.lang.String"
  661. abstract="false" native="false" synchronized="false"
  662. static="false" final="false" visibility="public"
  663. deprecated="not deprecated">
  664. </method>
  665. <doc>
  666. <![CDATA[Interface defining events api.]]>
  667. </doc>
  668. </interface>
  669. <!-- end interface org.apache.hadoop.yarn.event.Event -->
  670. <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
  671. <interface name="EventHandler" abstract="true"
  672. static="false" final="false" visibility="public"
  673. deprecated="not deprecated">
  674. <method name="handle"
  675. abstract="false" native="false" synchronized="false"
  676. static="false" final="false" visibility="public"
  677. deprecated="not deprecated">
  678. <param name="event" type="T"/>
  679. </method>
  680. <doc>
  681. <![CDATA[Interface for handling events of type T
  682. @param <T> parameterized event of type T]]>
  683. </doc>
  684. </interface>
  685. <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
  686. </package>
  687. <package name="org.apache.hadoop.yarn.factories">
  688. </package>
  689. <package name="org.apache.hadoop.yarn.factory.providers">
  690. </package>
  691. <package name="org.apache.hadoop.yarn.logaggregation">
  692. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  693. <class name="AggregatedLogFormat" extends="java.lang.Object"
  694. abstract="false"
  695. static="false" final="false" visibility="public"
  696. deprecated="not deprecated">
  697. <constructor name="AggregatedLogFormat"
  698. static="false" final="false" visibility="public"
  699. deprecated="not deprecated">
  700. </constructor>
  701. </class>
  702. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  703. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  704. <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
  705. abstract="false"
  706. static="true" final="false" visibility="public"
  707. deprecated="not deprecated">
  708. <implements name="org.apache.hadoop.io.Writable"/>
  709. <constructor name="AggregatedLogFormat.LogKey"
  710. static="false" final="false" visibility="public"
  711. deprecated="not deprecated">
  712. </constructor>
  713. <constructor name="AggregatedLogFormat.LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
  714. static="false" final="false" visibility="public"
  715. deprecated="not deprecated">
  716. </constructor>
  717. <constructor name="AggregatedLogFormat.LogKey" type="java.lang.String"
  718. static="false" final="false" visibility="public"
  719. deprecated="not deprecated">
  720. </constructor>
  721. <method name="hashCode" return="int"
  722. abstract="false" native="false" synchronized="false"
  723. static="false" final="false" visibility="public"
  724. deprecated="not deprecated">
  725. </method>
  726. <method name="equals" return="boolean"
  727. abstract="false" native="false" synchronized="false"
  728. static="false" final="false" visibility="public"
  729. deprecated="not deprecated">
  730. <param name="obj" type="java.lang.Object"/>
  731. </method>
  732. <method name="toString" return="java.lang.String"
  733. abstract="false" native="false" synchronized="false"
  734. static="false" final="false" visibility="public"
  735. deprecated="not deprecated">
  736. </method>
  737. </class>
  738. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  739. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  740. <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
  741. abstract="false"
  742. static="true" final="false" visibility="public"
  743. deprecated="not deprecated">
  744. <constructor name="AggregatedLogFormat.LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
  745. static="false" final="false" visibility="public"
  746. deprecated="not deprecated">
  747. <exception name="IOException" type="java.io.IOException"/>
  748. </constructor>
  749. <method name="getApplicationOwner" return="java.lang.String"
  750. abstract="false" native="false" synchronized="false"
  751. static="false" final="false" visibility="public"
  752. deprecated="not deprecated">
  753. <exception name="IOException" type="java.io.IOException"/>
  754. <doc>
  755. <![CDATA[Returns the owner of the application.
  756. @return the application owner.
  757. @throws IOException]]>
  758. </doc>
  759. </method>
  760. <method name="getApplicationAcls" return="java.util.Map"
  761. abstract="false" native="false" synchronized="false"
  762. static="false" final="false" visibility="public"
  763. deprecated="not deprecated">
  764. <exception name="IOException" type="java.io.IOException"/>
  765. <doc>
  766. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  767. found.
  768. @return a map of the Application ACLs.
  769. @throws IOException]]>
  770. </doc>
  771. </method>
  772. <method name="next" return="java.io.DataInputStream"
  773. abstract="false" native="false" synchronized="false"
  774. static="false" final="false" visibility="public"
  775. deprecated="not deprecated">
  776. <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  777. <exception name="IOException" type="java.io.IOException"/>
  778. <doc>
  779. <![CDATA[Read the next key and return the value-stream.
  780. @param key
  781. @return the valueStream if there are more keys or null otherwise.
  782. @throws IOException]]>
  783. </doc>
  784. </method>
  785. <method name="readAcontainerLogs"
  786. abstract="false" native="false" synchronized="false"
  787. static="true" final="false" visibility="public"
  788. deprecated="not deprecated">
  789. <param name="valueStream" type="java.io.DataInputStream"/>
  790. <param name="writer" type="java.io.Writer"/>
  791. <param name="logUploadedTime" type="long"/>
  792. <exception name="IOException" type="java.io.IOException"/>
  793. <doc>
  794. <![CDATA[Writes all logs for a single container to the provided writer.
  795. @param valueStream
  796. @param writer
  797. @param logUploadedTime
  798. @throws IOException]]>
  799. </doc>
  800. </method>
  801. <method name="readAcontainerLogs"
  802. abstract="false" native="false" synchronized="false"
  803. static="true" final="false" visibility="public"
  804. deprecated="not deprecated">
  805. <param name="valueStream" type="java.io.DataInputStream"/>
  806. <param name="writer" type="java.io.Writer"/>
  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
  811. @param writer
  812. @throws IOException]]>
  813. </doc>
  814. </method>
  815. <method name="readAContainerLogsForALogType"
  816. abstract="false" native="false" synchronized="false"
  817. static="true" final="false" visibility="public"
  818. deprecated="not deprecated">
  819. <param name="valueStream" type="java.io.DataInputStream"/>
  820. <param name="out" type="java.io.PrintStream"/>
  821. <param name="logUploadedTime" type="long"/>
  822. <exception name="IOException" type="java.io.IOException"/>
  823. <doc>
  824. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  825. all types for a single container.
  826. @param valueStream
  827. @param out
  828. @param logUploadedTime
  829. @throws IOException]]>
  830. </doc>
  831. </method>
  832. <method name="readAContainerLogsForALogType"
  833. abstract="false" native="false" synchronized="false"
  834. static="true" final="false" visibility="public"
  835. deprecated="not deprecated">
  836. <param name="valueStream" type="java.io.DataInputStream"/>
  837. <param name="out" type="java.io.PrintStream"/>
  838. <exception name="IOException" type="java.io.IOException"/>
  839. <doc>
  840. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  841. all types for a single container.
  842. @param valueStream
  843. @param out
  844. @throws IOException]]>
  845. </doc>
  846. </method>
  847. <method name="close"
  848. abstract="false" native="false" synchronized="false"
  849. static="false" final="false" visibility="public"
  850. deprecated="not deprecated">
  851. </method>
  852. </class>
  853. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  854. <!-- start class org.apache.hadoop.yarn.logaggregation.LogCLIHelpers -->
  855. <class name="LogCLIHelpers" extends="java.lang.Object"
  856. abstract="false"
  857. static="false" final="false" visibility="public"
  858. deprecated="not deprecated">
  859. <implements name="org.apache.hadoop.conf.Configurable"/>
  860. <constructor name="LogCLIHelpers"
  861. static="false" final="false" visibility="public"
  862. deprecated="not deprecated">
  863. </constructor>
  864. <method name="setConf"
  865. abstract="false" native="false" synchronized="false"
  866. static="false" final="false" visibility="public"
  867. deprecated="not deprecated">
  868. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  869. </method>
  870. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  871. abstract="false" native="false" synchronized="false"
  872. static="false" final="false" visibility="public"
  873. deprecated="not deprecated">
  874. </method>
  875. </class>
  876. <!-- end class org.apache.hadoop.yarn.logaggregation.LogCLIHelpers -->
  877. </package>
  878. <package name="org.apache.hadoop.yarn.nodelabels">
  879. <!-- start class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager -->
  880. <class name="CommonNodeLabelsManager" extends="org.apache.hadoop.service.AbstractService"
  881. abstract="false"
  882. static="false" final="false" visibility="public"
  883. deprecated="not deprecated">
  884. <constructor name="CommonNodeLabelsManager"
  885. static="false" final="false" visibility="public"
  886. deprecated="not deprecated">
  887. </constructor>
  888. <method name="handleStoreEvent"
  889. abstract="false" native="false" synchronized="false"
  890. static="false" final="false" visibility="protected"
  891. deprecated="not deprecated">
  892. <param name="event" type="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent"/>
  893. </method>
  894. <method name="initDispatcher"
  895. abstract="false" native="false" synchronized="false"
  896. static="false" final="false" visibility="protected"
  897. deprecated="not deprecated">
  898. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  899. </method>
  900. <method name="serviceInit"
  901. abstract="false" native="false" synchronized="false"
  902. static="false" final="false" visibility="protected"
  903. deprecated="not deprecated">
  904. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  905. <exception name="Exception" type="java.lang.Exception"/>
  906. </method>
  907. <method name="initNodeLabelStore"
  908. abstract="false" native="false" synchronized="false"
  909. static="false" final="false" visibility="protected"
  910. deprecated="not deprecated">
  911. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  912. <exception name="Exception" type="java.lang.Exception"/>
  913. </method>
  914. <method name="startDispatcher"
  915. abstract="false" native="false" synchronized="false"
  916. static="false" final="false" visibility="protected"
  917. deprecated="not deprecated">
  918. </method>
  919. <method name="serviceStart"
  920. abstract="false" native="false" synchronized="false"
  921. static="false" final="false" visibility="protected"
  922. deprecated="not deprecated">
  923. <exception name="Exception" type="java.lang.Exception"/>
  924. </method>
  925. <method name="stopDispatcher"
  926. abstract="false" native="false" synchronized="false"
  927. static="false" final="false" visibility="protected"
  928. deprecated="not deprecated">
  929. </method>
  930. <method name="serviceStop"
  931. abstract="false" native="false" synchronized="false"
  932. static="false" final="false" visibility="protected"
  933. deprecated="not deprecated">
  934. <exception name="Exception" type="java.lang.Exception"/>
  935. </method>
  936. <method name="addToCluserNodeLabels"
  937. abstract="false" native="false" synchronized="false"
  938. static="false" final="false" visibility="public"
  939. deprecated="not deprecated">
  940. <param name="labels" type="java.util.Set"/>
  941. <exception name="IOException" type="java.io.IOException"/>
  942. <doc>
  943. <![CDATA[Add multiple node labels to repository
  944. @param labels
  945. new node labels added]]>
  946. </doc>
  947. </method>
  948. <method name="checkAddLabelsToNode"
  949. abstract="false" native="false" synchronized="false"
  950. static="false" final="false" visibility="protected"
  951. deprecated="not deprecated">
  952. <param name="addedLabelsToNode" type="java.util.Map"/>
  953. <exception name="IOException" type="java.io.IOException"/>
  954. </method>
  955. <method name="addLabelsToNode"
  956. abstract="false" native="false" synchronized="false"
  957. static="false" final="false" visibility="public"
  958. deprecated="not deprecated">
  959. <param name="addedLabelsToNode" type="java.util.Map"/>
  960. <exception name="IOException" type="java.io.IOException"/>
  961. <doc>
  962. <![CDATA[add more labels to nodes
  963. @param addedLabelsToNode node {@literal ->} labels map]]>
  964. </doc>
  965. </method>
  966. <method name="checkRemoveFromClusterNodeLabels"
  967. abstract="false" native="false" synchronized="false"
  968. static="false" final="false" visibility="protected"
  969. deprecated="not deprecated">
  970. <param name="labelsToRemove" type="java.util.Collection"/>
  971. <exception name="IOException" type="java.io.IOException"/>
  972. </method>
  973. <method name="internalRemoveFromClusterNodeLabels"
  974. abstract="false" native="false" synchronized="false"
  975. static="false" final="false" visibility="protected"
  976. deprecated="not deprecated">
  977. <param name="labelsToRemove" type="java.util.Collection"/>
  978. </method>
  979. <method name="removeFromClusterNodeLabels"
  980. abstract="false" native="false" synchronized="false"
  981. static="false" final="false" visibility="public"
  982. deprecated="not deprecated">
  983. <param name="labelsToRemove" type="java.util.Collection"/>
  984. <exception name="IOException" type="java.io.IOException"/>
  985. <doc>
  986. <![CDATA[Remove multiple node labels from repository
  987. @param labelsToRemove
  988. node labels to remove
  989. @throws IOException]]>
  990. </doc>
  991. </method>
  992. <method name="checkRemoveLabelsFromNode"
  993. abstract="false" native="false" synchronized="false"
  994. static="false" final="false" visibility="protected"
  995. deprecated="not deprecated">
  996. <param name="removeLabelsFromNode" type="java.util.Map"/>
  997. <exception name="IOException" type="java.io.IOException"/>
  998. </method>
  999. <method name="removeNodeFromLabels"
  1000. abstract="false" native="false" synchronized="false"
  1001. static="false" final="false" visibility="protected"
  1002. deprecated="not deprecated">
  1003. <param name="node" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1004. <param name="labels" type="java.util.Set"/>
  1005. </method>
  1006. <method name="internalUpdateLabelsOnNodes"
  1007. abstract="false" native="false" synchronized="false"
  1008. static="false" final="false" visibility="protected"
  1009. deprecated="not deprecated">
  1010. <param name="nodeToLabels" type="java.util.Map"/>
  1011. <param name="op" type="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.NodeLabelUpdateOperation"/>
  1012. <exception name="IOException" type="java.io.IOException"/>
  1013. </method>
  1014. <method name="removeLabelsFromNode"
  1015. abstract="false" native="false" synchronized="false"
  1016. static="false" final="false" visibility="public"
  1017. deprecated="not deprecated">
  1018. <param name="removeLabelsFromNode" type="java.util.Map"/>
  1019. <exception name="IOException" type="java.io.IOException"/>
  1020. <doc>
  1021. <![CDATA[remove labels from nodes, labels being removed most be contained by these
  1022. nodes
  1023. @param removeLabelsFromNode node {@literal ->} labels map]]>
  1024. </doc>
  1025. </method>
  1026. <method name="checkReplaceLabelsOnNode"
  1027. abstract="false" native="false" synchronized="false"
  1028. static="false" final="false" visibility="protected"
  1029. deprecated="not deprecated">
  1030. <param name="replaceLabelsToNode" type="java.util.Map"/>
  1031. <exception name="IOException" type="java.io.IOException"/>
  1032. </method>
  1033. <method name="replaceLabelsOnNode"
  1034. abstract="false" native="false" synchronized="false"
  1035. static="false" final="false" visibility="public"
  1036. deprecated="not deprecated">
  1037. <param name="replaceLabelsToNode" type="java.util.Map"/>
  1038. <exception name="IOException" type="java.io.IOException"/>
  1039. <doc>
  1040. <![CDATA[replace labels to nodes
  1041. @param replaceLabelsToNode node {@literal ->} labels map]]>
  1042. </doc>
  1043. </method>
  1044. <method name="getNodeLabels" return="java.util.Map"
  1045. abstract="false" native="false" synchronized="false"
  1046. static="false" final="false" visibility="public"
  1047. deprecated="not deprecated">
  1048. <doc>
  1049. <![CDATA[Get mapping of nodes to labels
  1050. @return nodes to labels map]]>
  1051. </doc>
  1052. </method>
  1053. <method name="getLabelsToNodes" return="java.util.Map"
  1054. abstract="false" native="false" synchronized="false"
  1055. static="false" final="false" visibility="public"
  1056. deprecated="not deprecated">
  1057. <doc>
  1058. <![CDATA[Get mapping of labels to nodes for all the labels.
  1059. @return labels to nodes map]]>
  1060. </doc>
  1061. </method>
  1062. <method name="getLabelsToNodes" return="java.util.Map"
  1063. abstract="false" native="false" synchronized="false"
  1064. static="false" final="false" visibility="public"
  1065. deprecated="not deprecated">
  1066. <param name="labels" type="java.util.Set"/>
  1067. <doc>
  1068. <![CDATA[Get mapping of labels to nodes for specified set of labels.
  1069. @param labels set of labels for which labels to nodes mapping will be
  1070. returned.
  1071. @return labels to nodes map]]>
  1072. </doc>
  1073. </method>
  1074. <method name="getClusterNodeLabels" return="java.util.Set"
  1075. abstract="false" native="false" synchronized="false"
  1076. static="false" final="false" visibility="public"
  1077. deprecated="not deprecated">
  1078. <doc>
  1079. <![CDATA[Get existing valid labels in repository
  1080. @return existing valid labels in repository]]>
  1081. </doc>
  1082. </method>
  1083. <method name="normalizeLabel" return="java.lang.String"
  1084. abstract="false" native="false" synchronized="false"
  1085. static="false" final="false" visibility="protected"
  1086. deprecated="not deprecated">
  1087. <param name="label" type="java.lang.String"/>
  1088. </method>
  1089. <method name="getNMInNodeSet" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node"
  1090. abstract="false" native="false" synchronized="false"
  1091. static="false" final="false" visibility="protected"
  1092. deprecated="not deprecated">
  1093. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1094. </method>
  1095. <method name="getNMInNodeSet" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node"
  1096. abstract="false" native="false" synchronized="false"
  1097. static="false" final="false" visibility="protected"
  1098. deprecated="not deprecated">
  1099. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1100. <param name="map" type="java.util.Map"/>
  1101. </method>
  1102. <method name="getNMInNodeSet" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node"
  1103. abstract="false" native="false" synchronized="false"
  1104. static="false" final="false" visibility="protected"
  1105. deprecated="not deprecated">
  1106. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1107. <param name="map" type="java.util.Map"/>
  1108. <param name="checkRunning" type="boolean"/>
  1109. </method>
  1110. <method name="getLabelsByNode" return="java.util.Set"
  1111. abstract="false" native="false" synchronized="false"
  1112. static="false" final="false" visibility="protected"
  1113. deprecated="not deprecated">
  1114. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1115. </method>
  1116. <method name="getLabelsByNode" return="java.util.Set"
  1117. abstract="false" native="false" synchronized="false"
  1118. static="false" final="false" visibility="protected"
  1119. deprecated="not deprecated">
  1120. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1121. <param name="map" type="java.util.Map"/>
  1122. </method>
  1123. <method name="createNodeIfNonExisted"
  1124. abstract="false" native="false" synchronized="false"
  1125. static="false" final="false" visibility="protected"
  1126. deprecated="not deprecated">
  1127. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1128. <exception name="IOException" type="java.io.IOException"/>
  1129. </method>
  1130. <method name="createHostIfNonExisted"
  1131. abstract="false" native="false" synchronized="false"
  1132. static="false" final="false" visibility="protected"
  1133. deprecated="not deprecated">
  1134. <param name="hostName" type="java.lang.String"/>
  1135. </method>
  1136. <method name="normalizeNodeIdToLabels" return="java.util.Map"
  1137. abstract="false" native="false" synchronized="false"
  1138. static="false" final="false" visibility="protected"
  1139. deprecated="not deprecated">
  1140. <param name="nodeIdToLabels" type="java.util.Map"/>
  1141. </method>
  1142. <field name="LOG" type="org.apache.commons.logging.Log"
  1143. transient="false" volatile="false"
  1144. static="true" final="true" visibility="protected"
  1145. deprecated="not deprecated">
  1146. </field>
  1147. <field name="EMPTY_STRING_SET" type="java.util.Set"
  1148. transient="false" volatile="false"
  1149. static="true" final="true" visibility="public"
  1150. deprecated="not deprecated">
  1151. </field>
  1152. <field name="ANY" type="java.lang.String"
  1153. transient="false" volatile="false"
  1154. static="true" final="true" visibility="public"
  1155. deprecated="not deprecated">
  1156. </field>
  1157. <field name="ACCESS_ANY_LABEL_SET" type="java.util.Set"
  1158. transient="false" volatile="false"
  1159. static="true" final="true" visibility="public"
  1160. deprecated="not deprecated">
  1161. </field>
  1162. <field name="WILDCARD_PORT" type="int"
  1163. transient="false" volatile="false"
  1164. static="true" final="true" visibility="public"
  1165. deprecated="not deprecated">
  1166. </field>
  1167. <field name="NODE_LABELS_NOT_ENABLED_ERR" type="java.lang.String"
  1168. transient="false" volatile="false"
  1169. static="true" final="true" visibility="public"
  1170. deprecated="not deprecated">
  1171. <doc>
  1172. <![CDATA[Error messages]]>
  1173. </doc>
  1174. </field>
  1175. <field name="NO_LABEL" type="java.lang.String"
  1176. transient="false" volatile="false"
  1177. static="true" final="true" visibility="public"
  1178. deprecated="not deprecated">
  1179. <doc>
  1180. <![CDATA[If a user doesn't specify label of a queue or node, it belongs
  1181. DEFAULT_LABEL]]>
  1182. </doc>
  1183. </field>
  1184. <field name="dispatcher" type="org.apache.hadoop.yarn.event.Dispatcher"
  1185. transient="false" volatile="false"
  1186. static="false" final="false" visibility="protected"
  1187. deprecated="not deprecated">
  1188. </field>
  1189. <field name="labelCollections" type="java.util.concurrent.ConcurrentMap"
  1190. transient="false" volatile="false"
  1191. static="false" final="false" visibility="protected"
  1192. deprecated="not deprecated">
  1193. </field>
  1194. <field name="nodeCollections" type="java.util.concurrent.ConcurrentMap"
  1195. transient="false" volatile="false"
  1196. static="false" final="false" visibility="protected"
  1197. deprecated="not deprecated">
  1198. </field>
  1199. <field name="readLock" type="java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock"
  1200. transient="false" volatile="false"
  1201. static="false" final="true" visibility="protected"
  1202. deprecated="not deprecated">
  1203. </field>
  1204. <field name="writeLock" type="java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock"
  1205. transient="false" volatile="false"
  1206. static="false" final="true" visibility="protected"
  1207. deprecated="not deprecated">
  1208. </field>
  1209. <field name="store" type="org.apache.hadoop.yarn.nodelabels.NodeLabelsStore"
  1210. transient="false" volatile="false"
  1211. static="false" final="false" visibility="protected"
  1212. deprecated="not deprecated">
  1213. </field>
  1214. </class>
  1215. <!-- end class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager -->
  1216. <!-- start class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Host -->
  1217. <class name="CommonNodeLabelsManager.Host" extends="java.lang.Object"
  1218. abstract="false"
  1219. static="true" final="false" visibility="protected"
  1220. deprecated="not deprecated">
  1221. <constructor name="CommonNodeLabelsManager.Host"
  1222. static="false" final="false" visibility="protected"
  1223. deprecated="not deprecated">
  1224. </constructor>
  1225. <method name="copy" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Host"
  1226. abstract="false" native="false" synchronized="false"
  1227. static="false" final="false" visibility="public"
  1228. deprecated="not deprecated">
  1229. </method>
  1230. <field name="labels" type="java.util.Set"
  1231. transient="false" volatile="false"
  1232. static="false" final="false" visibility="public"
  1233. deprecated="not deprecated">
  1234. </field>
  1235. <field name="nms" type="java.util.Map"
  1236. transient="false" volatile="false"
  1237. static="false" final="false" visibility="public"
  1238. deprecated="not deprecated">
  1239. </field>
  1240. <doc>
  1241. <![CDATA[A <code>Host</code> can have multiple <code>Node</code>s]]>
  1242. </doc>
  1243. </class>
  1244. <!-- end class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Host -->
  1245. <!-- start class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node -->
  1246. <class name="CommonNodeLabelsManager.Node" extends="java.lang.Object"
  1247. abstract="false"
  1248. static="true" final="false" visibility="protected"
  1249. deprecated="not deprecated">
  1250. <constructor name="CommonNodeLabelsManager.Node" type="org.apache.hadoop.yarn.api.records.NodeId"
  1251. static="false" final="false" visibility="protected"
  1252. deprecated="not deprecated">
  1253. </constructor>
  1254. <method name="copy" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node"
  1255. abstract="false" native="false" synchronized="false"
  1256. static="false" final="false" visibility="public"
  1257. deprecated="not deprecated">
  1258. </method>
  1259. <field name="labels" type="java.util.Set"
  1260. transient="false" volatile="false"
  1261. static="false" final="false" visibility="public"
  1262. deprecated="not deprecated">
  1263. </field>
  1264. <field name="resource" type="org.apache.hadoop.yarn.api.records.Resource"
  1265. transient="false" volatile="false"
  1266. static="false" final="false" visibility="public"
  1267. deprecated="not deprecated">
  1268. </field>
  1269. <field name="running" type="boolean"
  1270. transient="false" volatile="false"
  1271. static="false" final="false" visibility="public"
  1272. deprecated="not deprecated">
  1273. </field>
  1274. <field name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"
  1275. transient="false" volatile="false"
  1276. static="false" final="false" visibility="public"
  1277. deprecated="not deprecated">
  1278. </field>
  1279. </class>
  1280. <!-- end class org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager.Node -->
  1281. <!-- start class org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore -->
  1282. <class name="FileSystemNodeLabelsStore" extends="org.apache.hadoop.yarn.nodelabels.NodeLabelsStore"
  1283. abstract="false"
  1284. static="false" final="false" visibility="public"
  1285. deprecated="not deprecated">
  1286. <constructor name="FileSystemNodeLabelsStore" type="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager"
  1287. static="false" final="false" visibility="public"
  1288. deprecated="not deprecated">
  1289. </constructor>
  1290. <method name="init"
  1291. abstract="false" native="false" synchronized="false"
  1292. static="false" final="false" visibility="public"
  1293. deprecated="not deprecated">
  1294. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1295. <exception name="Exception" type="java.lang.Exception"/>
  1296. </method>
  1297. <method name="close"
  1298. abstract="false" native="false" synchronized="false"
  1299. static="false" final="false" visibility="public"
  1300. deprecated="not deprecated">
  1301. <exception name="IOException" type="java.io.IOException"/>
  1302. </method>
  1303. <method name="updateNodeToLabelsMappings"
  1304. abstract="false" native="false" synchronized="false"
  1305. static="false" final="false" visibility="public"
  1306. deprecated="not deprecated">
  1307. <param name="nodeToLabels" type="java.util.Map"/>
  1308. <exception name="IOException" type="java.io.IOException"/>
  1309. </method>
  1310. <method name="storeNewClusterNodeLabels"
  1311. abstract="false" native="false" synchronized="false"
  1312. static="false" final="false" visibility="public"
  1313. deprecated="not deprecated">
  1314. <param name="labels" type="java.util.Set"/>
  1315. <exception name="IOException" type="java.io.IOException"/>
  1316. </method>
  1317. <method name="removeClusterNodeLabels"
  1318. abstract="false" native="false" synchronized="false"
  1319. static="false" final="false" visibility="public"
  1320. deprecated="not deprecated">
  1321. <param name="labels" type="java.util.Collection"/>
  1322. <exception name="IOException" type="java.io.IOException"/>
  1323. </method>
  1324. <method name="recover"
  1325. abstract="false" native="false" synchronized="false"
  1326. static="false" final="false" visibility="public"
  1327. deprecated="not deprecated">
  1328. <exception name="IOException" type="java.io.IOException"/>
  1329. </method>
  1330. <field name="LOG" type="org.apache.commons.logging.Log"
  1331. transient="false" volatile="false"
  1332. static="true" final="true" visibility="protected"
  1333. deprecated="not deprecated">
  1334. </field>
  1335. <field name="DEFAULT_DIR_NAME" type="java.lang.String"
  1336. transient="false" volatile="false"
  1337. static="true" final="true" visibility="protected"
  1338. deprecated="not deprecated">
  1339. </field>
  1340. <field name="MIRROR_FILENAME" type="java.lang.String"
  1341. transient="false" volatile="false"
  1342. static="true" final="true" visibility="protected"
  1343. deprecated="not deprecated">
  1344. </field>
  1345. <field name="EDITLOG_FILENAME" type="java.lang.String"
  1346. transient="false" volatile="false"
  1347. static="true" final="true" visibility="protected"
  1348. deprecated="not deprecated">
  1349. </field>
  1350. </class>
  1351. <!-- end class org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore -->
  1352. <!-- start class org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore.SerializedLogType -->
  1353. <class name="FileSystemNodeLabelsStore.SerializedLogType" extends="java.lang.Enum"
  1354. abstract="false"
  1355. static="true" final="true" visibility="protected"
  1356. deprecated="not deprecated">
  1357. <method name="values" return="org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore.SerializedLogType[]"
  1358. abstract="false" native="false" synchronized="false"
  1359. static="true" final="false" visibility="public"
  1360. deprecated="not deprecated">
  1361. </method>
  1362. <method name="valueOf" return="org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore.SerializedLogType"
  1363. abstract="false" native="false" synchronized="false"
  1364. static="true" final="false" visibility="public"
  1365. deprecated="not deprecated">
  1366. <param name="name" type="java.lang.String"/>
  1367. </method>
  1368. </class>
  1369. <!-- end class org.apache.hadoop.yarn.nodelabels.FileSystemNodeLabelsStore.SerializedLogType -->
  1370. <!-- start class org.apache.hadoop.yarn.nodelabels.NodeLabel -->
  1371. <class name="NodeLabel" extends="java.lang.Object"
  1372. abstract="false"
  1373. static="false" final="false" visibility="public"
  1374. deprecated="not deprecated">
  1375. <implements name="java.lang.Comparable"/>
  1376. <constructor name="NodeLabel" type="java.lang.String"
  1377. static="false" final="false" visibility="public"
  1378. deprecated="not deprecated">
  1379. </constructor>
  1380. <constructor name="NodeLabel" type="java.lang.String, org.apache.hadoop.yarn.api.records.Resource, int"
  1381. static="false" final="false" visibility="protected"
  1382. deprecated="not deprecated">
  1383. </constructor>
  1384. <method name="addNodeId"
  1385. abstract="false" native="false" synchronized="false"
  1386. static="false" final="false" visibility="public"
  1387. deprecated="not deprecated">
  1388. <param name="node" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1389. </method>
  1390. <method name="removeNodeId"
  1391. abstract="false" native="false" synchronized="false"
  1392. static="false" final="false" visibility="public"
  1393. deprecated="not deprecated">
  1394. <param name="node" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1395. </method>
  1396. <method name="getAssociatedNodeIds" return="java.util.Set"
  1397. abstract="false" native="false" synchronized="false"
  1398. static="false" final="false" visibility="public"
  1399. deprecated="not deprecated">
  1400. </method>
  1401. <method name="addNode"
  1402. abstract="false" native="false" synchronized="false"
  1403. static="false" final="false" visibility="public"
  1404. deprecated="not deprecated">
  1405. <param name="nodeRes" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1406. </method>
  1407. <method name="removeNode"
  1408. abstract="false" native="false" synchronized="false"
  1409. static="false" final="false" visibility="public"
  1410. deprecated="not deprecated">
  1411. <param name="nodeRes" type="org.apache.hadoop.yarn.api.records.Resource"/>
  1412. </method>
  1413. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  1414. abstract="false" native="false" synchronized="false"
  1415. static="false" final="false" visibility="public"
  1416. deprecated="not deprecated">
  1417. </method>
  1418. <method name="getNumActiveNMs" return="int"
  1419. abstract="false" native="false" synchronized="false"
  1420. static="false" final="false" visibility="public"
  1421. deprecated="not deprecated">
  1422. </method>
  1423. <method name="getLabelName" return="java.lang.String"
  1424. abstract="false" native="false" synchronized="false"
  1425. static="false" final="false" visibility="public"
  1426. deprecated="not deprecated">
  1427. </method>
  1428. <method name="getCopy" return="org.apache.hadoop.yarn.nodelabels.NodeLabel"
  1429. abstract="false" native="false" synchronized="false"
  1430. static="false" final="false" visibility="public"
  1431. deprecated="not deprecated">
  1432. </method>
  1433. <method name="compareTo" return="int"
  1434. abstract="false" native="false" synchronized="false"
  1435. static="false" final="false" visibility="public"
  1436. deprecated="not deprecated">
  1437. <param name="o" type="org.apache.hadoop.yarn.nodelabels.NodeLabel"/>
  1438. </method>
  1439. <method name="equals" return="boolean"
  1440. abstract="false" native="false" synchronized="false"
  1441. static="false" final="false" visibility="public"
  1442. deprecated="not deprecated">
  1443. <param name="obj" type="java.lang.Object"/>
  1444. </method>
  1445. <method name="hashCode" return="int"
  1446. abstract="false" native="false" synchronized="false"
  1447. static="false" final="false" visibility="public"
  1448. deprecated="not deprecated">
  1449. </method>
  1450. </class>
  1451. <!-- end class org.apache.hadoop.yarn.nodelabels.NodeLabel -->
  1452. <!-- start class org.apache.hadoop.yarn.nodelabels.NodeLabelsStore -->
  1453. <class name="NodeLabelsStore" extends="java.lang.Object"
  1454. abstract="true"
  1455. static="false" final="false" visibility="public"
  1456. deprecated="not deprecated">
  1457. <implements name="java.io.Closeable"/>
  1458. <constructor name="NodeLabelsStore" type="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager"
  1459. static="false" final="false" visibility="public"
  1460. deprecated="not deprecated">
  1461. </constructor>
  1462. <method name="updateNodeToLabelsMappings"
  1463. abstract="true" native="false" synchronized="false"
  1464. static="false" final="false" visibility="public"
  1465. deprecated="not deprecated">
  1466. <param name="nodeToLabels" type="java.util.Map"/>
  1467. <exception name="IOException" type="java.io.IOException"/>
  1468. <doc>
  1469. <![CDATA[Store node {@literal ->} label]]>
  1470. </doc>
  1471. </method>
  1472. <method name="storeNewClusterNodeLabels"
  1473. abstract="true" native="false" synchronized="false"
  1474. static="false" final="false" visibility="public"
  1475. deprecated="not deprecated">
  1476. <param name="label" type="java.util.Set"/>
  1477. <exception name="IOException" type="java.io.IOException"/>
  1478. <doc>
  1479. <![CDATA[Store new labels]]>
  1480. </doc>
  1481. </method>
  1482. <method name="removeClusterNodeLabels"
  1483. abstract="true" native="false" synchronized="false"
  1484. static="false" final="false" visibility="public"
  1485. deprecated="not deprecated">
  1486. <param name="labels" type="java.util.Collection"/>
  1487. <exception name="IOException" type="java.io.IOException"/>
  1488. <doc>
  1489. <![CDATA[Remove labels]]>
  1490. </doc>
  1491. </method>
  1492. <method name="recover"
  1493. abstract="true" native="false" synchronized="false"
  1494. static="false" final="false" visibility="public"
  1495. deprecated="not deprecated">
  1496. <exception name="IOException" type="java.io.IOException"/>
  1497. <doc>
  1498. <![CDATA[Recover labels and node to labels mappings from store]]>
  1499. </doc>
  1500. </method>
  1501. <method name="init"
  1502. abstract="false" native="false" synchronized="false"
  1503. static="false" final="false" visibility="public"
  1504. deprecated="not deprecated">
  1505. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1506. <exception name="Exception" type="java.lang.Exception"/>
  1507. </method>
  1508. <method name="getNodeLabelsManager" return="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager"
  1509. abstract="false" native="false" synchronized="false"
  1510. static="false" final="false" visibility="public"
  1511. deprecated="not deprecated">
  1512. </method>
  1513. <field name="mgr" type="org.apache.hadoop.yarn.nodelabels.CommonNodeLabelsManager"
  1514. transient="false" volatile="false"
  1515. static="false" final="true" visibility="protected"
  1516. deprecated="not deprecated">
  1517. </field>
  1518. </class>
  1519. <!-- end class org.apache.hadoop.yarn.nodelabels.NodeLabelsStore -->
  1520. </package>
  1521. <package name="org.apache.hadoop.yarn.nodelabels.event">
  1522. <!-- start class org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent -->
  1523. <class name="NodeLabelsStoreEvent" extends="org.apache.hadoop.yarn.event.AbstractEvent"
  1524. abstract="false"
  1525. static="false" final="false" visibility="public"
  1526. deprecated="not deprecated">
  1527. <constructor name="NodeLabelsStoreEvent" type="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEventType"
  1528. static="false" final="false" visibility="public"
  1529. deprecated="not deprecated">
  1530. </constructor>
  1531. </class>
  1532. <!-- end class org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent -->
  1533. <!-- start class org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEventType -->
  1534. <class name="NodeLabelsStoreEventType" extends="java.lang.Enum"
  1535. abstract="false"
  1536. static="false" final="true" visibility="public"
  1537. deprecated="not deprecated">
  1538. <method name="values" return="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEventType[]"
  1539. abstract="false" native="false" synchronized="false"
  1540. static="true" final="false" visibility="public"
  1541. deprecated="not deprecated">
  1542. </method>
  1543. <method name="valueOf" return="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEventType"
  1544. abstract="false" native="false" synchronized="false"
  1545. static="true" final="false" visibility="public"
  1546. deprecated="not deprecated">
  1547. <param name="name" type="java.lang.String"/>
  1548. </method>
  1549. </class>
  1550. <!-- end class org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEventType -->
  1551. <!-- start class org.apache.hadoop.yarn.nodelabels.event.RemoveClusterNodeLabels -->
  1552. <class name="RemoveClusterNodeLabels" extends="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent"
  1553. abstract="false"
  1554. static="false" final="false" visibility="public"
  1555. deprecated="not deprecated">
  1556. <constructor name="RemoveClusterNodeLabels" type="java.util.Collection"
  1557. static="false" final="false" visibility="public"
  1558. deprecated="not deprecated">
  1559. </constructor>
  1560. <method name="getLabels" return="java.util.Collection"
  1561. abstract="false" native="false" synchronized="false"
  1562. static="false" final="false" visibility="public"
  1563. deprecated="not deprecated">
  1564. </method>
  1565. </class>
  1566. <!-- end class org.apache.hadoop.yarn.nodelabels.event.RemoveClusterNodeLabels -->
  1567. <!-- start class org.apache.hadoop.yarn.nodelabels.event.StoreNewClusterNodeLabels -->
  1568. <class name="StoreNewClusterNodeLabels" extends="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent"
  1569. abstract="false"
  1570. static="false" final="false" visibility="public"
  1571. deprecated="not deprecated">
  1572. <constructor name="StoreNewClusterNodeLabels" type="java.util.Set"
  1573. static="false" final="false" visibility="public"
  1574. deprecated="not deprecated">
  1575. </constructor>
  1576. <method name="getLabels" return="java.util.Set"
  1577. abstract="false" native="false" synchronized="false"
  1578. static="false" final="false" visibility="public"
  1579. deprecated="not deprecated">
  1580. </method>
  1581. </class>
  1582. <!-- end class org.apache.hadoop.yarn.nodelabels.event.StoreNewClusterNodeLabels -->
  1583. <!-- start class org.apache.hadoop.yarn.nodelabels.event.UpdateNodeToLabelsMappingsEvent -->
  1584. <class name="UpdateNodeToLabelsMappingsEvent" extends="org.apache.hadoop.yarn.nodelabels.event.NodeLabelsStoreEvent"
  1585. abstract="false"
  1586. static="false" final="false" visibility="public"
  1587. deprecated="not deprecated">
  1588. <constructor name="UpdateNodeToLabelsMappingsEvent" type="java.util.Map"
  1589. static="false" final="false" visibility="public"
  1590. deprecated="not deprecated">
  1591. </constructor>
  1592. <method name="getNodeToLabels" return="java.util.Map"
  1593. abstract="false" native="false" synchronized="false"
  1594. static="false" final="false" visibility="public"
  1595. deprecated="not deprecated">
  1596. </method>
  1597. </class>
  1598. <!-- end class org.apache.hadoop.yarn.nodelabels.event.UpdateNodeToLabelsMappingsEvent -->
  1599. </package>
  1600. <package name="org.apache.hadoop.yarn.security">
  1601. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1602. <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1603. abstract="false"
  1604. static="false" final="false" visibility="public"
  1605. deprecated="not deprecated">
  1606. <constructor name="AMRMTokenIdentifier"
  1607. static="false" final="false" visibility="public"
  1608. deprecated="not deprecated">
  1609. </constructor>
  1610. <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
  1611. static="false" final="false" visibility="public"
  1612. deprecated="not deprecated">
  1613. </constructor>
  1614. <method name="write"
  1615. abstract="false" native="false" synchronized="false"
  1616. static="false" final="false" visibility="public"
  1617. deprecated="not deprecated">
  1618. <param name="out" type="java.io.DataOutput"/>
  1619. <exception name="IOException" type="java.io.IOException"/>
  1620. </method>
  1621. <method name="readFields"
  1622. abstract="false" native="false" synchronized="false"
  1623. static="false" final="false" visibility="public"
  1624. deprecated="not deprecated">
  1625. <param name="in" type="java.io.DataInput"/>
  1626. <exception name="IOException" type="java.io.IOException"/>
  1627. </method>
  1628. <method name="getKind" return="org.apache.hadoop.io.Text"
  1629. abstract="false" native="false" synchronized="false"
  1630. static="false" final="false" visibility="public"
  1631. deprecated="not deprecated">
  1632. </method>
  1633. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1634. abstract="false" native="false" synchronized="false"
  1635. static="false" final="false" visibility="public"
  1636. deprecated="not deprecated">
  1637. </method>
  1638. <method name="getKeyId" return="int"
  1639. abstract="false" native="false" synchronized="false"
  1640. static="false" final="false" visibility="public"
  1641. deprecated="not deprecated">
  1642. </method>
  1643. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
  1644. abstract="false" native="false" synchronized="false"
  1645. static="false" final="false" visibility="public"
  1646. deprecated="not deprecated">
  1647. </method>
  1648. <method name="hashCode" return="int"
  1649. abstract="false" native="false" synchronized="false"
  1650. static="false" final="false" visibility="public"
  1651. deprecated="not deprecated">
  1652. </method>
  1653. <method name="equals" return="boolean"
  1654. abstract="false" native="false" synchronized="false"
  1655. static="false" final="false" visibility="public"
  1656. deprecated="not deprecated">
  1657. <param name="other" type="java.lang.Object"/>
  1658. </method>
  1659. <method name="toString" return="java.lang.String"
  1660. abstract="false" native="false" synchronized="false"
  1661. static="false" final="false" visibility="public"
  1662. deprecated="not deprecated">
  1663. </method>
  1664. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1665. transient="false" volatile="false"
  1666. static="true" final="true" visibility="public"
  1667. deprecated="not deprecated">
  1668. </field>
  1669. <doc>
  1670. <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
  1671. ApplicationMasters to authenticate to the ResourceManager.]]>
  1672. </doc>
  1673. </class>
  1674. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1675. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1676. <class name="AMRMTokenSelector" extends="java.lang.Object"
  1677. abstract="false"
  1678. static="false" final="false" visibility="public"
  1679. deprecated="not deprecated">
  1680. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1681. <constructor name="AMRMTokenSelector"
  1682. static="false" final="false" visibility="public"
  1683. deprecated="not deprecated">
  1684. </constructor>
  1685. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1686. abstract="false" native="false" synchronized="false"
  1687. static="false" final="false" visibility="public"
  1688. deprecated="not deprecated">
  1689. <param name="service" type="org.apache.hadoop.io.Text"/>
  1690. <param name="tokens" type="java.util.Collection"/>
  1691. </method>
  1692. </class>
  1693. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1694. <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1695. <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1696. abstract="false"
  1697. static="false" final="false" visibility="public"
  1698. deprecated="not deprecated">
  1699. <constructor name="ContainerManagerSecurityInfo"
  1700. static="false" final="false" visibility="public"
  1701. deprecated="not deprecated">
  1702. </constructor>
  1703. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1704. abstract="false" native="false" synchronized="false"
  1705. static="false" final="false" visibility="public"
  1706. deprecated="not deprecated">
  1707. <param name="protocol" type="java.lang.Class"/>
  1708. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1709. </method>
  1710. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1711. abstract="false" native="false" synchronized="false"
  1712. static="false" final="false" visibility="public"
  1713. deprecated="not deprecated">
  1714. <param name="protocol" type="java.lang.Class"/>
  1715. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1716. </method>
  1717. </class>
  1718. <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1719. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1720. <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1721. abstract="false"
  1722. static="false" final="false" visibility="public"
  1723. deprecated="not deprecated">
  1724. <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"
  1725. static="false" final="false" visibility="public"
  1726. deprecated="not deprecated">
  1727. </constructor>
  1728. <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"
  1729. static="false" final="false" visibility="public"
  1730. deprecated="not deprecated">
  1731. </constructor>
  1732. <constructor name="ContainerTokenIdentifier"
  1733. static="false" final="false" visibility="public"
  1734. deprecated="not deprecated">
  1735. <doc>
  1736. <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
  1737. </doc>
  1738. </constructor>
  1739. <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
  1740. abstract="false" native="false" synchronized="false"
  1741. static="false" final="false" visibility="public"
  1742. deprecated="not deprecated">
  1743. </method>
  1744. <method name="getApplicationSubmitter" return="java.lang.String"
  1745. abstract="false" native="false" synchronized="false"
  1746. static="false" final="false" visibility="public"
  1747. deprecated="not deprecated">
  1748. </method>
  1749. <method name="getNmHostAddress" return="java.lang.String"
  1750. abstract="false" native="false" synchronized="false"
  1751. static="false" final="false" visibility="public"
  1752. deprecated="not deprecated">
  1753. </method>
  1754. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  1755. abstract="false" native="false" synchronized="false"
  1756. static="false" final="false" visibility="public"
  1757. deprecated="not deprecated">
  1758. </method>
  1759. <method name="getExpiryTimeStamp" return="long"
  1760. abstract="false" native="false" synchronized="false"
  1761. static="false" final="false" visibility="public"
  1762. deprecated="not deprecated">
  1763. </method>
  1764. <method name="getMasterKeyId" return="int"
  1765. abstract="false" native="false" synchronized="false"
  1766. static="false" final="false" visibility="public"
  1767. deprecated="not deprecated">
  1768. </method>
  1769. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1770. abstract="false" native="false" synchronized="false"
  1771. static="false" final="false" visibility="public"
  1772. deprecated="not deprecated">
  1773. </method>
  1774. <method name="getCreationTime" return="long"
  1775. abstract="false" native="false" synchronized="false"
  1776. static="false" final="false" visibility="public"
  1777. deprecated="not deprecated">
  1778. </method>
  1779. <method name="getRMIdentifier" return="long"
  1780. abstract="false" native="false" synchronized="false"
  1781. static="false" final="false" visibility="public"
  1782. deprecated="not deprecated">
  1783. <doc>
  1784. <![CDATA[Get the RMIdentifier of RM in which containers are allocated
  1785. @return RMIdentifier]]>
  1786. </doc>
  1787. </method>
  1788. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
  1789. abstract="false" native="false" synchronized="false"
  1790. static="false" final="false" visibility="public"
  1791. deprecated="not deprecated">
  1792. </method>
  1793. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  1794. abstract="false" native="false" synchronized="false"
  1795. static="false" final="false" visibility="public"
  1796. deprecated="not deprecated">
  1797. </method>
  1798. <method name="write"
  1799. abstract="false" native="false" synchronized="false"
  1800. static="false" final="false" visibility="public"
  1801. deprecated="not deprecated">
  1802. <param name="out" type="java.io.DataOutput"/>
  1803. <exception name="IOException" type="java.io.IOException"/>
  1804. </method>
  1805. <method name="readFields"
  1806. abstract="false" native="false" synchronized="false"
  1807. static="false" final="false" visibility="public"
  1808. deprecated="not deprecated">
  1809. <param name="in" type="java.io.DataInput"/>
  1810. <exception name="IOException" type="java.io.IOException"/>
  1811. </method>
  1812. <method name="getKind" return="org.apache.hadoop.io.Text"
  1813. abstract="false" native="false" synchronized="false"
  1814. static="false" final="false" visibility="public"
  1815. deprecated="not deprecated">
  1816. </method>
  1817. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1818. abstract="false" native="false" synchronized="false"
  1819. static="false" final="false" visibility="public"
  1820. deprecated="not deprecated">
  1821. </method>
  1822. <method name="hashCode" return="int"
  1823. abstract="false" native="false" synchronized="false"
  1824. static="false" final="false" visibility="public"
  1825. deprecated="not deprecated">
  1826. </method>
  1827. <method name="equals" return="boolean"
  1828. abstract="false" native="false" synchronized="false"
  1829. static="false" final="false" visibility="public"
  1830. deprecated="not deprecated">
  1831. <param name="other" type="java.lang.Object"/>
  1832. </method>
  1833. <method name="toString" return="java.lang.String"
  1834. abstract="false" native="false" synchronized="false"
  1835. static="false" final="false" visibility="public"
  1836. deprecated="not deprecated">
  1837. </method>
  1838. <field name="KIND" type="org.apache.hadoop.io.Text"
  1839. transient="false" volatile="false"
  1840. static="true" final="true" visibility="public"
  1841. deprecated="not deprecated">
  1842. </field>
  1843. <doc>
  1844. <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
  1845. {@link Resource} needed by the container and the target NMs host-address.]]>
  1846. </doc>
  1847. </class>
  1848. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1849. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1850. <class name="ContainerTokenSelector" extends="java.lang.Object"
  1851. abstract="false"
  1852. static="false" final="false" visibility="public"
  1853. deprecated="not deprecated">
  1854. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1855. <constructor name="ContainerTokenSelector"
  1856. static="false" final="false" visibility="public"
  1857. deprecated="not deprecated">
  1858. </constructor>
  1859. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1860. abstract="false" native="false" synchronized="false"
  1861. static="false" final="false" visibility="public"
  1862. deprecated="not deprecated">
  1863. <param name="service" type="org.apache.hadoop.io.Text"/>
  1864. <param name="tokens" type="java.util.Collection"/>
  1865. </method>
  1866. </class>
  1867. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1868. <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1869. <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1870. abstract="false"
  1871. static="false" final="false" visibility="public"
  1872. deprecated="not deprecated">
  1873. <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
  1874. static="false" final="false" visibility="public"
  1875. deprecated="not deprecated">
  1876. </constructor>
  1877. <constructor name="NMTokenIdentifier"
  1878. static="false" final="false" visibility="public"
  1879. deprecated="not deprecated">
  1880. <doc>
  1881. <![CDATA[Default constructor needed by RPC/Secret manager]]>
  1882. </doc>
  1883. </constructor>
  1884. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1885. abstract="false" native="false" synchronized="false"
  1886. static="false" final="false" visibility="public"
  1887. deprecated="not deprecated">
  1888. </method>
  1889. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  1890. abstract="false" native="false" synchronized="false"
  1891. static="false" final="false" visibility="public"
  1892. deprecated="not deprecated">
  1893. </method>
  1894. <method name="getApplicationSubmitter" return="java.lang.String"
  1895. abstract="false" native="false" synchronized="false"
  1896. static="false" final="false" visibility="public"
  1897. deprecated="not deprecated">
  1898. </method>
  1899. <method name="getKeyId" return="int"
  1900. abstract="false" native="false" synchronized="false"
  1901. static="false" final="false" visibility="public"
  1902. deprecated="not deprecated">
  1903. </method>
  1904. <method name="write"
  1905. abstract="false" native="false" synchronized="false"
  1906. static="false" final="false" visibility="public"
  1907. deprecated="not deprecated">
  1908. <param name="out" type="java.io.DataOutput"/>
  1909. <exception name="IOException" type="java.io.IOException"/>
  1910. </method>
  1911. <method name="readFields"
  1912. abstract="false" native="false" synchronized="false"
  1913. static="false" final="false" visibility="public"
  1914. deprecated="not deprecated">
  1915. <param name="in" type="java.io.DataInput"/>
  1916. <exception name="IOException" type="java.io.IOException"/>
  1917. </method>
  1918. <method name="getKind" return="org.apache.hadoop.io.Text"
  1919. abstract="false" native="false" synchronized="false"
  1920. static="false" final="false" visibility="public"
  1921. deprecated="not deprecated">
  1922. </method>
  1923. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1924. abstract="false" native="false" synchronized="false"
  1925. static="false" final="false" visibility="public"
  1926. deprecated="not deprecated">
  1927. </method>
  1928. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
  1929. abstract="false" native="false" synchronized="false"
  1930. static="false" final="false" visibility="public"
  1931. deprecated="not deprecated">
  1932. </method>
  1933. <method name="hashCode" return="int"
  1934. abstract="false" native="false" synchronized="false"
  1935. static="false" final="false" visibility="public"
  1936. deprecated="not deprecated">
  1937. </method>
  1938. <method name="equals" return="boolean"
  1939. abstract="false" native="false" synchronized="false"
  1940. static="false" final="false" visibility="public"
  1941. deprecated="not deprecated">
  1942. <param name="other" type="java.lang.Object"/>
  1943. </method>
  1944. <method name="toString" return="java.lang.String"
  1945. abstract="false" native="false" synchronized="false"
  1946. static="false" final="false" visibility="public"
  1947. deprecated="not deprecated">
  1948. </method>
  1949. <field name="KIND" type="org.apache.hadoop.io.Text"
  1950. transient="false" volatile="false"
  1951. static="true" final="true" visibility="public"
  1952. deprecated="not deprecated">
  1953. </field>
  1954. </class>
  1955. <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1956. <!-- start class org.apache.hadoop.yarn.security.NMTokenSelector -->
  1957. <class name="NMTokenSelector" extends="java.lang.Object"
  1958. abstract="false"
  1959. static="false" final="false" visibility="public"
  1960. deprecated="not deprecated">
  1961. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1962. <constructor name="NMTokenSelector"
  1963. static="false" final="false" visibility="public"
  1964. deprecated="not deprecated">
  1965. </constructor>
  1966. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1967. abstract="false" native="false" synchronized="false"
  1968. static="false" final="false" visibility="public"
  1969. deprecated="not deprecated">
  1970. <param name="service" type="org.apache.hadoop.io.Text"/>
  1971. <param name="tokens" type="java.util.Collection"/>
  1972. </method>
  1973. </class>
  1974. <!-- end class org.apache.hadoop.yarn.security.NMTokenSelector -->
  1975. <!-- start class org.apache.hadoop.yarn.security.PrivilegedEntity.EntityType -->
  1976. <class name="PrivilegedEntity.EntityType" extends="java.lang.Enum"
  1977. abstract="false"
  1978. static="true" final="true" visibility="public"
  1979. deprecated="not deprecated">
  1980. <method name="values" return="org.apache.hadoop.yarn.security.PrivilegedEntity.EntityType[]"
  1981. abstract="false" native="false" synchronized="false"
  1982. static="true" final="false" visibility="public"
  1983. deprecated="not deprecated">
  1984. </method>
  1985. <method name="valueOf" return="org.apache.hadoop.yarn.security.PrivilegedEntity.EntityType"
  1986. abstract="false" native="false" synchronized="false"
  1987. static="true" final="false" visibility="public"
  1988. deprecated="not deprecated">
  1989. <param name="name" type="java.lang.String"/>
  1990. </method>
  1991. </class>
  1992. <!-- end class org.apache.hadoop.yarn.security.PrivilegedEntity.EntityType -->
  1993. <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1994. <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1995. abstract="false"
  1996. static="false" final="false" visibility="public"
  1997. deprecated="not deprecated">
  1998. <constructor name="SchedulerSecurityInfo"
  1999. static="false" final="false" visibility="public"
  2000. deprecated="not deprecated">
  2001. </constructor>
  2002. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2003. abstract="false" native="false" synchronized="false"
  2004. static="false" final="false" visibility="public"
  2005. deprecated="not deprecated">
  2006. <param name="protocol" type="java.lang.Class"/>
  2007. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2008. </method>
  2009. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2010. abstract="false" native="false" synchronized="false"
  2011. static="false" final="false" visibility="public"
  2012. deprecated="not deprecated">
  2013. <param name="protocol" type="java.lang.Class"/>
  2014. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2015. </method>
  2016. </class>
  2017. <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  2018. </package>
  2019. <package name="org.apache.hadoop.yarn.security.admin">
  2020. <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2021. <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2022. abstract="false"
  2023. static="false" final="false" visibility="public"
  2024. deprecated="not deprecated">
  2025. <constructor name="AdminSecurityInfo"
  2026. static="false" final="false" visibility="public"
  2027. deprecated="not deprecated">
  2028. </constructor>
  2029. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2030. abstract="false" native="false" synchronized="false"
  2031. static="false" final="false" visibility="public"
  2032. deprecated="not deprecated">
  2033. <param name="protocol" type="java.lang.Class"/>
  2034. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2035. </method>
  2036. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2037. abstract="false" native="false" synchronized="false"
  2038. static="false" final="false" visibility="public"
  2039. deprecated="not deprecated">
  2040. <param name="protocol" type="java.lang.Class"/>
  2041. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2042. </method>
  2043. </class>
  2044. <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2045. </package>
  2046. <package name="org.apache.hadoop.yarn.security.client">
  2047. <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2048. <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
  2049. abstract="true"
  2050. static="false" final="false" visibility="public"
  2051. deprecated="not deprecated">
  2052. <constructor name="BaseClientToAMTokenSecretManager"
  2053. static="false" final="false" visibility="public"
  2054. deprecated="not deprecated">
  2055. </constructor>
  2056. <doc>
  2057. <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
  2058. issued to clients by the RM using the underlying master-key shared by RM to
  2059. the AMs on their launch. All the methods are called by either Hadoop RPC or
  2060. YARN, so this class is strictly for the purpose of inherit/extend and
  2061. register with Hadoop RPC.]]>
  2062. </doc>
  2063. </class>
  2064. <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2065. <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2066. <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2067. abstract="false"
  2068. static="false" final="false" visibility="public"
  2069. deprecated="not deprecated">
  2070. <constructor name="ClientRMSecurityInfo"
  2071. static="false" final="false" visibility="public"
  2072. deprecated="not deprecated">
  2073. </constructor>
  2074. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2075. abstract="false" native="false" synchronized="false"
  2076. static="false" final="false" visibility="public"
  2077. deprecated="not deprecated">
  2078. <param name="protocol" type="java.lang.Class"/>
  2079. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2080. </method>
  2081. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2082. abstract="false" native="false" synchronized="false"
  2083. static="false" final="false" visibility="public"
  2084. deprecated="not deprecated">
  2085. <param name="protocol" type="java.lang.Class"/>
  2086. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2087. </method>
  2088. </class>
  2089. <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2090. <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2091. <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2092. abstract="false"
  2093. static="false" final="false" visibility="public"
  2094. deprecated="not deprecated">
  2095. <constructor name="ClientTimelineSecurityInfo"
  2096. static="false" final="false" visibility="public"
  2097. deprecated="not deprecated">
  2098. </constructor>
  2099. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2100. abstract="false" native="false" synchronized="false"
  2101. static="false" final="false" visibility="public"
  2102. deprecated="not deprecated">
  2103. <param name="protocol" type="java.lang.Class"/>
  2104. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2105. </method>
  2106. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2107. abstract="false" native="false" synchronized="false"
  2108. static="false" final="false" visibility="public"
  2109. deprecated="not deprecated">
  2110. <param name="protocol" type="java.lang.Class"/>
  2111. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2112. </method>
  2113. </class>
  2114. <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2115. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2116. <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  2117. abstract="false"
  2118. static="false" final="false" visibility="public"
  2119. deprecated="not deprecated">
  2120. <constructor name="ClientToAMTokenIdentifier"
  2121. static="false" final="false" visibility="public"
  2122. deprecated="not deprecated">
  2123. </constructor>
  2124. <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
  2125. static="false" final="false" visibility="public"
  2126. deprecated="not deprecated">
  2127. </constructor>
  2128. <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2129. abstract="false" native="false" synchronized="false"
  2130. static="false" final="false" visibility="public"
  2131. deprecated="not deprecated">
  2132. </method>
  2133. <method name="getClientName" return="java.lang.String"
  2134. abstract="false" native="false" synchronized="false"
  2135. static="false" final="false" visibility="public"
  2136. deprecated="not deprecated">
  2137. </method>
  2138. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
  2139. abstract="false" native="false" synchronized="false"
  2140. static="false" final="false" visibility="public"
  2141. deprecated="not deprecated">
  2142. </method>
  2143. <method name="write"
  2144. abstract="false" native="false" synchronized="false"
  2145. static="false" final="false" visibility="public"
  2146. deprecated="not deprecated">
  2147. <param name="out" type="java.io.DataOutput"/>
  2148. <exception name="IOException" type="java.io.IOException"/>
  2149. </method>
  2150. <method name="readFields"
  2151. abstract="false" native="false" synchronized="false"
  2152. static="false" final="false" visibility="public"
  2153. deprecated="not deprecated">
  2154. <param name="in" type="java.io.DataInput"/>
  2155. <exception name="IOException" type="java.io.IOException"/>
  2156. </method>
  2157. <method name="getKind" return="org.apache.hadoop.io.Text"
  2158. abstract="false" native="false" synchronized="false"
  2159. static="false" final="false" visibility="public"
  2160. deprecated="not deprecated">
  2161. </method>
  2162. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  2163. abstract="false" native="false" synchronized="false"
  2164. static="false" final="false" visibility="public"
  2165. deprecated="not deprecated">
  2166. </method>
  2167. <method name="hashCode" return="int"
  2168. abstract="false" native="false" synchronized="false"
  2169. static="false" final="false" visibility="public"
  2170. deprecated="not deprecated">
  2171. </method>
  2172. <method name="equals" return="boolean"
  2173. abstract="false" native="false" synchronized="false"
  2174. static="false" final="false" visibility="public"
  2175. deprecated="not deprecated">
  2176. <param name="other" type="java.lang.Object"/>
  2177. </method>
  2178. <method name="toString" return="java.lang.String"
  2179. abstract="false" native="false" synchronized="false"
  2180. static="false" final="false" visibility="public"
  2181. deprecated="not deprecated">
  2182. </method>
  2183. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2184. transient="false" volatile="false"
  2185. static="true" final="true" visibility="public"
  2186. deprecated="not deprecated">
  2187. </field>
  2188. </class>
  2189. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2190. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2191. <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
  2192. abstract="false"
  2193. static="false" final="false" visibility="public"
  2194. deprecated="not deprecated">
  2195. <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
  2196. static="false" final="false" visibility="public"
  2197. deprecated="not deprecated">
  2198. </constructor>
  2199. <method name="retrievePassword" return="byte[]"
  2200. abstract="false" native="false" synchronized="false"
  2201. static="false" final="false" visibility="public"
  2202. deprecated="not deprecated">
  2203. <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
  2204. <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
  2205. </method>
  2206. <method name="getMasterKey" return="javax.crypto.SecretKey"
  2207. abstract="false" native="false" synchronized="false"
  2208. static="false" final="false" visibility="public"
  2209. deprecated="not deprecated">
  2210. <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2211. </method>
  2212. <method name="setMasterKey"
  2213. abstract="false" native="false" synchronized="false"
  2214. static="false" final="false" visibility="public"
  2215. deprecated="not deprecated">
  2216. <param name="key" type="byte[]"/>
  2217. </method>
  2218. <doc>
  2219. <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
  2220. clients by the RM using the underlying master-key shared by RM to the AMs on
  2221. their launch. All the methods are called by either Hadoop RPC or YARN, so
  2222. this class is strictly for the purpose of inherit/extend and register with
  2223. Hadoop RPC.]]>
  2224. </doc>
  2225. </class>
  2226. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2227. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSelector -->
  2228. <class name="ClientToAMTokenSelector" extends="java.lang.Object"
  2229. abstract="false"
  2230. static="false" final="false" visibility="public"
  2231. deprecated="not deprecated">
  2232. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2233. <constructor name="ClientToAMTokenSelector"
  2234. static="false" final="false" visibility="public"
  2235. deprecated="not deprecated">
  2236. </constructor>
  2237. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2238. abstract="false" native="false" synchronized="false"
  2239. static="false" final="false" visibility="public"
  2240. deprecated="not deprecated">
  2241. <param name="service" type="org.apache.hadoop.io.Text"/>
  2242. <param name="tokens" type="java.util.Collection"/>
  2243. </method>
  2244. </class>
  2245. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSelector -->
  2246. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2247. <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2248. abstract="false"
  2249. static="false" final="false" visibility="public"
  2250. deprecated="not deprecated">
  2251. <constructor name="RMDelegationTokenIdentifier"
  2252. static="false" final="false" visibility="public"
  2253. deprecated="not deprecated">
  2254. </constructor>
  2255. <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2256. static="false" final="false" visibility="public"
  2257. deprecated="not deprecated">
  2258. <doc>
  2259. <![CDATA[Create a new delegation token identifier
  2260. @param owner the effective username of the token owner
  2261. @param renewer the username of the renewer
  2262. @param realUser the real username of the token owner]]>
  2263. </doc>
  2264. </constructor>
  2265. <method name="getKind" return="org.apache.hadoop.io.Text"
  2266. abstract="false" native="false" synchronized="false"
  2267. static="false" final="false" visibility="public"
  2268. deprecated="not deprecated">
  2269. </method>
  2270. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2271. transient="false" volatile="false"
  2272. static="true" final="true" visibility="public"
  2273. deprecated="not deprecated">
  2274. </field>
  2275. <doc>
  2276. <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
  2277. Resource Manager.]]>
  2278. </doc>
  2279. </class>
  2280. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2281. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier.Renewer -->
  2282. <class name="RMDelegationTokenIdentifier.Renewer" extends="org.apache.hadoop.security.token.TokenRenewer"
  2283. abstract="false"
  2284. static="true" final="false" visibility="public"
  2285. deprecated="not deprecated">
  2286. <constructor name="RMDelegationTokenIdentifier.Renewer"
  2287. static="false" final="false" visibility="public"
  2288. deprecated="not deprecated">
  2289. </constructor>
  2290. <method name="handleKind" return="boolean"
  2291. abstract="false" native="false" synchronized="false"
  2292. static="false" final="false" visibility="public"
  2293. deprecated="not deprecated">
  2294. <param name="kind" type="org.apache.hadoop.io.Text"/>
  2295. </method>
  2296. <method name="isManaged" return="boolean"
  2297. abstract="false" native="false" synchronized="false"
  2298. static="false" final="false" visibility="public"
  2299. deprecated="not deprecated">
  2300. <param name="token" type="org.apache.hadoop.security.token.Token"/>
  2301. <exception name="IOException" type="java.io.IOException"/>
  2302. </method>
  2303. <method name="renew" return="long"
  2304. abstract="false" native="false" synchronized="false"
  2305. static="false" final="false" visibility="public"
  2306. deprecated="not deprecated">
  2307. <param name="token" type="org.apache.hadoop.security.token.Token"/>
  2308. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2309. <exception name="IOException" type="java.io.IOException"/>
  2310. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  2311. </method>
  2312. <method name="cancel"
  2313. abstract="false" native="false" synchronized="false"
  2314. static="false" final="false" visibility="public"
  2315. deprecated="not deprecated">
  2316. <param name="token" type="org.apache.hadoop.security.token.Token"/>
  2317. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2318. <exception name="IOException" type="java.io.IOException"/>
  2319. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  2320. </method>
  2321. </class>
  2322. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier.Renewer -->
  2323. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2324. <class name="RMDelegationTokenSelector" extends="java.lang.Object"
  2325. abstract="false"
  2326. static="false" final="false" visibility="public"
  2327. deprecated="not deprecated">
  2328. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2329. <constructor name="RMDelegationTokenSelector"
  2330. static="false" final="false" visibility="public"
  2331. deprecated="not deprecated">
  2332. </constructor>
  2333. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2334. abstract="false" native="false" synchronized="false"
  2335. static="false" final="false" visibility="public"
  2336. deprecated="not deprecated">
  2337. <param name="service" type="org.apache.hadoop.io.Text"/>
  2338. <param name="tokens" type="java.util.Collection"/>
  2339. </method>
  2340. </class>
  2341. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2342. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2343. <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2344. abstract="false"
  2345. static="false" final="false" visibility="public"
  2346. deprecated="not deprecated">
  2347. <constructor name="TimelineDelegationTokenIdentifier"
  2348. static="false" final="false" visibility="public"
  2349. deprecated="not deprecated">
  2350. </constructor>
  2351. <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2352. static="false" final="false" visibility="public"
  2353. deprecated="not deprecated">
  2354. <doc>
  2355. <![CDATA[Create a new timeline delegation token identifier
  2356. @param owner the effective username of the token owner
  2357. @param renewer the username of the renewer
  2358. @param realUser the real username of the token owner]]>
  2359. </doc>
  2360. </constructor>
  2361. <method name="getKind" return="org.apache.hadoop.io.Text"
  2362. abstract="false" native="false" synchronized="false"
  2363. static="false" final="false" visibility="public"
  2364. deprecated="not deprecated">
  2365. </method>
  2366. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2367. transient="false" volatile="false"
  2368. static="true" final="true" visibility="public"
  2369. deprecated="not deprecated">
  2370. </field>
  2371. </class>
  2372. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2373. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2374. <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
  2375. abstract="false"
  2376. static="false" final="false" visibility="public"
  2377. deprecated="not deprecated">
  2378. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2379. <constructor name="TimelineDelegationTokenSelector"
  2380. static="false" final="false" visibility="public"
  2381. deprecated="not deprecated">
  2382. </constructor>
  2383. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2384. abstract="false" native="false" synchronized="false"
  2385. static="false" final="false" visibility="public"
  2386. deprecated="not deprecated">
  2387. <param name="service" type="org.apache.hadoop.io.Text"/>
  2388. <param name="tokens" type="java.util.Collection"/>
  2389. </method>
  2390. </class>
  2391. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2392. </package>
  2393. <package name="org.apache.hadoop.yarn.server.api">
  2394. </package>
  2395. <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
  2396. <!-- start class org.apache.hadoop.yarn.server.api.impl.pb.client.SCMAdminProtocolPBClientImpl -->
  2397. <class name="SCMAdminProtocolPBClientImpl" extends="java.lang.Object"
  2398. abstract="false"
  2399. static="false" final="false" visibility="public"
  2400. deprecated="not deprecated">
  2401. <implements name="org.apache.hadoop.yarn.server.api.SCMAdminProtocol"/>
  2402. <implements name="java.io.Closeable"/>
  2403. <constructor name="SCMAdminProtocolPBClientImpl" type="long, java.net.InetSocketAddress, org.apache.hadoop.conf.Configuration"
  2404. static="false" final="false" visibility="public"
  2405. deprecated="not deprecated">
  2406. <exception name="IOException" type="java.io.IOException"/>
  2407. </constructor>
  2408. <method name="close"
  2409. abstract="false" native="false" synchronized="false"
  2410. static="false" final="false" visibility="public"
  2411. deprecated="not deprecated">
  2412. </method>
  2413. <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
  2414. abstract="false" native="false" synchronized="false"
  2415. static="false" final="false" visibility="public"
  2416. deprecated="not deprecated">
  2417. <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
  2418. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  2419. <exception name="IOException" type="java.io.IOException"/>
  2420. </method>
  2421. </class>
  2422. <!-- end class org.apache.hadoop.yarn.server.api.impl.pb.client.SCMAdminProtocolPBClientImpl -->
  2423. </package>
  2424. <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
  2425. <!-- start class org.apache.hadoop.yarn.server.api.impl.pb.service.SCMAdminProtocolPBServiceImpl -->
  2426. <class name="SCMAdminProtocolPBServiceImpl" extends="java.lang.Object"
  2427. abstract="false"
  2428. static="false" final="false" visibility="public"
  2429. deprecated="not deprecated">
  2430. <implements name="org.apache.hadoop.yarn.server.api.SCMAdminProtocolPB"/>
  2431. <constructor name="SCMAdminProtocolPBServiceImpl" type="org.apache.hadoop.yarn.server.api.SCMAdminProtocol"
  2432. static="false" final="false" visibility="public"
  2433. deprecated="not deprecated">
  2434. </constructor>
  2435. <method name="runCleanerTask" return="org.apache.hadoop.yarn.proto.YarnServiceProtos.RunSharedCacheCleanerTaskResponseProto"
  2436. abstract="false" native="false" synchronized="false"
  2437. static="false" final="false" visibility="public"
  2438. deprecated="not deprecated">
  2439. <param name="controller" type="com.google.protobuf.RpcController"/>
  2440. <param name="proto" type="org.apache.hadoop.yarn.proto.YarnServiceProtos.RunSharedCacheCleanerTaskRequestProto"/>
  2441. <exception name="ServiceException" type="com.google.protobuf.ServiceException"/>
  2442. </method>
  2443. </class>
  2444. <!-- end class org.apache.hadoop.yarn.server.api.impl.pb.service.SCMAdminProtocolPBServiceImpl -->
  2445. </package>
  2446. <package name="org.apache.hadoop.yarn.sharedcache">
  2447. <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2448. <interface name="SharedCacheChecksum" abstract="true"
  2449. static="false" final="false" visibility="public"
  2450. deprecated="not deprecated">
  2451. <method name="computeChecksum" return="java.lang.String"
  2452. abstract="false" native="false" synchronized="false"
  2453. static="false" final="false" visibility="public"
  2454. deprecated="not deprecated">
  2455. <param name="in" type="java.io.InputStream"/>
  2456. <exception name="IOException" type="java.io.IOException"/>
  2457. <doc>
  2458. <![CDATA[Calculate the checksum of the passed input stream.
  2459. @param in <code>InputStream</code> to be checksumed
  2460. @return the message digest of the input stream
  2461. @throws IOException]]>
  2462. </doc>
  2463. </method>
  2464. </interface>
  2465. <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2466. <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2467. <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
  2468. abstract="false"
  2469. static="false" final="false" visibility="public"
  2470. deprecated="not deprecated">
  2471. <constructor name="SharedCacheChecksumFactory"
  2472. static="false" final="false" visibility="public"
  2473. deprecated="not deprecated">
  2474. </constructor>
  2475. <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
  2476. abstract="false" native="false" synchronized="false"
  2477. static="true" final="false" visibility="public"
  2478. deprecated="not deprecated">
  2479. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2480. <doc>
  2481. <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
  2482. algorithm implementation
  2483. (see <code>yarn.sharedcache.checksum.algo.impl</code>)
  2484. @return <code>SharedCacheChecksum</code> object]]>
  2485. </doc>
  2486. </method>
  2487. </class>
  2488. <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2489. </package>
  2490. <package name="org.apache.hadoop.yarn.state">
  2491. <!-- start class org.apache.hadoop.yarn.state.Graph.Edge -->
  2492. <class name="Graph.Edge" extends="java.lang.Object"
  2493. abstract="false"
  2494. static="false" final="false" visibility="public"
  2495. deprecated="not deprecated">
  2496. <constructor name="Graph.Edge" type="org.apache.hadoop.yarn.state.Graph.Node, org.apache.hadoop.yarn.state.Graph.Node, java.lang.String"
  2497. static="false" final="false" visibility="public"
  2498. deprecated="not deprecated">
  2499. </constructor>
  2500. <method name="sameAs" return="boolean"
  2501. abstract="false" native="false" synchronized="false"
  2502. static="false" final="false" visibility="public"
  2503. deprecated="not deprecated">
  2504. <param name="rhs" type="org.apache.hadoop.yarn.state.Graph.Edge"/>
  2505. </method>
  2506. <method name="combine" return="org.apache.hadoop.yarn.state.Graph.Edge"
  2507. abstract="false" native="false" synchronized="false"
  2508. static="false" final="false" visibility="public"
  2509. deprecated="not deprecated">
  2510. <param name="rhs" type="org.apache.hadoop.yarn.state.Graph.Edge"/>
  2511. </method>
  2512. </class>
  2513. <!-- end class org.apache.hadoop.yarn.state.Graph.Edge -->
  2514. <!-- start class org.apache.hadoop.yarn.state.Graph.Node -->
  2515. <class name="Graph.Node" extends="java.lang.Object"
  2516. abstract="false"
  2517. static="false" final="false" visibility="public"
  2518. deprecated="not deprecated">
  2519. <constructor name="Graph.Node" type="java.lang.String"
  2520. static="false" final="false" visibility="public"
  2521. deprecated="not deprecated">
  2522. </constructor>
  2523. <method name="getParent" return="org.apache.hadoop.yarn.state.Graph"
  2524. abstract="false" native="false" synchronized="false"
  2525. static="false" final="false" visibility="public"
  2526. deprecated="not deprecated">
  2527. </method>
  2528. <method name="addEdge" return="org.apache.hadoop.yarn.state.Graph.Node"
  2529. abstract="false" native="false" synchronized="false"
  2530. static="false" final="false" visibility="public"
  2531. deprecated="not deprecated">
  2532. <param name="to" type="org.apache.hadoop.yarn.state.Graph.Node"/>
  2533. <param name="info" type="java.lang.String"/>
  2534. </method>
  2535. <method name="getUniqueId" return="java.lang.String"
  2536. abstract="false" native="false" synchronized="false"
  2537. static="false" final="false" visibility="public"
  2538. deprecated="not deprecated">
  2539. </method>
  2540. </class>
  2541. <!-- end class org.apache.hadoop.yarn.state.Graph.Node -->
  2542. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2543. <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  2544. abstract="false"
  2545. static="false" final="false" visibility="public"
  2546. deprecated="not deprecated">
  2547. <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
  2548. static="false" final="false" visibility="public"
  2549. deprecated="not deprecated">
  2550. </constructor>
  2551. <method name="getCurrentState" return="java.lang.Enum"
  2552. abstract="false" native="false" synchronized="false"
  2553. static="false" final="false" visibility="public"
  2554. deprecated="not deprecated">
  2555. </method>
  2556. <method name="getEvent" return="java.lang.Enum"
  2557. abstract="false" native="false" synchronized="false"
  2558. static="false" final="false" visibility="public"
  2559. deprecated="not deprecated">
  2560. </method>
  2561. </class>
  2562. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2563. <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2564. <interface name="MultipleArcTransition" abstract="true"
  2565. static="false" final="false" visibility="public"
  2566. deprecated="not deprecated">
  2567. <method name="transition" return="STATE"
  2568. abstract="false" native="false" synchronized="false"
  2569. static="false" final="false" visibility="public"
  2570. deprecated="not deprecated">
  2571. <param name="operand" type="OPERAND"/>
  2572. <param name="event" type="EVENT"/>
  2573. <doc>
  2574. <![CDATA[Transition hook.
  2575. @return the postState. Post state must be one of the
  2576. valid post states registered in StateMachine.
  2577. @param operand the entity attached to the FSM, whose internal
  2578. state may change.
  2579. @param event causal event]]>
  2580. </doc>
  2581. </method>
  2582. <doc>
  2583. <![CDATA[Hook for Transition.
  2584. Post state is decided by Transition hook. Post state must be one of the
  2585. valid post states registered in StateMachine.]]>
  2586. </doc>
  2587. </interface>
  2588. <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2589. <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2590. <interface name="SingleArcTransition" abstract="true"
  2591. static="false" final="false" visibility="public"
  2592. deprecated="not deprecated">
  2593. <method name="transition"
  2594. abstract="false" native="false" synchronized="false"
  2595. static="false" final="false" visibility="public"
  2596. deprecated="not deprecated">
  2597. <param name="operand" type="OPERAND"/>
  2598. <param name="event" type="EVENT"/>
  2599. <doc>
  2600. <![CDATA[Transition hook.
  2601. @param operand the entity attached to the FSM, whose internal
  2602. state may change.
  2603. @param event causal event]]>
  2604. </doc>
  2605. </method>
  2606. <doc>
  2607. <![CDATA[Hook for Transition. This lead to state machine to move to
  2608. the post state as registered in the state machine.]]>
  2609. </doc>
  2610. </interface>
  2611. <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2612. <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
  2613. <interface name="StateMachine" abstract="true"
  2614. static="false" final="false" visibility="public"
  2615. deprecated="not deprecated">
  2616. <method name="getCurrentState" return="STATE"
  2617. abstract="false" native="false" synchronized="false"
  2618. static="false" final="false" visibility="public"
  2619. deprecated="not deprecated">
  2620. </method>
  2621. <method name="doTransition" return="STATE"
  2622. abstract="false" native="false" synchronized="false"
  2623. static="false" final="false" visibility="public"
  2624. deprecated="not deprecated">
  2625. <param name="eventType" type="EVENTTYPE"/>
  2626. <param name="event" type="EVENT"/>
  2627. <exception name="InvalidStateTransitonException" type="org.apache.hadoop.yarn.state.InvalidStateTransitonException"/>
  2628. </method>
  2629. </interface>
  2630. <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
  2631. <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2632. <class name="StateMachineFactory" extends="java.lang.Object"
  2633. abstract="false"
  2634. static="false" final="true" visibility="public"
  2635. deprecated="not deprecated">
  2636. <constructor name="StateMachineFactory" type="STATE"
  2637. static="false" final="false" visibility="public"
  2638. deprecated="not deprecated">
  2639. <doc>
  2640. <![CDATA[Constructor
  2641. This is the only constructor in the API.]]>
  2642. </doc>
  2643. </constructor>
  2644. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2645. abstract="false" native="false" synchronized="false"
  2646. static="false" final="false" visibility="public"
  2647. deprecated="not deprecated">
  2648. <param name="preState" type="STATE"/>
  2649. <param name="postState" type="STATE"/>
  2650. <param name="eventType" type="EVENTTYPE"/>
  2651. <doc>
  2652. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2653. transition added as a new legal transition. This overload
  2654. has no hook object.
  2655. Note that the returned StateMachineFactory is a distinct
  2656. object.
  2657. This method is part of the API.
  2658. @param preState pre-transition state
  2659. @param postState post-transition state
  2660. @param eventType stimulus for the transition]]>
  2661. </doc>
  2662. </method>
  2663. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2664. abstract="false" native="false" synchronized="false"
  2665. static="false" final="false" visibility="public"
  2666. deprecated="not deprecated">
  2667. <param name="preState" type="STATE"/>
  2668. <param name="postState" type="STATE"/>
  2669. <param name="eventTypes" type="java.util.Set"/>
  2670. <doc>
  2671. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2672. transition added as a new legal transition. This overload
  2673. has no hook object.
  2674. Note that the returned StateMachineFactory is a distinct
  2675. object.
  2676. This method is part of the API.
  2677. @param preState pre-transition state
  2678. @param postState post-transition state
  2679. @param eventTypes List of stimuli for the transitions]]>
  2680. </doc>
  2681. </method>
  2682. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2683. abstract="false" native="false" synchronized="false"
  2684. static="false" final="false" visibility="public"
  2685. deprecated="not deprecated">
  2686. <param name="preState" type="STATE"/>
  2687. <param name="postState" type="STATE"/>
  2688. <param name="eventTypes" type="java.util.Set"/>
  2689. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2690. <doc>
  2691. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2692. transition added as a new legal transition
  2693. Note that the returned StateMachineFactory is a distinct
  2694. object.
  2695. This method is part of the API.
  2696. @param preState pre-transition state
  2697. @param postState post-transition state
  2698. @param eventTypes List of stimuli for the transitions
  2699. @param hook transition hook]]>
  2700. </doc>
  2701. </method>
  2702. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2703. abstract="false" native="false" synchronized="false"
  2704. static="false" final="false" visibility="public"
  2705. deprecated="not deprecated">
  2706. <param name="preState" type="STATE"/>
  2707. <param name="postState" type="STATE"/>
  2708. <param name="eventType" type="EVENTTYPE"/>
  2709. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2710. <doc>
  2711. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2712. transition added as a new legal transition
  2713. Note that the returned StateMachineFactory is a distinct object.
  2714. This method is part of the API.
  2715. @param preState pre-transition state
  2716. @param postState post-transition state
  2717. @param eventType stimulus for the transition
  2718. @param hook transition hook]]>
  2719. </doc>
  2720. </method>
  2721. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2722. abstract="false" native="false" synchronized="false"
  2723. static="false" final="false" visibility="public"
  2724. deprecated="not deprecated">
  2725. <param name="preState" type="STATE"/>
  2726. <param name="postStates" type="java.util.Set"/>
  2727. <param name="eventType" type="EVENTTYPE"/>
  2728. <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
  2729. <doc>
  2730. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2731. transition added as a new legal transition
  2732. Note that the returned StateMachineFactory is a distinct object.
  2733. This method is part of the API.
  2734. @param preState pre-transition state
  2735. @param postStates valid post-transition states
  2736. @param eventType stimulus for the transition
  2737. @param hook transition hook]]>
  2738. </doc>
  2739. </method>
  2740. <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2741. abstract="false" native="false" synchronized="false"
  2742. static="false" final="false" visibility="public"
  2743. deprecated="not deprecated">
  2744. <doc>
  2745. <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
  2746. you won't need any synchronization to build a state machine
  2747. Note that the returned StateMachineFactory is a distinct object.
  2748. This method is part of the API.
  2749. The only way you could distinguish the returned
  2750. StateMachineFactory from {@code this} would be by
  2751. measuring the performance of the derived
  2752. {@code StateMachine} you can get from it.
  2753. Calling this is optional. It doesn't change the semantics of the factory,
  2754. if you call it then when you use the factory there is no synchronization.]]>
  2755. </doc>
  2756. </method>
  2757. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2758. abstract="false" native="false" synchronized="false"
  2759. static="false" final="false" visibility="public"
  2760. deprecated="not deprecated">
  2761. <param name="operand" type="OPERAND"/>
  2762. <param name="initialState" type="STATE"/>
  2763. </method>
  2764. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2765. abstract="false" native="false" synchronized="false"
  2766. static="false" final="false" visibility="public"
  2767. deprecated="not deprecated">
  2768. <param name="operand" type="OPERAND"/>
  2769. </method>
  2770. <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
  2771. abstract="false" native="false" synchronized="false"
  2772. static="false" final="false" visibility="public"
  2773. deprecated="not deprecated">
  2774. <param name="name" type="java.lang.String"/>
  2775. <doc>
  2776. <![CDATA[Generate a graph represents the state graph of this StateMachine
  2777. @param name graph name
  2778. @return Graph object generated]]>
  2779. </doc>
  2780. </method>
  2781. <doc>
  2782. <![CDATA[State machine topology.
  2783. This object is semantically immutable. If you have a
  2784. StateMachineFactory there's no operation in the API that changes
  2785. its semantic properties.
  2786. @param <OPERAND> The object type on which this state machine operates.
  2787. @param <STATE> The state of the entity.
  2788. @param <EVENTTYPE> The external eventType to be handled.
  2789. @param <EVENT> The event object.]]>
  2790. </doc>
  2791. </class>
  2792. <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2793. </package>
  2794. <package name="org.apache.hadoop.yarn.util">
  2795. <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2796. <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
  2797. abstract="true"
  2798. static="false" final="false" visibility="public"
  2799. deprecated="not deprecated">
  2800. <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
  2801. static="false" final="false" visibility="public"
  2802. deprecated="not deprecated">
  2803. </constructor>
  2804. <method name="serviceStart"
  2805. abstract="false" native="false" synchronized="false"
  2806. static="false" final="false" visibility="protected"
  2807. deprecated="not deprecated">
  2808. <exception name="Exception" type="java.lang.Exception"/>
  2809. </method>
  2810. <method name="serviceStop"
  2811. abstract="false" native="false" synchronized="false"
  2812. static="false" final="false" visibility="protected"
  2813. deprecated="not deprecated">
  2814. <exception name="Exception" type="java.lang.Exception"/>
  2815. </method>
  2816. <method name="expire"
  2817. abstract="true" native="false" synchronized="false"
  2818. static="false" final="false" visibility="protected"
  2819. deprecated="not deprecated">
  2820. <param name="ob" type="O"/>
  2821. </method>
  2822. <method name="setExpireInterval"
  2823. abstract="false" native="false" synchronized="false"
  2824. static="false" final="false" visibility="protected"
  2825. deprecated="not deprecated">
  2826. <param name="expireInterval" type="int"/>
  2827. </method>
  2828. <method name="setMonitorInterval"
  2829. abstract="false" native="false" synchronized="false"
  2830. static="false" final="false" visibility="protected"
  2831. deprecated="not deprecated">
  2832. <param name="monitorInterval" type="int"/>
  2833. </method>
  2834. <method name="receivedPing"
  2835. abstract="false" native="false" synchronized="true"
  2836. static="false" final="false" visibility="public"
  2837. deprecated="not deprecated">
  2838. <param name="ob" type="O"/>
  2839. </method>
  2840. <method name="register"
  2841. abstract="false" native="false" synchronized="true"
  2842. static="false" final="false" visibility="public"
  2843. deprecated="not deprecated">
  2844. <param name="ob" type="O"/>
  2845. </method>
  2846. <method name="unregister"
  2847. abstract="false" native="false" synchronized="true"
  2848. static="false" final="false" visibility="public"
  2849. deprecated="not deprecated">
  2850. <param name="ob" type="O"/>
  2851. </method>
  2852. <method name="resetTimer"
  2853. abstract="false" native="false" synchronized="true"
  2854. static="false" final="false" visibility="public"
  2855. deprecated="not deprecated">
  2856. </method>
  2857. <field name="DEFAULT_EXPIRE" type="int"
  2858. transient="false" volatile="false"
  2859. static="true" final="true" visibility="public"
  2860. deprecated="not deprecated">
  2861. </field>
  2862. <doc>
  2863. <![CDATA[A simple liveliness monitor with which clients can register, trust the
  2864. component to monitor liveliness, get a call-back on expiry and then finally
  2865. unregister.]]>
  2866. </doc>
  2867. </class>
  2868. <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2869. <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2870. <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
  2871. abstract="false"
  2872. static="false" final="false" visibility="public"
  2873. deprecated="not deprecated">
  2874. <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
  2875. static="false" final="false" visibility="public"
  2876. deprecated="not deprecated">
  2877. </constructor>
  2878. <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
  2879. static="false" final="false" visibility="public"
  2880. deprecated="not deprecated">
  2881. <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
  2882. </constructor>
  2883. <doc>
  2884. <![CDATA[This type has been deprecated in favor of
  2885. {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
  2886. ApplicationClassLoader should use that type instead.]]>
  2887. </doc>
  2888. </class>
  2889. <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2890. <!-- start class org.apache.hadoop.yarn.util.AuxiliaryServiceHelper -->
  2891. <class name="AuxiliaryServiceHelper" extends="java.lang.Object"
  2892. abstract="false"
  2893. static="false" final="false" visibility="public"
  2894. deprecated="not deprecated">
  2895. <constructor name="AuxiliaryServiceHelper"
  2896. static="false" final="false" visibility="public"
  2897. deprecated="not deprecated">
  2898. </constructor>
  2899. <method name="getServiceDataFromEnv" return="java.nio.ByteBuffer"
  2900. abstract="false" native="false" synchronized="false"
  2901. static="true" final="false" visibility="public"
  2902. deprecated="not deprecated">
  2903. <param name="serviceName" type="java.lang.String"/>
  2904. <param name="env" type="java.util.Map"/>
  2905. </method>
  2906. <method name="setServiceDataIntoEnv"
  2907. abstract="false" native="false" synchronized="false"
  2908. static="true" final="false" visibility="public"
  2909. deprecated="not deprecated">
  2910. <param name="serviceName" type="java.lang.String"/>
  2911. <param name="metaData" type="java.nio.ByteBuffer"/>
  2912. <param name="env" type="java.util.Map"/>
  2913. </method>
  2914. <field name="NM_AUX_SERVICE" type="java.lang.String"
  2915. transient="false" volatile="false"
  2916. static="true" final="true" visibility="public"
  2917. deprecated="not deprecated">
  2918. </field>
  2919. </class>
  2920. <!-- end class org.apache.hadoop.yarn.util.AuxiliaryServiceHelper -->
  2921. <!-- start interface org.apache.hadoop.yarn.util.Clock -->
  2922. <interface name="Clock" abstract="true"
  2923. static="false" final="false" visibility="public"
  2924. deprecated="not deprecated">
  2925. <method name="getTime" return="long"
  2926. abstract="false" native="false" synchronized="false"
  2927. static="false" final="false" visibility="public"
  2928. deprecated="not deprecated">
  2929. </method>
  2930. <doc>
  2931. <![CDATA[A simple clock interface that gives you time.]]>
  2932. </doc>
  2933. </interface>
  2934. <!-- end interface org.apache.hadoop.yarn.util.Clock -->
  2935. <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  2936. <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
  2937. abstract="true"
  2938. static="false" final="false" visibility="public"
  2939. deprecated="not deprecated">
  2940. <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
  2941. static="false" final="false" visibility="public"
  2942. deprecated="not deprecated">
  2943. <doc>
  2944. <![CDATA[Create process-tree instance with specified root process.
  2945. Subclass must override this.
  2946. @param root process-tree root-process]]>
  2947. </doc>
  2948. </constructor>
  2949. <method name="updateProcessTree"
  2950. abstract="true" native="false" synchronized="false"
  2951. static="false" final="false" visibility="public"
  2952. deprecated="not deprecated">
  2953. <doc>
  2954. <![CDATA[Update the process-tree with latest state.
  2955. Each call to this function should increment the age of the running
  2956. processes that already exist in the process tree. Age is used other API's
  2957. of the interface.]]>
  2958. </doc>
  2959. </method>
  2960. <method name="getProcessTreeDump" return="java.lang.String"
  2961. abstract="true" native="false" synchronized="false"
  2962. static="false" final="false" visibility="public"
  2963. deprecated="not deprecated">
  2964. <doc>
  2965. <![CDATA[Get a dump of the process-tree.
  2966. @return a string concatenating the dump of information of all the processes
  2967. in the process-tree]]>
  2968. </doc>
  2969. </method>
  2970. <method name="getVirtualMemorySize" return="long"
  2971. abstract="false" native="false" synchronized="false"
  2972. static="false" final="false" visibility="public"
  2973. deprecated="not deprecated">
  2974. <doc>
  2975. <![CDATA[Get the virtual memory used by all the processes in the
  2976. process-tree.
  2977. @return virtual memory used by the process-tree in bytes,
  2978. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2979. </doc>
  2980. </method>
  2981. <method name="getCumulativeVmem" return="long"
  2982. abstract="false" native="false" synchronized="false"
  2983. static="false" final="false" visibility="public"
  2984. deprecated="not deprecated">
  2985. <doc>
  2986. <![CDATA[Get the virtual memory used by all the processes in the
  2987. process-tree.
  2988. @return virtual memory used by the process-tree in bytes,
  2989. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  2990. </doc>
  2991. </method>
  2992. <method name="getRssMemorySize" return="long"
  2993. abstract="false" native="false" synchronized="false"
  2994. static="false" final="false" visibility="public"
  2995. deprecated="not deprecated">
  2996. <doc>
  2997. <![CDATA[Get the resident set size (rss) memory used by all the processes
  2998. in the process-tree.
  2999. @return rss memory used by the process-tree in bytes,
  3000. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3001. </doc>
  3002. </method>
  3003. <method name="getCumulativeRssmem" return="long"
  3004. abstract="false" native="false" synchronized="false"
  3005. static="false" final="false" visibility="public"
  3006. deprecated="not deprecated">
  3007. <doc>
  3008. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3009. in the process-tree.
  3010. @return rss memory used by the process-tree in bytes,
  3011. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3012. </doc>
  3013. </method>
  3014. <method name="getVirtualMemorySize" return="long"
  3015. abstract="false" native="false" synchronized="false"
  3016. static="false" final="false" visibility="public"
  3017. deprecated="not deprecated">
  3018. <param name="olderThanAge" type="int"/>
  3019. <doc>
  3020. <![CDATA[Get the virtual memory used by all the processes in the
  3021. process-tree that are older than the passed in age.
  3022. @param olderThanAge processes above this age are included in the
  3023. memory addition
  3024. @return virtual memory used by the process-tree in bytes for
  3025. processes older than the specified age, {@link #UNAVAILABLE} if it
  3026. cannot be calculated.]]>
  3027. </doc>
  3028. </method>
  3029. <method name="getCumulativeVmem" return="long"
  3030. abstract="false" native="false" synchronized="false"
  3031. static="false" final="false" visibility="public"
  3032. deprecated="not deprecated">
  3033. <param name="olderThanAge" type="int"/>
  3034. <doc>
  3035. <![CDATA[Get the virtual memory used by all the processes in the
  3036. process-tree that are older than the passed in age.
  3037. @param olderThanAge processes above this age are included in the
  3038. memory addition
  3039. @return virtual memory used by the process-tree in bytes for
  3040. processes older than the specified age, {@link #UNAVAILABLE} if it
  3041. cannot be calculated.]]>
  3042. </doc>
  3043. </method>
  3044. <method name="getRssMemorySize" return="long"
  3045. abstract="false" native="false" synchronized="false"
  3046. static="false" final="false" visibility="public"
  3047. deprecated="not deprecated">
  3048. <param name="olderThanAge" type="int"/>
  3049. <doc>
  3050. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3051. in the process-tree that are older than the passed in age.
  3052. @param olderThanAge processes above this age are included in the
  3053. memory addition
  3054. @return rss memory used by the process-tree in bytes for
  3055. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  3056. calculated.]]>
  3057. </doc>
  3058. </method>
  3059. <method name="getCumulativeRssmem" return="long"
  3060. abstract="false" native="false" synchronized="false"
  3061. static="false" final="false" visibility="public"
  3062. deprecated="not deprecated">
  3063. <param name="olderThanAge" type="int"/>
  3064. <doc>
  3065. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3066. in the process-tree that are older than the passed in age.
  3067. @param olderThanAge processes above this age are included in the
  3068. memory addition
  3069. @return rss memory used by the process-tree in bytes for
  3070. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  3071. calculated.]]>
  3072. </doc>
  3073. </method>
  3074. <method name="getCumulativeCpuTime" return="long"
  3075. abstract="false" native="false" synchronized="false"
  3076. static="false" final="false" visibility="public"
  3077. deprecated="not deprecated">
  3078. <doc>
  3079. <![CDATA[Get the CPU time in millisecond used by all the processes in the
  3080. process-tree since the process-tree was created
  3081. @return cumulative CPU time in millisecond since the process-tree
  3082. created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3083. </doc>
  3084. </method>
  3085. <method name="getCpuUsagePercent" return="float"
  3086. abstract="false" native="false" synchronized="false"
  3087. static="false" final="false" visibility="public"
  3088. deprecated="not deprecated">
  3089. <doc>
  3090. <![CDATA[Get the CPU usage by all the processes in the process-tree based on
  3091. average between samples as a ratio of overall CPU cycles similar to top.
  3092. Thus, if 2 out of 4 cores are used this should return 200.0.
  3093. @return percentage CPU usage since the process-tree was created,
  3094. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3095. </doc>
  3096. </method>
  3097. <method name="checkPidPgrpidForMatch" return="boolean"
  3098. abstract="true" native="false" synchronized="false"
  3099. static="false" final="false" visibility="public"
  3100. deprecated="not deprecated">
  3101. <doc>
  3102. <![CDATA[Verify that the tree process id is same as its process group id.
  3103. @return true if the process id matches else return false.]]>
  3104. </doc>
  3105. </method>
  3106. <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
  3107. abstract="false" native="false" synchronized="false"
  3108. static="true" final="false" visibility="public"
  3109. deprecated="not deprecated">
  3110. <param name="pid" type="java.lang.String"/>
  3111. <param name="clazz" type="java.lang.Class"/>
  3112. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3113. <doc>
  3114. <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
  3115. from the class name and configure it. If class name is null, this method
  3116. will try and return a process tree plugin available for this system.
  3117. @param pid process pid of the root of the process tree
  3118. @param clazz class-name
  3119. @param conf configure the plugin with this.
  3120. @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
  3121. is not available for this system.]]>
  3122. </doc>
  3123. </method>
  3124. <field name="UNAVAILABLE" type="int"
  3125. transient="false" volatile="false"
  3126. static="true" final="true" visibility="public"
  3127. deprecated="not deprecated">
  3128. </field>
  3129. <doc>
  3130. <![CDATA[Interface class to obtain process resource usage
  3131. NOTE: This class should not be used by external users, but only by external
  3132. developers to extend and include their own process-tree implementation,
  3133. especially for platforms other than Linux and Windows.]]>
  3134. </doc>
  3135. </class>
  3136. <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3137. <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
  3138. <class name="SystemClock" extends="java.lang.Object"
  3139. abstract="false"
  3140. static="false" final="false" visibility="public"
  3141. deprecated="not deprecated">
  3142. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3143. <constructor name="SystemClock"
  3144. static="false" final="false" visibility="public"
  3145. deprecated="not deprecated">
  3146. </constructor>
  3147. <method name="getTime" return="long"
  3148. abstract="false" native="false" synchronized="false"
  3149. static="false" final="false" visibility="public"
  3150. deprecated="not deprecated">
  3151. </method>
  3152. <doc>
  3153. <![CDATA[Implementation of {@link Clock} that gives the current time from the system
  3154. clock in milliseconds.]]>
  3155. </doc>
  3156. </class>
  3157. <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
  3158. <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
  3159. <class name="UTCClock" extends="java.lang.Object"
  3160. abstract="false"
  3161. static="false" final="false" visibility="public"
  3162. deprecated="not deprecated">
  3163. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3164. <constructor name="UTCClock"
  3165. static="false" final="false" visibility="public"
  3166. deprecated="not deprecated">
  3167. </constructor>
  3168. <method name="getTime" return="long"
  3169. abstract="false" native="false" synchronized="false"
  3170. static="false" final="false" visibility="public"
  3171. deprecated="not deprecated">
  3172. </method>
  3173. <doc>
  3174. <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
  3175. milliseconds.]]>
  3176. </doc>
  3177. </class>
  3178. <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
  3179. </package>
  3180. <package name="org.apache.hadoop.yarn.util.resource">
  3181. </package>
  3182. <package name="org.apache.hadoop.yarn.util.timeline">
  3183. <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3184. <class name="TimelineUtils" extends="java.lang.Object"
  3185. abstract="false"
  3186. static="false" final="false" visibility="public"
  3187. deprecated="not deprecated">
  3188. <constructor name="TimelineUtils"
  3189. static="false" final="false" visibility="public"
  3190. deprecated="not deprecated">
  3191. </constructor>
  3192. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3193. abstract="false" native="false" synchronized="false"
  3194. static="true" final="false" visibility="public"
  3195. deprecated="not deprecated">
  3196. <param name="o" type="java.lang.Object"/>
  3197. <exception name="JsonGenerationException" type="org.codehaus.jackson.JsonGenerationException"/>
  3198. <exception name="JsonMappingException" type="org.codehaus.jackson.map.JsonMappingException"/>
  3199. <exception name="IOException" type="java.io.IOException"/>
  3200. <doc>
  3201. <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
  3202. @param o
  3203. an object to serialize
  3204. @return a JSON string
  3205. @throws IOException
  3206. @throws JsonMappingException
  3207. @throws JsonGenerationException]]>
  3208. </doc>
  3209. </method>
  3210. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3211. abstract="false" native="false" synchronized="false"
  3212. static="true" final="false" visibility="public"
  3213. deprecated="not deprecated">
  3214. <param name="o" type="java.lang.Object"/>
  3215. <param name="pretty" type="boolean"/>
  3216. <exception name="JsonGenerationException" type="org.codehaus.jackson.JsonGenerationException"/>
  3217. <exception name="JsonMappingException" type="org.codehaus.jackson.map.JsonMappingException"/>
  3218. <exception name="IOException" type="java.io.IOException"/>
  3219. <doc>
  3220. <![CDATA[Serialize a POJO object into a JSON string
  3221. @param o
  3222. an object to serialize
  3223. @param pretty
  3224. whether in a pretty format or not
  3225. @return a JSON string
  3226. @throws IOException
  3227. @throws JsonMappingException
  3228. @throws JsonGenerationException]]>
  3229. </doc>
  3230. </method>
  3231. <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
  3232. abstract="false" native="false" synchronized="false"
  3233. static="true" final="false" visibility="public"
  3234. deprecated="not deprecated">
  3235. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3236. </method>
  3237. <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
  3238. abstract="false" native="false" synchronized="false"
  3239. static="true" final="false" visibility="public"
  3240. deprecated="not deprecated">
  3241. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3242. </method>
  3243. <doc>
  3244. <![CDATA[The helper class for the timeline module.]]>
  3245. </doc>
  3246. </class>
  3247. <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3248. </package>
  3249. <package name="org.apache.hadoop.yarn.webapp.util">
  3250. </package>
  3251. </api>