Apache_Hadoop_YARN_Common_3.1.2.xml 163 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Tue Jan 29 03:53:51 UTC 2019 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN Common 3.1.2"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -verbose -classpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/classes:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-3.1.2.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/maven/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/maven/commons-net/commons-net/3.6/commons-net-3.6.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/org/eclipse/jetty/jetty-server/9.3.24.v20180605/jetty-server-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-http/9.3.24.v20180605/jetty-http-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-io/9.3.24.v20180605/jetty-io-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-servlet/9.3.24.v20180605/jetty-servlet-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-security/9.3.24.v20180605/jetty-security-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-webapp/9.3.24.v20180605/jetty-webapp-9.3.24.v20180605.jar:/maven/org/eclipse/jetty/jetty-xml/9.3.24.v20180605/jetty-xml-9.3.24.v20180605.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19/jersey-servlet-1.19.jar:/maven/commons-beanutils/commons-beanutils/1.9.3/commons-beanutils-1.9.3.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.4/commons-lang3-3.4.jar:/maven/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/maven/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/maven/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/maven/org/apache/curator/curator-client/2.13.0/curator-client-2.13.0.jar:/maven/org/apache/curator/curator-recipes/2.13.0/curator-recipes-2.13.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/maven/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/maven/org/apache/zookeeper/zookeeper/3.4.13/zookeeper-3.4.13.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/io/netty/netty/3.10.5.Final/netty-3.10.5.Final.jar:/maven/org/apache/kerby/kerb-simplekdc/1.0.1/kerb-simplekdc-1.0.1.jar:/maven/org/apache/kerby/kerb-client/1.0.1/kerb-client-1.0.1.jar:/maven/org/apache/kerby/kerby-config/1.0.1/kerby-config-1.0.1.jar:/maven/org/apache/kerby/kerb-core/1.0.1/kerb-core-1.0.1.jar:/maven/org/apache/kerby/kerby-pkix/1.0.1/kerby-pkix-1.0.1.jar:/maven/org/apache/kerby/kerby-asn1/1.0.1/kerby-asn1-1.0.1.jar:/maven/org/apache/kerby/kerby-util/1.0.1/kerby-util-1.0.1.jar:/maven/org/apache/kerby/kerb-common/1.0.1/kerb-common-1.0.1.jar:/maven/org/apache/kerby/kerb-crypto/1.0.1/kerb-crypto-1.0.1.jar:/maven/org/apache/kerby/kerb-util/1.0.1/kerb-util-1.0.1.jar:/maven/org/apache/kerby/token-provider/1.0.1/token-provider-1.0.1.jar:/maven/org/apache/kerby/kerb-admin/1.0.1/kerb-admin-1.0.1.jar:/maven/org/apache/kerby/kerb-server/1.0.1/kerb-server-1.0.1.jar:/maven/org/apache/kerby/kerb-identity/1.0.1/kerb-identity-1.0.1.jar:/maven/org/apache/kerby/kerby-xdr/1.0.1/kerby-xdr-1.0.1.jar:/maven/org/codehaus/woodstox/stax2-api/3.1.4/stax2-api-3.1.4.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.0.3/woodstox-core-5.0.3.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-yarn-api-3.1.2.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.7.8/jackson-annotations-2.7.8.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.1.2.jar:/maven/com/nimbusds/nimbus-jose-jwt/4.41.1/nimbus-jose-jwt-4.41.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.3/json-smart-2.3.jar:/maven/net/minidev/accessors-smart/1.2/accessors-smart-1.2.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/curator/curator-framework/2.13.0/curator-framework-2.13.0.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/maven/org/apache/commons/commons-compress/1.18/commons-compress-1.18.jar:/maven/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/maven/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/maven/commons-codec/commons-codec/1.11/commons-codec-1.11.jar:/maven/org/eclipse/jetty/jetty-util/9.3.24.v20180605/jetty-util-9.3.24.v20180605.jar:/maven/com/sun/jersey/jersey-core/1.19/jersey-core-1.19.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-client/1.19/jersey-client-1.19.jar:/maven/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.1.2.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/maven/com/google/inject/extensions/guice-servlet/4.0/guice-servlet-4.0.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/commons-io/commons-io/2.5/commons-io-2.5.jar:/maven/com/google/inject/guice/4.0/guice-4.0.jar:/maven/javax/inject/javax.inject/1/javax.inject-1.jar:/maven/aopalliance/aopalliance/1.0/aopalliance-1.0.jar:/maven/com/sun/jersey/jersey-server/1.19/jersey-server-1.19.jar:/maven/com/sun/jersey/jersey-json/1.19/jersey-json-1.19.jar:/maven/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/maven/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/maven/com/sun/jersey/contribs/jersey-guice/1.19/jersey-guice-1.19.jar:/maven/log4j/log4j/1.2.17/log4j-1.2.17.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.7.8/jackson-core-2.7.8.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.7.8/jackson-databind-2.7.8.jar:/maven/com/fasterxml/jackson/module/jackson-module-jaxb-annotations/2.7.8/jackson-module-jaxb-annotations-2.7.8.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-json-provider/2.7.8/jackson-jaxrs-json-provider-2.7.8.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-base/2.7.8/jackson-jaxrs-base-2.7.8.jar:/maven/xerces/xercesImpl/2.11.0/xercesImpl-2.11.0.jar:/maven/xml-apis/xml-apis/1.4.01/xml-apis-1.4.01.jar -sourcepath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/jdiff.jar -apidir /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/target/site/jdiff/xml -apiname Apache Hadoop YARN Common 3.1.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="true"
  24. static="false" final="false" visibility="public"
  25. deprecated="not deprecated">
  26. </method>
  27. <method name="append"
  28. abstract="false" native="false" synchronized="true"
  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. <doc>
  79. <![CDATA[Setter so that log4j can configure it from the
  80. configuration(log4j.properties).]]>
  81. </doc>
  82. </method>
  83. <doc>
  84. <![CDATA[A simple log4j-appender for container's logs.]]>
  85. </doc>
  86. </class>
  87. <!-- end class org.apache.hadoop.yarn.ContainerLogAppender -->
  88. <!-- start class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  89. <class name="ContainerRollingLogAppender" extends="org.apache.log4j.RollingFileAppender"
  90. abstract="false"
  91. static="false" final="false" visibility="public"
  92. deprecated="not deprecated">
  93. <implements name="java.io.Flushable"/>
  94. <constructor name="ContainerRollingLogAppender"
  95. static="false" final="false" visibility="public"
  96. deprecated="not deprecated">
  97. </constructor>
  98. <method name="activateOptions"
  99. abstract="false" native="false" synchronized="false"
  100. static="false" final="false" visibility="public"
  101. deprecated="not deprecated">
  102. </method>
  103. <method name="flush"
  104. abstract="false" native="false" synchronized="false"
  105. static="false" final="false" visibility="public"
  106. deprecated="not deprecated">
  107. </method>
  108. <method name="getContainerLogDir" return="java.lang.String"
  109. abstract="false" native="false" synchronized="false"
  110. static="false" final="false" visibility="public"
  111. deprecated="not deprecated">
  112. <doc>
  113. <![CDATA[Getter/Setter methods for log4j.]]>
  114. </doc>
  115. </method>
  116. <method name="setContainerLogDir"
  117. abstract="false" native="false" synchronized="false"
  118. static="false" final="false" visibility="public"
  119. deprecated="not deprecated">
  120. <param name="containerLogDir" type="java.lang.String"/>
  121. </method>
  122. <method name="getContainerLogFile" return="java.lang.String"
  123. abstract="false" native="false" synchronized="false"
  124. static="false" final="false" visibility="public"
  125. deprecated="not deprecated">
  126. </method>
  127. <method name="setContainerLogFile"
  128. abstract="false" native="false" synchronized="false"
  129. static="false" final="false" visibility="public"
  130. deprecated="not deprecated">
  131. <param name="containerLogFile" type="java.lang.String"/>
  132. </method>
  133. <doc>
  134. <![CDATA[A simple log4j-appender for container's logs.]]>
  135. </doc>
  136. </class>
  137. <!-- end class org.apache.hadoop.yarn.ContainerRollingLogAppender -->
  138. <!-- start class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  139. <class name="YarnUncaughtExceptionHandler" extends="java.lang.Object"
  140. abstract="false"
  141. static="false" final="false" visibility="public"
  142. deprecated="not deprecated">
  143. <implements name="java.lang.Thread.UncaughtExceptionHandler"/>
  144. <constructor name="YarnUncaughtExceptionHandler"
  145. static="false" final="false" visibility="public"
  146. deprecated="not deprecated">
  147. </constructor>
  148. <method name="uncaughtException"
  149. abstract="false" native="false" synchronized="false"
  150. static="false" final="false" visibility="public"
  151. deprecated="not deprecated">
  152. <param name="t" type="java.lang.Thread"/>
  153. <param name="e" type="java.lang.Throwable"/>
  154. </method>
  155. <doc>
  156. <![CDATA[This class is intended to be installed by calling
  157. {@link Thread#setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)}
  158. In the main entry point. It is intended to try and cleanly shut down
  159. programs using the YARN Event framework.
  160. Note: Right now it only will shut down the program if a Error is caught, but
  161. not any other exception. Anything else is just logged.]]>
  162. </doc>
  163. </class>
  164. <!-- end class org.apache.hadoop.yarn.YarnUncaughtExceptionHandler -->
  165. </package>
  166. <package name="org.apache.hadoop.yarn.api">
  167. </package>
  168. <package name="org.apache.hadoop.yarn.client">
  169. <!-- start class org.apache.hadoop.yarn.client.AHSProxy -->
  170. <class name="AHSProxy" extends="java.lang.Object"
  171. abstract="false"
  172. static="false" final="false" visibility="public"
  173. deprecated="not deprecated">
  174. <constructor name="AHSProxy"
  175. static="false" final="false" visibility="public"
  176. deprecated="not deprecated">
  177. </constructor>
  178. <method name="createAHSProxy" return="T"
  179. abstract="false" native="false" synchronized="false"
  180. static="true" final="false" visibility="public"
  181. deprecated="not deprecated">
  182. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  183. <param name="protocol" type="java.lang.Class"/>
  184. <param name="ahsAddress" type="java.net.InetSocketAddress"/>
  185. <exception name="IOException" type="java.io.IOException"/>
  186. </method>
  187. <method name="getProxy" return="T"
  188. abstract="false" native="false" synchronized="false"
  189. static="true" final="false" visibility="protected"
  190. deprecated="not deprecated">
  191. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  192. <param name="protocol" type="java.lang.Class"/>
  193. <param name="rmAddress" type="java.net.InetSocketAddress"/>
  194. <exception name="IOException" type="java.io.IOException"/>
  195. </method>
  196. </class>
  197. <!-- end class org.apache.hadoop.yarn.client.AHSProxy -->
  198. <!-- start class org.apache.hadoop.yarn.client.ClientRMProxy -->
  199. <class name="ClientRMProxy" extends="org.apache.hadoop.yarn.client.RMProxy"
  200. abstract="false"
  201. static="false" final="false" visibility="public"
  202. deprecated="not deprecated">
  203. <method name="createRMProxy" return="T"
  204. abstract="false" native="false" synchronized="false"
  205. static="true" final="false" visibility="public"
  206. deprecated="not deprecated">
  207. <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
  208. <param name="protocol" type="java.lang.Class"/>
  209. <exception name="IOException" type="java.io.IOException"/>
  210. <doc>
  211. <![CDATA[Create a proxy to the ResourceManager for the specified protocol.
  212. @param configuration Configuration with all the required information.
  213. @param protocol Client protocol for which proxy is being requested.
  214. @param <T> Type of proxy.
  215. @return Proxy to the ResourceManager for the specified client protocol.
  216. @throws IOException]]>
  217. </doc>
  218. </method>
  219. <method name="getRMDelegationTokenService" return="org.apache.hadoop.io.Text"
  220. abstract="false" native="false" synchronized="false"
  221. static="true" final="false" visibility="public"
  222. deprecated="not deprecated">
  223. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  224. <doc>
  225. <![CDATA[Get the token service name to be used for RMDelegationToken. Depending
  226. on whether HA is enabled or not, this method generates the appropriate
  227. service name as a comma-separated list of service addresses.
  228. @param conf Configuration corresponding to the cluster we need the
  229. RMDelegationToken for
  230. @return - Service name for RMDelegationToken]]>
  231. </doc>
  232. </method>
  233. <method name="getAMRMTokenService" return="org.apache.hadoop.io.Text"
  234. abstract="false" native="false" synchronized="false"
  235. static="true" final="false" visibility="public"
  236. deprecated="not deprecated">
  237. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  238. </method>
  239. <method name="getTokenService" return="org.apache.hadoop.io.Text"
  240. abstract="false" native="false" synchronized="false"
  241. static="true" final="false" visibility="public"
  242. deprecated="not deprecated">
  243. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  244. <param name="address" type="java.lang.String"/>
  245. <param name="defaultAddr" type="java.lang.String"/>
  246. <param name="defaultPort" type="int"/>
  247. </method>
  248. </class>
  249. <!-- end class org.apache.hadoop.yarn.client.ClientRMProxy -->
  250. <!-- start class org.apache.hadoop.yarn.client.NMProxy -->
  251. <class name="NMProxy" extends="org.apache.hadoop.yarn.client.ServerProxy"
  252. abstract="false"
  253. static="false" final="false" visibility="public"
  254. deprecated="not deprecated">
  255. <constructor name="NMProxy"
  256. static="false" final="false" visibility="public"
  257. deprecated="not deprecated">
  258. </constructor>
  259. <method name="createNMProxy" return="T"
  260. abstract="false" native="false" synchronized="false"
  261. static="true" final="false" visibility="public"
  262. deprecated="not deprecated">
  263. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  264. <param name="protocol" type="java.lang.Class"/>
  265. <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
  266. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  267. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  268. </method>
  269. </class>
  270. <!-- end class org.apache.hadoop.yarn.client.NMProxy -->
  271. <!-- start class org.apache.hadoop.yarn.client.RMProxy -->
  272. <class name="RMProxy" extends="java.lang.Object"
  273. abstract="false"
  274. static="false" final="false" visibility="public"
  275. deprecated="not deprecated">
  276. <constructor name="RMProxy"
  277. static="false" final="false" visibility="protected"
  278. deprecated="not deprecated">
  279. </constructor>
  280. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  281. abstract="false" native="false" synchronized="false"
  282. static="true" final="false" visibility="protected"
  283. deprecated="not deprecated">
  284. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  285. <param name="retryTime" type="long"/>
  286. <param name="retryInterval" type="long"/>
  287. <param name="isHAEnabled" type="boolean"/>
  288. <doc>
  289. <![CDATA[Fetch retry policy from Configuration and create the
  290. retry policy with specified retryTime and retry interval.]]>
  291. </doc>
  292. </method>
  293. </class>
  294. <!-- end class org.apache.hadoop.yarn.client.RMProxy -->
  295. <!-- start class org.apache.hadoop.yarn.client.ServerProxy -->
  296. <class name="ServerProxy" extends="java.lang.Object"
  297. abstract="false"
  298. static="false" final="false" visibility="public"
  299. deprecated="not deprecated">
  300. <constructor name="ServerProxy"
  301. static="false" final="false" visibility="public"
  302. deprecated="not deprecated">
  303. </constructor>
  304. <method name="createRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
  305. abstract="false" native="false" synchronized="false"
  306. static="true" final="false" visibility="protected"
  307. deprecated="not deprecated">
  308. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  309. <param name="maxWaitTimeStr" type="java.lang.String"/>
  310. <param name="defMaxWaitTime" type="long"/>
  311. <param name="connectRetryIntervalStr" type="java.lang.String"/>
  312. <param name="defRetryInterval" type="long"/>
  313. </method>
  314. <method name="createRetriableProxy" return="T"
  315. abstract="false" native="false" synchronized="false"
  316. static="true" final="false" visibility="protected"
  317. deprecated="not deprecated">
  318. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  319. <param name="protocol" type="java.lang.Class"/>
  320. <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
  321. <param name="rpc" type="org.apache.hadoop.yarn.ipc.YarnRPC"/>
  322. <param name="serverAddress" type="java.net.InetSocketAddress"/>
  323. <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
  324. </method>
  325. </class>
  326. <!-- end class org.apache.hadoop.yarn.client.ServerProxy -->
  327. </package>
  328. <package name="org.apache.hadoop.yarn.client.api">
  329. <!-- start class org.apache.hadoop.yarn.client.api.AppAdminClient -->
  330. <class name="AppAdminClient" extends="org.apache.hadoop.service.CompositeService"
  331. abstract="true"
  332. static="false" final="false" visibility="public"
  333. deprecated="not deprecated">
  334. <constructor name="AppAdminClient"
  335. static="false" final="false" visibility="protected"
  336. deprecated="not deprecated">
  337. </constructor>
  338. <method name="createAppAdminClient" return="org.apache.hadoop.yarn.client.api.AppAdminClient"
  339. abstract="false" native="false" synchronized="false"
  340. static="true" final="false" visibility="public"
  341. deprecated="not deprecated">
  342. <param name="appType" type="java.lang.String"/>
  343. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  344. <doc>
  345. <![CDATA[<p>
  346. Create a new instance of AppAdminClient.
  347. </p>
  348. @param appType application type
  349. @param conf configuration
  350. @return app admin client]]>
  351. </doc>
  352. </method>
  353. <method name="actionLaunch" return="int"
  354. abstract="true" native="false" synchronized="false"
  355. static="false" final="false" visibility="public"
  356. deprecated="not deprecated">
  357. <param name="fileName" type="java.lang.String"/>
  358. <param name="appName" type="java.lang.String"/>
  359. <param name="lifetime" type="java.lang.Long"/>
  360. <param name="queue" type="java.lang.String"/>
  361. <exception name="IOException" type="java.io.IOException"/>
  362. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  363. <doc>
  364. <![CDATA[<p>
  365. Launch a new YARN application.
  366. </p>
  367. @param fileName specification of application
  368. @param appName name of the application
  369. @param lifetime lifetime of the application
  370. @param queue queue of the application
  371. @return exit code
  372. @throws IOException IOException
  373. @throws YarnException exception in client or server]]>
  374. </doc>
  375. </method>
  376. <method name="actionStop" return="int"
  377. abstract="true" native="false" synchronized="false"
  378. static="false" final="false" visibility="public"
  379. deprecated="not deprecated">
  380. <param name="appName" type="java.lang.String"/>
  381. <exception name="IOException" type="java.io.IOException"/>
  382. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  383. <doc>
  384. <![CDATA[<p>
  385. Stop a YARN application (attempt to stop gracefully before killing the
  386. application). In the case of a long-running service, the service may be
  387. restarted later.
  388. </p>
  389. @param appName the name of the application
  390. @return exit code
  391. @throws IOException IOException
  392. @throws YarnException exception in client or server]]>
  393. </doc>
  394. </method>
  395. <method name="actionStart" return="int"
  396. abstract="true" native="false" synchronized="false"
  397. static="false" final="false" visibility="public"
  398. deprecated="not deprecated">
  399. <param name="appName" type="java.lang.String"/>
  400. <exception name="IOException" type="java.io.IOException"/>
  401. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  402. <doc>
  403. <![CDATA[<p>
  404. Start a YARN application from a previously saved specification. In the
  405. case of a long-running service, the service must have been previously
  406. launched/started and then stopped, or previously saved but not started.
  407. </p>
  408. @param appName the name of the application
  409. @return exit code
  410. @throws IOException IOException
  411. @throws YarnException exception in client or server]]>
  412. </doc>
  413. </method>
  414. <method name="actionSave" return="int"
  415. abstract="true" native="false" synchronized="false"
  416. static="false" final="false" visibility="public"
  417. deprecated="not deprecated">
  418. <param name="fileName" type="java.lang.String"/>
  419. <param name="appName" type="java.lang.String"/>
  420. <param name="lifetime" type="java.lang.Long"/>
  421. <param name="queue" type="java.lang.String"/>
  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. Save the specification for a YARN application / long-running service.
  427. The application may be started later.
  428. </p>
  429. @param fileName specification of application to save
  430. @param appName name of the application
  431. @param lifetime lifetime of the application
  432. @param queue queue of the application
  433. @return exit code
  434. @throws IOException IOException
  435. @throws YarnException exception in client or server]]>
  436. </doc>
  437. </method>
  438. <method name="actionDestroy" return="int"
  439. abstract="true" native="false" synchronized="false"
  440. static="false" final="false" visibility="public"
  441. deprecated="not deprecated">
  442. <param name="appName" type="java.lang.String"/>
  443. <exception name="IOException" type="java.io.IOException"/>
  444. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  445. <doc>
  446. <![CDATA[<p>
  447. Remove the specification and all application data for a YARN application.
  448. The application cannot be running.
  449. </p>
  450. @param appName the name of the application
  451. @return exit code
  452. @throws IOException IOException
  453. @throws YarnException exception in client or server]]>
  454. </doc>
  455. </method>
  456. <method name="actionFlex" return="int"
  457. abstract="true" native="false" synchronized="false"
  458. static="false" final="false" visibility="public"
  459. deprecated="not deprecated">
  460. <param name="appName" type="java.lang.String"/>
  461. <param name="componentCounts" type="java.util.Map"/>
  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. Change the number of running containers for a component of a YARN
  467. application / long-running service.
  468. </p>
  469. @param appName the name of the application
  470. @param componentCounts map of component name to new component count or
  471. amount to change existing component count (e.g.
  472. 5, +5, -5)
  473. @return exit code
  474. @throws IOException IOException
  475. @throws YarnException exception in client or server]]>
  476. </doc>
  477. </method>
  478. <method name="enableFastLaunch" return="int"
  479. abstract="true" native="false" synchronized="false"
  480. static="false" final="false" visibility="public"
  481. deprecated="not deprecated">
  482. <param name="destinationFolder" type="java.lang.String"/>
  483. <exception name="IOException" type="java.io.IOException"/>
  484. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  485. <doc>
  486. <![CDATA[<p>
  487. Upload AM dependencies to HDFS. This makes future application launches
  488. faster since the dependencies do not have to be uploaded on each launch.
  489. </p>
  490. @param destinationFolder
  491. an optional HDFS folder where dependency tarball will be uploaded
  492. @return exit code
  493. @throws IOException
  494. IOException
  495. @throws YarnException
  496. exception in client or server]]>
  497. </doc>
  498. </method>
  499. <method name="getStatusString" return="java.lang.String"
  500. abstract="true" native="false" synchronized="false"
  501. static="false" final="false" visibility="public"
  502. deprecated="not deprecated">
  503. <param name="appIdOrName" type="java.lang.String"/>
  504. <exception name="IOException" type="java.io.IOException"/>
  505. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  506. <doc>
  507. <![CDATA[<p>
  508. Get detailed app specific status string for a YARN application.
  509. </p>
  510. @param appIdOrName appId or appName
  511. @return status string
  512. @throws IOException IOException
  513. @throws YarnException exception in client or server]]>
  514. </doc>
  515. </method>
  516. <method name="initiateUpgrade" return="int"
  517. abstract="true" native="false" synchronized="false"
  518. static="false" final="false" visibility="public"
  519. deprecated="not deprecated">
  520. <param name="appName" type="java.lang.String"/>
  521. <param name="fileName" type="java.lang.String"/>
  522. <param name="autoFinalize" type="boolean"/>
  523. <exception name="IOException" type="java.io.IOException"/>
  524. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  525. <doc>
  526. <![CDATA[Initiate upgrade of a long running service.
  527. @param appName the name of the application.
  528. @param fileName specification of application upgrade to save.
  529. @param autoFinalize when true, finalization of upgrade will be done
  530. automatically.
  531. @return exit code
  532. @throws IOException IOException
  533. @throws YarnException exception in client or server]]>
  534. </doc>
  535. </method>
  536. <method name="actionUpgradeInstances" return="int"
  537. abstract="true" native="false" synchronized="false"
  538. static="false" final="false" visibility="public"
  539. deprecated="not deprecated">
  540. <param name="appName" type="java.lang.String"/>
  541. <param name="componentInstances" type="java.util.List"/>
  542. <exception name="IOException" type="java.io.IOException"/>
  543. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  544. <doc>
  545. <![CDATA[Upgrade component instances of a long running service.
  546. @param appName the name of the application.
  547. @param componentInstances the name of the component instances.]]>
  548. </doc>
  549. </method>
  550. <method name="actionUpgradeComponents" return="int"
  551. abstract="true" native="false" synchronized="false"
  552. static="false" final="false" visibility="public"
  553. deprecated="not deprecated">
  554. <param name="appName" type="java.lang.String"/>
  555. <param name="components" type="java.util.List"/>
  556. <exception name="IOException" type="java.io.IOException"/>
  557. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  558. <doc>
  559. <![CDATA[Upgrade components of a long running service.
  560. @param appName the name of the application.
  561. @param components the name of the components.]]>
  562. </doc>
  563. </method>
  564. <method name="actionCleanUp" return="int"
  565. abstract="true" native="false" synchronized="false"
  566. static="false" final="false" visibility="public"
  567. deprecated="not deprecated">
  568. <param name="appName" type="java.lang.String"/>
  569. <param name="userName" type="java.lang.String"/>
  570. <exception name="IOException" type="java.io.IOException"/>
  571. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  572. <doc>
  573. <![CDATA[Operation to be performed by the RM after an application has completed.
  574. @param appName the name of the application.
  575. @param userName the name of the user.
  576. @return exit code]]>
  577. </doc>
  578. </method>
  579. <method name="getInstances" return="java.lang.String"
  580. abstract="true" native="false" synchronized="false"
  581. static="false" final="false" visibility="public"
  582. deprecated="not deprecated">
  583. <param name="appName" type="java.lang.String"/>
  584. <param name="components" type="java.util.List"/>
  585. <param name="version" type="java.lang.String"/>
  586. <param name="containerStates" type="java.util.List"/>
  587. <exception name="IOException" type="java.io.IOException"/>
  588. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  589. </method>
  590. <method name="actionUpgradeExpress" return="int"
  591. abstract="true" native="false" synchronized="false"
  592. static="false" final="false" visibility="public"
  593. deprecated="not deprecated">
  594. <param name="appName" type="java.lang.String"/>
  595. <param name="fileName" type="java.io.File"/>
  596. <exception name="IOException" type="java.io.IOException"/>
  597. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  598. <doc>
  599. <![CDATA[Express upgrade a long running service.
  600. @param appName the name of the application
  601. @param fileName specification of application upgrade to save.
  602. @return exit code]]>
  603. </doc>
  604. </method>
  605. <method name="actionCancelUpgrade" return="int"
  606. abstract="true" native="false" synchronized="false"
  607. static="false" final="false" visibility="public"
  608. deprecated="not deprecated">
  609. <param name="appName" type="java.lang.String"/>
  610. <exception name="IOException" type="java.io.IOException"/>
  611. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  612. <doc>
  613. <![CDATA[Cancels the upgrade of the service.
  614. @param appName the name of the application
  615. @return exit code
  616. @throws IOException
  617. @throws YarnException]]>
  618. </doc>
  619. </method>
  620. <field name="YARN_APP_ADMIN_CLIENT_PREFIX" type="java.lang.String"
  621. transient="false" volatile="false"
  622. static="true" final="true" visibility="public"
  623. deprecated="not deprecated">
  624. </field>
  625. <field name="DEFAULT_TYPE" type="java.lang.String"
  626. transient="false" volatile="false"
  627. static="true" final="true" visibility="public"
  628. deprecated="not deprecated">
  629. </field>
  630. <field name="DEFAULT_CLASS_NAME" 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="UNIT_TEST_TYPE" type="java.lang.String"
  636. transient="false" volatile="false"
  637. static="true" final="true" visibility="public"
  638. deprecated="not deprecated">
  639. </field>
  640. <field name="UNIT_TEST_CLASS_NAME" type="java.lang.String"
  641. transient="false" volatile="false"
  642. static="true" final="true" visibility="public"
  643. deprecated="not deprecated">
  644. </field>
  645. <doc>
  646. <![CDATA[Client for managing applications.]]>
  647. </doc>
  648. </class>
  649. <!-- end class org.apache.hadoop.yarn.client.api.AppAdminClient -->
  650. <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
  651. <class name="TimelineClient" extends="org.apache.hadoop.service.CompositeService"
  652. abstract="true"
  653. static="false" final="false" visibility="public"
  654. deprecated="not deprecated">
  655. <implements name="java.io.Flushable"/>
  656. <constructor name="TimelineClient" type="java.lang.String"
  657. static="false" final="false" visibility="protected"
  658. deprecated="not deprecated">
  659. </constructor>
  660. <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
  661. abstract="false" native="false" synchronized="false"
  662. static="true" final="false" visibility="public"
  663. deprecated="not deprecated">
  664. <doc>
  665. <![CDATA[Creates an instance of the timeline v.1.x client.
  666. The current UGI when the user initialize the client will be used to do the
  667. put and the delegation token operations. The current user may use
  668. {@link UserGroupInformation#doAs} another user to construct and initialize
  669. a timeline client if the following operations are supposed to be conducted
  670. by that user.
  671. @return the created timeline client instance]]>
  672. </doc>
  673. </method>
  674. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  675. abstract="true" native="false" synchronized="false"
  676. static="false" final="false" visibility="public"
  677. deprecated="not deprecated">
  678. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  679. <exception name="IOException" type="java.io.IOException"/>
  680. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  681. <doc>
  682. <![CDATA[<p>
  683. Send the information of a number of conceptual entities to the timeline
  684. server. It is a blocking API. The method will not return until it gets the
  685. response from the timeline server.
  686. </p>
  687. @param entities
  688. the collection of {@link TimelineEntity}
  689. @return the error information if the sent entities are not correctly stored
  690. @throws IOException if there are I/O errors
  691. @throws YarnException if entities are incomplete/invalid]]>
  692. </doc>
  693. </method>
  694. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  695. abstract="true" native="false" synchronized="false"
  696. static="false" final="false" visibility="public"
  697. deprecated="not deprecated">
  698. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  699. <param name="groupId" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  700. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  701. <exception name="IOException" type="java.io.IOException"/>
  702. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  703. <doc>
  704. <![CDATA[<p>
  705. Send the information of a number of conceptual entities to the timeline
  706. server. It is a blocking API. The method will not return until it gets the
  707. response from the timeline server.
  708. This API is only for timeline service v1.5
  709. </p>
  710. @param appAttemptId {@link ApplicationAttemptId}
  711. @param groupId {@link TimelineEntityGroupId}
  712. @param entities
  713. the collection of {@link TimelineEntity}
  714. @return the error information if the sent entities are not correctly stored
  715. @throws IOException if there are I/O errors
  716. @throws YarnException if entities are incomplete/invalid]]>
  717. </doc>
  718. </method>
  719. <method name="putDomain"
  720. abstract="true" native="false" synchronized="false"
  721. static="false" final="false" visibility="public"
  722. deprecated="not deprecated">
  723. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  724. <exception name="IOException" type="java.io.IOException"/>
  725. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  726. <doc>
  727. <![CDATA[<p>
  728. Send the information of a domain to the timeline server. It is a
  729. blocking API. The method will not return until it gets the response from
  730. the timeline server.
  731. </p>
  732. @param domain
  733. an {@link TimelineDomain} object
  734. @throws IOException
  735. @throws YarnException]]>
  736. </doc>
  737. </method>
  738. <method name="putDomain"
  739. abstract="true" native="false" synchronized="false"
  740. static="false" final="false" visibility="public"
  741. deprecated="not deprecated">
  742. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  743. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  744. <exception name="IOException" type="java.io.IOException"/>
  745. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  746. <doc>
  747. <![CDATA[<p>
  748. Send the information of a domain to the timeline server. It is a
  749. blocking API. The method will not return until it gets the response from
  750. the timeline server.
  751. This API is only for timeline service v1.5
  752. </p>
  753. @param domain
  754. an {@link TimelineDomain} object
  755. @param appAttemptId {@link ApplicationAttemptId}
  756. @throws IOException
  757. @throws YarnException]]>
  758. </doc>
  759. </method>
  760. <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
  761. abstract="true" native="false" synchronized="false"
  762. static="false" final="false" visibility="public"
  763. deprecated="not deprecated">
  764. <param name="renewer" type="java.lang.String"/>
  765. <exception name="IOException" type="java.io.IOException"/>
  766. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  767. <doc>
  768. <![CDATA[<p>
  769. Get a delegation token so as to be able to talk to the timeline server in a
  770. secure way.
  771. </p>
  772. @param renewer
  773. Address of the renewer who can renew these tokens when needed by
  774. securely talking to the timeline server
  775. @return a delegation token ({@link Token}) that can be used to talk to the
  776. timeline server
  777. @throws IOException
  778. @throws YarnException]]>
  779. </doc>
  780. </method>
  781. <method name="renewDelegationToken" return="long"
  782. abstract="true" native="false" synchronized="false"
  783. static="false" final="false" visibility="public"
  784. deprecated="not deprecated">
  785. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  786. <exception name="IOException" type="java.io.IOException"/>
  787. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  788. <doc>
  789. <![CDATA[<p>
  790. Renew a timeline delegation token.
  791. </p>
  792. @param timelineDT
  793. the delegation token to renew
  794. @return the new expiration time
  795. @throws IOException
  796. @throws YarnException]]>
  797. </doc>
  798. </method>
  799. <method name="cancelDelegationToken"
  800. abstract="true" native="false" synchronized="false"
  801. static="false" final="false" visibility="public"
  802. deprecated="not deprecated">
  803. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  804. <exception name="IOException" type="java.io.IOException"/>
  805. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  806. <doc>
  807. <![CDATA[<p>
  808. Cancel a timeline delegation token.
  809. </p>
  810. @param timelineDT
  811. the delegation token to cancel
  812. @throws IOException
  813. @throws YarnException]]>
  814. </doc>
  815. </method>
  816. <doc>
  817. <![CDATA[A client library that can be used to post some information in terms of a
  818. number of conceptual entities. This client library needs to be used along
  819. with Timeline V.1.x server versions.
  820. Refer {@link TimelineV2Client} for ATS V2 interface.]]>
  821. </doc>
  822. </class>
  823. <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
  824. <!-- start class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
  825. <class name="TimelineReaderClient" extends="org.apache.hadoop.service.CompositeService"
  826. abstract="true"
  827. static="false" final="false" visibility="public"
  828. deprecated="not deprecated">
  829. <constructor name="TimelineReaderClient" type="java.lang.String"
  830. static="false" final="false" visibility="public"
  831. deprecated="not deprecated">
  832. </constructor>
  833. <method name="createTimelineReaderClient" return="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
  834. abstract="false" native="false" synchronized="false"
  835. static="true" final="false" visibility="public"
  836. deprecated="not deprecated">
  837. <doc>
  838. <![CDATA[Create a new instance of Timeline Reader Client.]]>
  839. </doc>
  840. </method>
  841. <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  842. abstract="true" native="false" synchronized="false"
  843. static="false" final="false" visibility="public"
  844. deprecated="not deprecated">
  845. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  846. <param name="fields" type="java.lang.String"/>
  847. <param name="filters" type="java.util.Map"/>
  848. <exception name="IOException" type="java.io.IOException"/>
  849. <doc>
  850. <![CDATA[Gets application entity.
  851. @param appId application id
  852. @param fields Fields to be fetched. Defaults to INFO.
  853. @param filters Filters to be applied while fetching entities.
  854. @return entity of the application
  855. @throws IOException]]>
  856. </doc>
  857. </method>
  858. <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  859. abstract="true" native="false" synchronized="false"
  860. static="false" final="false" visibility="public"
  861. deprecated="not deprecated">
  862. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  863. <param name="fields" type="java.lang.String"/>
  864. <param name="filters" type="java.util.Map"/>
  865. <exception name="IOException" type="java.io.IOException"/>
  866. <doc>
  867. <![CDATA[Gets application attempt entity.
  868. @param appAttemptId application attempt id
  869. @param fields Fields to be fetched. Defaults to INFO.
  870. @param filters Filters to be applied while fetching entities.
  871. @return entity associated with application attempt
  872. @throws IOException]]>
  873. </doc>
  874. </method>
  875. <method name="getApplicationAttemptEntities" return="java.util.List"
  876. abstract="true" native="false" synchronized="false"
  877. static="false" final="false" visibility="public"
  878. deprecated="not deprecated">
  879. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  880. <param name="fields" type="java.lang.String"/>
  881. <param name="filters" type="java.util.Map"/>
  882. <param name="limit" type="long"/>
  883. <param name="fromId" type="java.lang.String"/>
  884. <exception name="IOException" type="java.io.IOException"/>
  885. <doc>
  886. <![CDATA[Gets application attempt entities.
  887. @param appId application id
  888. @param fields Fields to be fetched. Defaults to INFO.
  889. @param filters Filters to be applied while fetching entities.
  890. @param limit Number of entities to return.
  891. @param fromId Retrieve next set of generic ids from given fromId
  892. @return list of application attempt entities
  893. @throws IOException]]>
  894. </doc>
  895. </method>
  896. <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  897. abstract="true" native="false" synchronized="false"
  898. static="false" final="false" visibility="public"
  899. deprecated="not deprecated">
  900. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  901. <param name="fields" type="java.lang.String"/>
  902. <param name="filters" type="java.util.Map"/>
  903. <exception name="IOException" type="java.io.IOException"/>
  904. <doc>
  905. <![CDATA[Gets Timeline entity for the container.
  906. @param containerId container id
  907. @param fields Fields to be fetched. Defaults to INFO.
  908. @param filters Filters to be applied while fetching entities.
  909. @return timeline entity for container
  910. @throws IOException]]>
  911. </doc>
  912. </method>
  913. <method name="getContainerEntities" return="java.util.List"
  914. abstract="true" native="false" synchronized="false"
  915. static="false" final="false" visibility="public"
  916. deprecated="not deprecated">
  917. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  918. <param name="fields" type="java.lang.String"/>
  919. <param name="filters" type="java.util.Map"/>
  920. <param name="limit" type="long"/>
  921. <param name="fromId" type="java.lang.String"/>
  922. <exception name="IOException" type="java.io.IOException"/>
  923. <doc>
  924. <![CDATA[Gets container entities for an application.
  925. @param appId application id
  926. @param fields Fields to be fetched. Defaults to INFO.
  927. @param filters Filters to be applied while fetching entities.
  928. @param limit Number of entities to return.
  929. @param fromId Retrieve next set of generic ids from given fromId
  930. @return list of entities
  931. @throws IOException]]>
  932. </doc>
  933. </method>
  934. <doc>
  935. <![CDATA[A client library that can be used to get Timeline Entities associated with
  936. application, application attempt or containers. This client library needs to
  937. be used along with time line v.2 server version.]]>
  938. </doc>
  939. </class>
  940. <!-- end class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
  941. </package>
  942. <package name="org.apache.hadoop.yarn.client.api.impl">
  943. <!-- start class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
  944. <class name="TimelineReaderClientImpl" extends="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
  945. abstract="false"
  946. static="false" final="false" visibility="public"
  947. deprecated="not deprecated">
  948. <constructor name="TimelineReaderClientImpl"
  949. static="false" final="false" visibility="public"
  950. deprecated="not deprecated">
  951. </constructor>
  952. <method name="serviceInit"
  953. abstract="false" native="false" synchronized="false"
  954. static="false" final="false" visibility="protected"
  955. deprecated="not deprecated">
  956. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  957. <exception name="Exception" type="java.lang.Exception"/>
  958. </method>
  959. <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  960. abstract="false" native="false" synchronized="false"
  961. static="false" final="false" visibility="public"
  962. deprecated="not deprecated">
  963. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  964. <param name="fields" type="java.lang.String"/>
  965. <param name="filters" type="java.util.Map"/>
  966. <exception name="IOException" type="java.io.IOException"/>
  967. </method>
  968. <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  969. abstract="false" native="false" synchronized="false"
  970. static="false" final="false" visibility="public"
  971. deprecated="not deprecated">
  972. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  973. <param name="fields" type="java.lang.String"/>
  974. <param name="filters" type="java.util.Map"/>
  975. <exception name="IOException" type="java.io.IOException"/>
  976. </method>
  977. <method name="getApplicationAttemptEntities" return="java.util.List"
  978. abstract="false" native="false" synchronized="false"
  979. static="false" final="false" visibility="public"
  980. deprecated="not deprecated">
  981. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  982. <param name="fields" type="java.lang.String"/>
  983. <param name="filters" type="java.util.Map"/>
  984. <param name="limit" type="long"/>
  985. <param name="fromId" type="java.lang.String"/>
  986. <exception name="IOException" type="java.io.IOException"/>
  987. </method>
  988. <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  989. abstract="false" native="false" synchronized="false"
  990. static="false" final="false" visibility="public"
  991. deprecated="not deprecated">
  992. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  993. <param name="fields" type="java.lang.String"/>
  994. <param name="filters" type="java.util.Map"/>
  995. <exception name="IOException" type="java.io.IOException"/>
  996. </method>
  997. <method name="getContainerEntities" return="java.util.List"
  998. abstract="false" native="false" synchronized="false"
  999. static="false" final="false" visibility="public"
  1000. deprecated="not deprecated">
  1001. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1002. <param name="fields" type="java.lang.String"/>
  1003. <param name="filters" type="java.util.Map"/>
  1004. <param name="limit" type="long"/>
  1005. <param name="fromId" type="java.lang.String"/>
  1006. <exception name="IOException" type="java.io.IOException"/>
  1007. </method>
  1008. <method name="doGetUri" return="com.sun.jersey.api.client.ClientResponse"
  1009. abstract="false" native="false" synchronized="false"
  1010. static="false" final="false" visibility="protected"
  1011. deprecated="not deprecated">
  1012. <param name="base" type="java.net.URI"/>
  1013. <param name="path" type="java.lang.String"/>
  1014. <param name="params" type="javax.ws.rs.core.MultivaluedMap"/>
  1015. <exception name="IOException" type="java.io.IOException"/>
  1016. </method>
  1017. <doc>
  1018. <![CDATA[Implementation of TimelineReaderClient interface.]]>
  1019. </doc>
  1020. </class>
  1021. <!-- end class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
  1022. </package>
  1023. <package name="org.apache.hadoop.yarn.event">
  1024. <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
  1025. <class name="AbstractEvent" extends="java.lang.Object"
  1026. abstract="true"
  1027. static="false" final="false" visibility="public"
  1028. deprecated="not deprecated">
  1029. <implements name="org.apache.hadoop.yarn.event.Event"/>
  1030. <constructor name="AbstractEvent" type="TYPE"
  1031. static="false" final="false" visibility="public"
  1032. deprecated="not deprecated">
  1033. </constructor>
  1034. <constructor name="AbstractEvent" type="TYPE, long"
  1035. static="false" final="false" visibility="public"
  1036. deprecated="not deprecated">
  1037. </constructor>
  1038. <method name="getTimestamp" return="long"
  1039. abstract="false" native="false" synchronized="false"
  1040. static="false" final="false" visibility="public"
  1041. deprecated="not deprecated">
  1042. </method>
  1043. <method name="getType" return="TYPE"
  1044. abstract="false" native="false" synchronized="false"
  1045. static="false" final="false" visibility="public"
  1046. deprecated="not deprecated">
  1047. </method>
  1048. <method name="toString" return="java.lang.String"
  1049. abstract="false" native="false" synchronized="false"
  1050. static="false" final="false" visibility="public"
  1051. deprecated="not deprecated">
  1052. </method>
  1053. <doc>
  1054. <![CDATA[Parent class of all the events. All events extend this class.]]>
  1055. </doc>
  1056. </class>
  1057. <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
  1058. <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  1059. <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
  1060. abstract="false"
  1061. static="false" final="false" visibility="public"
  1062. deprecated="not deprecated">
  1063. <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
  1064. <constructor name="AsyncDispatcher"
  1065. static="false" final="false" visibility="public"
  1066. deprecated="not deprecated">
  1067. </constructor>
  1068. <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
  1069. static="false" final="false" visibility="public"
  1070. deprecated="not deprecated">
  1071. </constructor>
  1072. <constructor name="AsyncDispatcher" type="java.lang.String"
  1073. static="false" final="false" visibility="public"
  1074. deprecated="not deprecated">
  1075. <doc>
  1076. <![CDATA[Set a name for this dispatcher thread.
  1077. @param dispatcherName name of the dispatcher thread]]>
  1078. </doc>
  1079. </constructor>
  1080. <method name="disableExitOnDispatchException"
  1081. abstract="false" native="false" synchronized="false"
  1082. static="false" final="false" visibility="public"
  1083. deprecated="not deprecated">
  1084. </method>
  1085. <method name="serviceStart"
  1086. abstract="false" native="false" synchronized="false"
  1087. static="false" final="false" visibility="protected"
  1088. deprecated="not deprecated">
  1089. <exception name="Exception" type="java.lang.Exception"/>
  1090. </method>
  1091. <method name="setDrainEventsOnStop"
  1092. abstract="false" native="false" synchronized="false"
  1093. static="false" final="false" visibility="public"
  1094. deprecated="not deprecated">
  1095. </method>
  1096. <method name="serviceStop"
  1097. abstract="false" native="false" synchronized="false"
  1098. static="false" final="false" visibility="protected"
  1099. deprecated="not deprecated">
  1100. <exception name="Exception" type="java.lang.Exception"/>
  1101. </method>
  1102. <method name="dispatch"
  1103. abstract="false" native="false" synchronized="false"
  1104. static="false" final="false" visibility="protected"
  1105. deprecated="not deprecated">
  1106. <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
  1107. </method>
  1108. <method name="register"
  1109. abstract="false" native="false" synchronized="false"
  1110. static="false" final="false" visibility="public"
  1111. deprecated="not deprecated">
  1112. <param name="eventType" type="java.lang.Class"/>
  1113. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  1114. </method>
  1115. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  1116. abstract="false" native="false" synchronized="false"
  1117. static="false" final="false" visibility="public"
  1118. deprecated="not deprecated">
  1119. </method>
  1120. <method name="isEventThreadWaiting" return="boolean"
  1121. abstract="false" native="false" synchronized="false"
  1122. static="false" final="false" visibility="protected"
  1123. deprecated="not deprecated">
  1124. </method>
  1125. <method name="isDrained" return="boolean"
  1126. abstract="false" native="false" synchronized="false"
  1127. static="false" final="false" visibility="protected"
  1128. deprecated="not deprecated">
  1129. </method>
  1130. <method name="isStopped" return="boolean"
  1131. abstract="false" native="false" synchronized="false"
  1132. static="false" final="false" visibility="protected"
  1133. deprecated="not deprecated">
  1134. </method>
  1135. <field name="eventDispatchers" type="java.util.Map"
  1136. transient="false" volatile="false"
  1137. static="false" final="true" visibility="protected"
  1138. deprecated="not deprecated">
  1139. </field>
  1140. <doc>
  1141. <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
  1142. does that. Potentially there could be multiple channels for each event type
  1143. class and a thread pool can be used to dispatch the events.]]>
  1144. </doc>
  1145. </class>
  1146. <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  1147. <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
  1148. <interface name="Dispatcher" abstract="true"
  1149. static="false" final="false" visibility="public"
  1150. deprecated="not deprecated">
  1151. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  1152. abstract="true" native="false" synchronized="false"
  1153. static="false" final="false" visibility="public"
  1154. deprecated="not deprecated">
  1155. </method>
  1156. <method name="register"
  1157. abstract="true" native="false" synchronized="false"
  1158. static="false" final="false" visibility="public"
  1159. deprecated="not deprecated">
  1160. <param name="eventType" type="java.lang.Class"/>
  1161. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  1162. </method>
  1163. <doc>
  1164. <![CDATA[Event Dispatcher interface. It dispatches events to registered
  1165. event handlers based on event types.]]>
  1166. </doc>
  1167. </interface>
  1168. <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
  1169. <!-- start interface org.apache.hadoop.yarn.event.Event -->
  1170. <interface name="Event" abstract="true"
  1171. static="false" final="false" visibility="public"
  1172. deprecated="not deprecated">
  1173. <method name="getType" return="TYPE"
  1174. abstract="true" native="false" synchronized="false"
  1175. static="false" final="false" visibility="public"
  1176. deprecated="not deprecated">
  1177. </method>
  1178. <method name="getTimestamp" return="long"
  1179. abstract="true" native="false" synchronized="false"
  1180. static="false" final="false" visibility="public"
  1181. deprecated="not deprecated">
  1182. </method>
  1183. <method name="toString" return="java.lang.String"
  1184. abstract="true" native="false" synchronized="false"
  1185. static="false" final="false" visibility="public"
  1186. deprecated="not deprecated">
  1187. </method>
  1188. <doc>
  1189. <![CDATA[Interface defining events api.]]>
  1190. </doc>
  1191. </interface>
  1192. <!-- end interface org.apache.hadoop.yarn.event.Event -->
  1193. <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
  1194. <interface name="EventHandler" abstract="true"
  1195. static="false" final="false" visibility="public"
  1196. deprecated="not deprecated">
  1197. <method name="handle"
  1198. abstract="true" native="false" synchronized="false"
  1199. static="false" final="false" visibility="public"
  1200. deprecated="not deprecated">
  1201. <param name="event" type="T"/>
  1202. </method>
  1203. <doc>
  1204. <![CDATA[Interface for handling events of type T
  1205. @param <T> parameterized event of type T]]>
  1206. </doc>
  1207. </interface>
  1208. <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
  1209. </package>
  1210. <package name="org.apache.hadoop.yarn.factories">
  1211. </package>
  1212. <package name="org.apache.hadoop.yarn.factory.providers">
  1213. </package>
  1214. <package name="org.apache.hadoop.yarn.logaggregation">
  1215. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  1216. <class name="AggregatedLogFormat" extends="java.lang.Object"
  1217. abstract="false"
  1218. static="false" final="false" visibility="public"
  1219. deprecated="not deprecated">
  1220. <constructor name="AggregatedLogFormat"
  1221. static="false" final="false" visibility="public"
  1222. deprecated="not deprecated">
  1223. </constructor>
  1224. </class>
  1225. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  1226. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  1227. <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
  1228. abstract="false"
  1229. static="true" final="false" visibility="public"
  1230. deprecated="not deprecated">
  1231. <implements name="org.apache.hadoop.io.Writable"/>
  1232. <constructor name="LogKey"
  1233. static="false" final="false" visibility="public"
  1234. deprecated="not deprecated">
  1235. </constructor>
  1236. <constructor name="LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
  1237. static="false" final="false" visibility="public"
  1238. deprecated="not deprecated">
  1239. </constructor>
  1240. <constructor name="LogKey" type="java.lang.String"
  1241. static="false" final="false" visibility="public"
  1242. deprecated="not deprecated">
  1243. </constructor>
  1244. <method name="hashCode" return="int"
  1245. abstract="false" native="false" synchronized="false"
  1246. static="false" final="false" visibility="public"
  1247. deprecated="not deprecated">
  1248. </method>
  1249. <method name="equals" return="boolean"
  1250. abstract="false" native="false" synchronized="false"
  1251. static="false" final="false" visibility="public"
  1252. deprecated="not deprecated">
  1253. <param name="obj" type="java.lang.Object"/>
  1254. </method>
  1255. <method name="toString" return="java.lang.String"
  1256. abstract="false" native="false" synchronized="false"
  1257. static="false" final="false" visibility="public"
  1258. deprecated="not deprecated">
  1259. </method>
  1260. </class>
  1261. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  1262. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1263. <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
  1264. abstract="false"
  1265. static="true" final="false" visibility="public"
  1266. deprecated="not deprecated">
  1267. <constructor name="LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
  1268. static="false" final="false" visibility="public"
  1269. deprecated="not deprecated">
  1270. <exception name="IOException" type="java.io.IOException"/>
  1271. </constructor>
  1272. <method name="getApplicationOwner" return="java.lang.String"
  1273. abstract="false" native="false" synchronized="false"
  1274. static="false" final="false" visibility="public"
  1275. deprecated="not deprecated">
  1276. <exception name="IOException" type="java.io.IOException"/>
  1277. <doc>
  1278. <![CDATA[Returns the owner of the application.
  1279. @return the application owner.
  1280. @throws IOException if we can not get the application owner.]]>
  1281. </doc>
  1282. </method>
  1283. <method name="getApplicationAcls" return="java.util.Map"
  1284. abstract="false" native="false" synchronized="false"
  1285. static="false" final="false" visibility="public"
  1286. deprecated="not deprecated">
  1287. <exception name="IOException" type="java.io.IOException"/>
  1288. <doc>
  1289. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  1290. found.
  1291. @return a map of the Application ACLs.
  1292. @throws IOException if we can not get the application acls.]]>
  1293. </doc>
  1294. </method>
  1295. <method name="next" return="java.io.DataInputStream"
  1296. abstract="false" native="false" synchronized="false"
  1297. static="false" final="false" visibility="public"
  1298. deprecated="not deprecated">
  1299. <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  1300. <exception name="IOException" type="java.io.IOException"/>
  1301. <doc>
  1302. <![CDATA[Read the next key and return the value-stream.
  1303. @param key the log key
  1304. @return the valueStream if there are more keys or null otherwise
  1305. @throws IOException if we can not get the dataInputStream
  1306. for the next key]]>
  1307. </doc>
  1308. </method>
  1309. <method name="readAcontainerLogs"
  1310. abstract="false" native="false" synchronized="false"
  1311. static="true" final="false" visibility="public"
  1312. deprecated="not deprecated">
  1313. <param name="valueStream" type="java.io.DataInputStream"/>
  1314. <param name="writer" type="java.io.Writer"/>
  1315. <param name="logUploadedTime" type="long"/>
  1316. <exception name="IOException" type="java.io.IOException"/>
  1317. <doc>
  1318. <![CDATA[Writes all logs for a single container to the provided writer.
  1319. @param valueStream the valueStream
  1320. @param writer the log writer
  1321. @param logUploadedTime the time stamp
  1322. @throws IOException if we can not read the container logs.]]>
  1323. </doc>
  1324. </method>
  1325. <method name="readAcontainerLogs"
  1326. abstract="false" native="false" synchronized="false"
  1327. static="true" final="false" visibility="public"
  1328. deprecated="not deprecated">
  1329. <param name="valueStream" type="java.io.DataInputStream"/>
  1330. <param name="writer" type="java.io.Writer"/>
  1331. <exception name="IOException" type="java.io.IOException"/>
  1332. <doc>
  1333. <![CDATA[Writes all logs for a single container to the provided writer.
  1334. @param valueStream the value stream
  1335. @param writer the log writer
  1336. @throws IOException if we can not read the container logs.]]>
  1337. </doc>
  1338. </method>
  1339. <method name="readAContainerLogsForALogType"
  1340. abstract="false" native="false" synchronized="false"
  1341. static="true" final="false" visibility="public"
  1342. deprecated="not deprecated">
  1343. <param name="valueStream" type="java.io.DataInputStream"/>
  1344. <param name="out" type="java.io.PrintStream"/>
  1345. <param name="logUploadedTime" type="long"/>
  1346. <exception name="IOException" type="java.io.IOException"/>
  1347. <doc>
  1348. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1349. all types for a single container.
  1350. @param valueStream the value stream
  1351. @param out the print stream
  1352. @param logUploadedTime the time stamp
  1353. @throws IOException if we can not read the container log by specifying
  1354. the container log type.]]>
  1355. </doc>
  1356. </method>
  1357. <method name="readAContainerLogsForALogType"
  1358. abstract="false" native="false" synchronized="false"
  1359. static="true" final="false" visibility="public"
  1360. deprecated="not deprecated">
  1361. <param name="valueStream" type="java.io.DataInputStream"/>
  1362. <param name="out" type="java.io.PrintStream"/>
  1363. <param name="logUploadedTime" type="long"/>
  1364. <param name="bytes" type="long"/>
  1365. <exception name="IOException" type="java.io.IOException"/>
  1366. <doc>
  1367. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1368. all types for a single container for the specific bytes.
  1369. @param valueStream the value stream
  1370. @param out the output print stream
  1371. @param logUploadedTime the log upload time stamp
  1372. @param bytes the output size of the log
  1373. @throws IOException if we can not read the container log]]>
  1374. </doc>
  1375. </method>
  1376. <method name="readAContainerLogsForALogType"
  1377. abstract="false" native="false" synchronized="false"
  1378. static="true" final="false" visibility="public"
  1379. deprecated="not deprecated">
  1380. <param name="valueStream" type="java.io.DataInputStream"/>
  1381. <param name="out" type="java.io.PrintStream"/>
  1382. <exception name="IOException" type="java.io.IOException"/>
  1383. <doc>
  1384. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1385. all types for a single container.
  1386. @param valueStream the value stream
  1387. @param out the output print stream
  1388. @throws IOException if we can not read the container log]]>
  1389. </doc>
  1390. </method>
  1391. <method name="readContainerLogsForALogType" return="int"
  1392. abstract="false" native="false" synchronized="false"
  1393. static="true" final="false" visibility="public"
  1394. deprecated="not deprecated">
  1395. <param name="valueStream" type="java.io.DataInputStream"/>
  1396. <param name="out" type="java.io.PrintStream"/>
  1397. <param name="logUploadedTime" type="long"/>
  1398. <param name="logType" type="java.util.List"/>
  1399. <exception name="IOException" type="java.io.IOException"/>
  1400. <doc>
  1401. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1402. the specific types for a single container.
  1403. @param valueStream the value stream
  1404. @param out the output print stream
  1405. @param logUploadedTime the log uploaded time stamp
  1406. @param logType the given log type
  1407. @throws IOException if we can not read the container logs]]>
  1408. </doc>
  1409. </method>
  1410. <method name="readContainerLogsForALogType" return="int"
  1411. abstract="false" native="false" synchronized="false"
  1412. static="true" final="false" visibility="public"
  1413. deprecated="not deprecated">
  1414. <param name="valueStream" type="java.io.DataInputStream"/>
  1415. <param name="out" type="java.io.PrintStream"/>
  1416. <param name="logUploadedTime" type="long"/>
  1417. <param name="logType" type="java.util.List"/>
  1418. <param name="bytes" type="long"/>
  1419. <exception name="IOException" type="java.io.IOException"/>
  1420. <doc>
  1421. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1422. the specific types for a single container.
  1423. @param valueStream the value stream
  1424. @param out the output print stream
  1425. @param logUploadedTime the log uploaded time stamp
  1426. @param logType the given log type
  1427. @throws IOException if we can not read the container logs]]>
  1428. </doc>
  1429. </method>
  1430. <method name="close"
  1431. abstract="false" native="false" synchronized="false"
  1432. static="false" final="false" visibility="public"
  1433. deprecated="not deprecated">
  1434. </method>
  1435. </class>
  1436. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1437. </package>
  1438. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller">
  1439. </package>
  1440. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.ifile">
  1441. </package>
  1442. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.tfile">
  1443. </package>
  1444. <package name="org.apache.hadoop.yarn.nodelabels">
  1445. </package>
  1446. <package name="org.apache.hadoop.yarn.nodelabels.event">
  1447. </package>
  1448. <package name="org.apache.hadoop.yarn.security">
  1449. <!-- start class org.apache.hadoop.yarn.security.AccessRequest -->
  1450. <class name="AccessRequest" extends="java.lang.Object"
  1451. abstract="false"
  1452. static="false" final="false" visibility="public"
  1453. deprecated="not deprecated">
  1454. <constructor name="AccessRequest" type="org.apache.hadoop.yarn.security.PrivilegedEntity, org.apache.hadoop.security.UserGroupInformation, org.apache.hadoop.yarn.security.AccessType, java.lang.String, java.lang.String, java.lang.String, java.util.List"
  1455. static="false" final="false" visibility="public"
  1456. deprecated="not deprecated">
  1457. </constructor>
  1458. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1459. abstract="false" native="false" synchronized="false"
  1460. static="false" final="false" visibility="public"
  1461. deprecated="not deprecated">
  1462. </method>
  1463. <method name="getAccessType" return="org.apache.hadoop.yarn.security.AccessType"
  1464. abstract="false" native="false" synchronized="false"
  1465. static="false" final="false" visibility="public"
  1466. deprecated="not deprecated">
  1467. </method>
  1468. <method name="getAppId" return="java.lang.String"
  1469. abstract="false" native="false" synchronized="false"
  1470. static="false" final="false" visibility="public"
  1471. deprecated="not deprecated">
  1472. </method>
  1473. <method name="getAppName" return="java.lang.String"
  1474. abstract="false" native="false" synchronized="false"
  1475. static="false" final="false" visibility="public"
  1476. deprecated="not deprecated">
  1477. </method>
  1478. <method name="getEntity" return="org.apache.hadoop.yarn.security.PrivilegedEntity"
  1479. abstract="false" native="false" synchronized="false"
  1480. static="false" final="false" visibility="public"
  1481. deprecated="not deprecated">
  1482. </method>
  1483. <method name="getForwardedAddresses" return="java.util.List"
  1484. abstract="false" native="false" synchronized="false"
  1485. static="false" final="false" visibility="public"
  1486. deprecated="not deprecated">
  1487. </method>
  1488. <method name="getRemoteAddress" return="java.lang.String"
  1489. abstract="false" native="false" synchronized="false"
  1490. static="false" final="false" visibility="public"
  1491. deprecated="not deprecated">
  1492. </method>
  1493. <doc>
  1494. <![CDATA[This request object contains all the context information to determine whether
  1495. a user has permission to access the target entity.
  1496. user : the user who's currently accessing
  1497. accessType : the access type against the entity.
  1498. entity : the target object user is accessing.
  1499. appId : the associated app Id for current access. This could be null
  1500. if no app is associated.
  1501. appName : the associated app name for current access. This could be null if
  1502. no app is associated.
  1503. remoteAddress : The caller's remote ip address.
  1504. forwardedAddresses : In case this is an http request, this contains the
  1505. originating IP address of a client connecting to a web
  1506. server through an HTTP proxy or load balancer. This
  1507. parameter is null, if it's a RPC request.]]>
  1508. </doc>
  1509. </class>
  1510. <!-- end class org.apache.hadoop.yarn.security.AccessRequest -->
  1511. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1512. <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1513. abstract="false"
  1514. static="false" final="false" visibility="public"
  1515. deprecated="not deprecated">
  1516. <constructor name="AMRMTokenIdentifier"
  1517. static="false" final="false" visibility="public"
  1518. deprecated="not deprecated">
  1519. </constructor>
  1520. <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
  1521. static="false" final="false" visibility="public"
  1522. deprecated="not deprecated">
  1523. </constructor>
  1524. <method name="write"
  1525. abstract="false" native="false" synchronized="false"
  1526. static="false" final="false" visibility="public"
  1527. deprecated="not deprecated">
  1528. <param name="out" type="java.io.DataOutput"/>
  1529. <exception name="IOException" type="java.io.IOException"/>
  1530. </method>
  1531. <method name="readFields"
  1532. abstract="false" native="false" synchronized="false"
  1533. static="false" final="false" visibility="public"
  1534. deprecated="not deprecated">
  1535. <param name="in" type="java.io.DataInput"/>
  1536. <exception name="IOException" type="java.io.IOException"/>
  1537. </method>
  1538. <method name="getKind" return="org.apache.hadoop.io.Text"
  1539. abstract="false" native="false" synchronized="false"
  1540. static="false" final="false" visibility="public"
  1541. deprecated="not deprecated">
  1542. </method>
  1543. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1544. abstract="false" native="false" synchronized="false"
  1545. static="false" final="false" visibility="public"
  1546. deprecated="not deprecated">
  1547. </method>
  1548. <method name="getKeyId" return="int"
  1549. abstract="false" native="false" synchronized="false"
  1550. static="false" final="false" visibility="public"
  1551. deprecated="not deprecated">
  1552. </method>
  1553. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
  1554. abstract="false" native="false" synchronized="false"
  1555. static="false" final="false" visibility="public"
  1556. deprecated="not deprecated">
  1557. </method>
  1558. <method name="hashCode" return="int"
  1559. abstract="false" native="false" synchronized="false"
  1560. static="false" final="false" visibility="public"
  1561. deprecated="not deprecated">
  1562. </method>
  1563. <method name="equals" return="boolean"
  1564. abstract="false" native="false" synchronized="false"
  1565. static="false" final="false" visibility="public"
  1566. deprecated="not deprecated">
  1567. <param name="other" type="java.lang.Object"/>
  1568. </method>
  1569. <method name="toString" return="java.lang.String"
  1570. abstract="false" native="false" synchronized="false"
  1571. static="false" final="false" visibility="public"
  1572. deprecated="not deprecated">
  1573. </method>
  1574. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1575. transient="false" volatile="false"
  1576. static="true" final="true" visibility="public"
  1577. deprecated="not deprecated">
  1578. </field>
  1579. <doc>
  1580. <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
  1581. ApplicationMasters to authenticate to the ResourceManager.]]>
  1582. </doc>
  1583. </class>
  1584. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1585. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1586. <class name="AMRMTokenSelector" extends="java.lang.Object"
  1587. abstract="false"
  1588. static="false" final="false" visibility="public"
  1589. deprecated="not deprecated">
  1590. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1591. <constructor name="AMRMTokenSelector"
  1592. static="false" final="false" visibility="public"
  1593. deprecated="not deprecated">
  1594. </constructor>
  1595. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1596. abstract="false" native="false" synchronized="false"
  1597. static="false" final="false" visibility="public"
  1598. deprecated="not deprecated">
  1599. <param name="service" type="org.apache.hadoop.io.Text"/>
  1600. <param name="tokens" type="java.util.Collection"/>
  1601. </method>
  1602. </class>
  1603. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1604. <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1605. <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1606. abstract="false"
  1607. static="false" final="false" visibility="public"
  1608. deprecated="not deprecated">
  1609. <constructor name="ContainerManagerSecurityInfo"
  1610. static="false" final="false" visibility="public"
  1611. deprecated="not deprecated">
  1612. </constructor>
  1613. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1614. abstract="false" native="false" synchronized="false"
  1615. static="false" final="false" visibility="public"
  1616. deprecated="not deprecated">
  1617. <param name="protocol" type="java.lang.Class"/>
  1618. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1619. </method>
  1620. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1621. abstract="false" native="false" synchronized="false"
  1622. static="false" final="false" visibility="public"
  1623. deprecated="not deprecated">
  1624. <param name="protocol" type="java.lang.Class"/>
  1625. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1626. </method>
  1627. </class>
  1628. <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1629. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1630. <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1631. abstract="false"
  1632. static="false" final="false" visibility="public"
  1633. deprecated="not deprecated">
  1634. <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"
  1635. static="false" final="false" visibility="public"
  1636. deprecated="not deprecated">
  1637. </constructor>
  1638. <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"
  1639. static="false" final="false" visibility="public"
  1640. deprecated="Use one of the other constructors instead.">
  1641. <doc>
  1642. <![CDATA[Creates a instance.
  1643. @param appSubmitter appSubmitter
  1644. @param containerID container ID
  1645. @param creationTime creation time
  1646. @param expiryTimeStamp expiry timestamp
  1647. @param hostName hostname
  1648. @param logAggregationContext log aggregation context
  1649. @param masterKeyId master key ID
  1650. @param priority priority
  1651. @param r resource needed by the container
  1652. @param rmIdentifier ResourceManager identifier
  1653. @deprecated Use one of the other constructors instead.]]>
  1654. </doc>
  1655. </constructor>
  1656. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String"
  1657. static="false" final="false" visibility="public"
  1658. deprecated="not deprecated">
  1659. </constructor>
  1660. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType"
  1661. static="false" final="false" visibility="public"
  1662. deprecated="not deprecated">
  1663. </constructor>
  1664. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType"
  1665. static="false" final="false" visibility="public"
  1666. deprecated="not deprecated">
  1667. </constructor>
  1668. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType, long"
  1669. static="false" final="false" visibility="public"
  1670. deprecated="not deprecated">
  1671. <doc>
  1672. <![CDATA[Convenience Constructor for existing clients.
  1673. @param containerID containerID
  1674. @param containerVersion containerVersion
  1675. @param hostName hostName
  1676. @param appSubmitter appSubmitter
  1677. @param r resource
  1678. @param expiryTimeStamp expiryTimeStamp
  1679. @param masterKeyId masterKeyId
  1680. @param rmIdentifier rmIdentifier
  1681. @param priority priority
  1682. @param creationTime creationTime
  1683. @param logAggregationContext logAggregationContext
  1684. @param nodeLabelExpression nodeLabelExpression
  1685. @param containerType containerType
  1686. @param executionType executionType
  1687. @param allocationRequestId allocationRequestId]]>
  1688. </doc>
  1689. </constructor>
  1690. <constructor name="ContainerTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ContainerId, int, java.lang.String, java.lang.String, org.apache.hadoop.yarn.api.records.Resource, long, int, long, org.apache.hadoop.yarn.api.records.Priority, long, org.apache.hadoop.yarn.api.records.LogAggregationContext, java.lang.String, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType, long, java.util.Set"
  1691. static="false" final="false" visibility="public"
  1692. deprecated="not deprecated">
  1693. <doc>
  1694. <![CDATA[Create a Container Token Identifier.
  1695. @param containerID containerID
  1696. @param containerVersion containerVersion
  1697. @param hostName hostName
  1698. @param appSubmitter appSubmitter
  1699. @param r resource
  1700. @param expiryTimeStamp expiryTimeStamp
  1701. @param masterKeyId masterKeyId
  1702. @param rmIdentifier rmIdentifier
  1703. @param priority priority
  1704. @param creationTime creationTime
  1705. @param logAggregationContext logAggregationContext
  1706. @param nodeLabelExpression nodeLabelExpression
  1707. @param containerType containerType
  1708. @param executionType executionType
  1709. @param allocationRequestId allocationRequestId
  1710. @param allocationTags Set of allocation Tags.]]>
  1711. </doc>
  1712. </constructor>
  1713. <constructor name="ContainerTokenIdentifier"
  1714. static="false" final="false" visibility="public"
  1715. deprecated="not deprecated">
  1716. <doc>
  1717. <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
  1718. </doc>
  1719. </constructor>
  1720. <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
  1721. abstract="false" native="false" synchronized="false"
  1722. static="false" final="false" visibility="public"
  1723. deprecated="not deprecated">
  1724. </method>
  1725. <method name="getApplicationSubmitter" return="java.lang.String"
  1726. abstract="false" native="false" synchronized="false"
  1727. static="false" final="false" visibility="public"
  1728. deprecated="not deprecated">
  1729. </method>
  1730. <method name="getNmHostAddress" return="java.lang.String"
  1731. abstract="false" native="false" synchronized="false"
  1732. static="false" final="false" visibility="public"
  1733. deprecated="not deprecated">
  1734. </method>
  1735. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  1736. abstract="false" native="false" synchronized="false"
  1737. static="false" final="false" visibility="public"
  1738. deprecated="not deprecated">
  1739. </method>
  1740. <method name="getExpiryTimeStamp" return="long"
  1741. abstract="false" native="false" synchronized="false"
  1742. static="false" final="false" visibility="public"
  1743. deprecated="not deprecated">
  1744. </method>
  1745. <method name="getMasterKeyId" return="int"
  1746. abstract="false" native="false" synchronized="false"
  1747. static="false" final="false" visibility="public"
  1748. deprecated="not deprecated">
  1749. </method>
  1750. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  1751. abstract="false" native="false" synchronized="false"
  1752. static="false" final="false" visibility="public"
  1753. deprecated="not deprecated">
  1754. </method>
  1755. <method name="getCreationTime" return="long"
  1756. abstract="false" native="false" synchronized="false"
  1757. static="false" final="false" visibility="public"
  1758. deprecated="not deprecated">
  1759. </method>
  1760. <method name="getRMIdentifier" return="long"
  1761. abstract="false" native="false" synchronized="false"
  1762. static="false" final="false" visibility="public"
  1763. deprecated="not deprecated">
  1764. <doc>
  1765. <![CDATA[Get the RMIdentifier of RM in which containers are allocated.
  1766. @return RMIdentifier]]>
  1767. </doc>
  1768. </method>
  1769. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  1770. abstract="false" native="false" synchronized="false"
  1771. static="false" final="false" visibility="public"
  1772. deprecated="not deprecated">
  1773. <doc>
  1774. <![CDATA[Get the ContainerType of container to allocate.
  1775. @return ContainerType]]>
  1776. </doc>
  1777. </method>
  1778. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  1779. abstract="false" native="false" synchronized="false"
  1780. static="false" final="false" visibility="public"
  1781. deprecated="not deprecated">
  1782. <doc>
  1783. <![CDATA[Get the ExecutionType of container to allocate
  1784. @return ExecutionType]]>
  1785. </doc>
  1786. </method>
  1787. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
  1788. abstract="false" native="false" synchronized="false"
  1789. static="false" final="false" visibility="public"
  1790. deprecated="not deprecated">
  1791. </method>
  1792. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  1793. abstract="false" native="false" synchronized="false"
  1794. static="false" final="false" visibility="public"
  1795. deprecated="not deprecated">
  1796. </method>
  1797. <method name="getAllocationRequestId" return="long"
  1798. abstract="false" native="false" synchronized="false"
  1799. static="false" final="false" visibility="public"
  1800. deprecated="not deprecated">
  1801. </method>
  1802. <method name="write"
  1803. abstract="false" native="false" synchronized="false"
  1804. static="false" final="false" visibility="public"
  1805. deprecated="not deprecated">
  1806. <param name="out" type="java.io.DataOutput"/>
  1807. <exception name="IOException" type="java.io.IOException"/>
  1808. </method>
  1809. <method name="readFields"
  1810. abstract="false" native="false" synchronized="false"
  1811. static="false" final="false" visibility="public"
  1812. deprecated="not deprecated">
  1813. <param name="in" type="java.io.DataInput"/>
  1814. <exception name="IOException" type="java.io.IOException"/>
  1815. </method>
  1816. <method name="getKind" return="org.apache.hadoop.io.Text"
  1817. abstract="false" native="false" synchronized="false"
  1818. static="false" final="false" visibility="public"
  1819. deprecated="not deprecated">
  1820. </method>
  1821. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1822. abstract="false" native="false" synchronized="false"
  1823. static="false" final="false" visibility="public"
  1824. deprecated="not deprecated">
  1825. </method>
  1826. <method name="getVersion" return="int"
  1827. abstract="false" native="false" synchronized="false"
  1828. static="false" final="false" visibility="public"
  1829. deprecated="not deprecated">
  1830. <doc>
  1831. <![CDATA[Get the Container version
  1832. @return container version]]>
  1833. </doc>
  1834. </method>
  1835. <method name="getNodeLabelExpression" return="java.lang.String"
  1836. abstract="false" native="false" synchronized="false"
  1837. static="false" final="false" visibility="public"
  1838. deprecated="not deprecated">
  1839. <doc>
  1840. <![CDATA[Get the node-label-expression in the original ResourceRequest]]>
  1841. </doc>
  1842. </method>
  1843. <method name="getAllcationTags" return="java.util.Set"
  1844. abstract="false" native="false" synchronized="false"
  1845. static="false" final="false" visibility="public"
  1846. deprecated="not deprecated">
  1847. </method>
  1848. <method name="hashCode" return="int"
  1849. abstract="false" native="false" synchronized="false"
  1850. static="false" final="false" visibility="public"
  1851. deprecated="not deprecated">
  1852. </method>
  1853. <method name="equals" return="boolean"
  1854. abstract="false" native="false" synchronized="false"
  1855. static="false" final="false" visibility="public"
  1856. deprecated="not deprecated">
  1857. <param name="other" type="java.lang.Object"/>
  1858. </method>
  1859. <method name="toString" return="java.lang.String"
  1860. abstract="false" native="false" synchronized="false"
  1861. static="false" final="false" visibility="public"
  1862. deprecated="not deprecated">
  1863. </method>
  1864. <field name="KIND" type="org.apache.hadoop.io.Text"
  1865. transient="false" volatile="false"
  1866. static="true" final="true" visibility="public"
  1867. deprecated="not deprecated">
  1868. </field>
  1869. <doc>
  1870. <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
  1871. {@link Resource} needed by the container and the target NMs host-address.]]>
  1872. </doc>
  1873. </class>
  1874. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  1875. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1876. <class name="ContainerTokenSelector" extends="java.lang.Object"
  1877. abstract="false"
  1878. static="false" final="false" visibility="public"
  1879. deprecated="not deprecated">
  1880. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1881. <constructor name="ContainerTokenSelector"
  1882. static="false" final="false" visibility="public"
  1883. deprecated="not deprecated">
  1884. </constructor>
  1885. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1886. abstract="false" native="false" synchronized="false"
  1887. static="false" final="false" visibility="public"
  1888. deprecated="not deprecated">
  1889. <param name="service" type="org.apache.hadoop.io.Text"/>
  1890. <param name="tokens" type="java.util.Collection"/>
  1891. </method>
  1892. </class>
  1893. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  1894. <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1895. <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1896. abstract="false"
  1897. static="false" final="false" visibility="public"
  1898. deprecated="not deprecated">
  1899. <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
  1900. static="false" final="false" visibility="public"
  1901. deprecated="not deprecated">
  1902. </constructor>
  1903. <constructor name="NMTokenIdentifier"
  1904. static="false" final="false" visibility="public"
  1905. deprecated="not deprecated">
  1906. <doc>
  1907. <![CDATA[Default constructor needed by RPC/Secret manager]]>
  1908. </doc>
  1909. </constructor>
  1910. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  1911. abstract="false" native="false" synchronized="false"
  1912. static="false" final="false" visibility="public"
  1913. deprecated="not deprecated">
  1914. </method>
  1915. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  1916. abstract="false" native="false" synchronized="false"
  1917. static="false" final="false" visibility="public"
  1918. deprecated="not deprecated">
  1919. </method>
  1920. <method name="getApplicationSubmitter" return="java.lang.String"
  1921. abstract="false" native="false" synchronized="false"
  1922. static="false" final="false" visibility="public"
  1923. deprecated="not deprecated">
  1924. </method>
  1925. <method name="getKeyId" return="int"
  1926. abstract="false" native="false" synchronized="false"
  1927. static="false" final="false" visibility="public"
  1928. deprecated="not deprecated">
  1929. </method>
  1930. <method name="write"
  1931. abstract="false" native="false" synchronized="false"
  1932. static="false" final="false" visibility="public"
  1933. deprecated="not deprecated">
  1934. <param name="out" type="java.io.DataOutput"/>
  1935. <exception name="IOException" type="java.io.IOException"/>
  1936. </method>
  1937. <method name="readFields"
  1938. abstract="false" native="false" synchronized="false"
  1939. static="false" final="false" visibility="public"
  1940. deprecated="not deprecated">
  1941. <param name="in" type="java.io.DataInput"/>
  1942. <exception name="IOException" type="java.io.IOException"/>
  1943. </method>
  1944. <method name="getKind" return="org.apache.hadoop.io.Text"
  1945. abstract="false" native="false" synchronized="false"
  1946. static="false" final="false" visibility="public"
  1947. deprecated="not deprecated">
  1948. </method>
  1949. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1950. abstract="false" native="false" synchronized="false"
  1951. static="false" final="false" visibility="public"
  1952. deprecated="not deprecated">
  1953. </method>
  1954. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
  1955. abstract="false" native="false" synchronized="false"
  1956. static="false" final="false" visibility="public"
  1957. deprecated="not deprecated">
  1958. </method>
  1959. <method name="hashCode" return="int"
  1960. abstract="false" native="false" synchronized="false"
  1961. static="false" final="false" visibility="public"
  1962. deprecated="not deprecated">
  1963. </method>
  1964. <method name="equals" return="boolean"
  1965. abstract="false" native="false" synchronized="false"
  1966. static="false" final="false" visibility="public"
  1967. deprecated="not deprecated">
  1968. <param name="other" type="java.lang.Object"/>
  1969. </method>
  1970. <method name="toString" return="java.lang.String"
  1971. abstract="false" native="false" synchronized="false"
  1972. static="false" final="false" visibility="public"
  1973. deprecated="not deprecated">
  1974. </method>
  1975. <field name="KIND" type="org.apache.hadoop.io.Text"
  1976. transient="false" volatile="false"
  1977. static="true" final="true" visibility="public"
  1978. deprecated="not deprecated">
  1979. </field>
  1980. </class>
  1981. <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  1982. <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  1983. <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1984. abstract="false"
  1985. static="false" final="false" visibility="public"
  1986. deprecated="not deprecated">
  1987. <constructor name="SchedulerSecurityInfo"
  1988. static="false" final="false" visibility="public"
  1989. deprecated="not deprecated">
  1990. </constructor>
  1991. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1992. abstract="false" native="false" synchronized="false"
  1993. static="false" final="false" visibility="public"
  1994. deprecated="not deprecated">
  1995. <param name="protocol" type="java.lang.Class"/>
  1996. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1997. </method>
  1998. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1999. abstract="false" native="false" synchronized="false"
  2000. static="false" final="false" visibility="public"
  2001. deprecated="not deprecated">
  2002. <param name="protocol" type="java.lang.Class"/>
  2003. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2004. </method>
  2005. </class>
  2006. <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  2007. </package>
  2008. <package name="org.apache.hadoop.yarn.security.admin">
  2009. <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2010. <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2011. abstract="false"
  2012. static="false" final="false" visibility="public"
  2013. deprecated="not deprecated">
  2014. <constructor name="AdminSecurityInfo"
  2015. static="false" final="false" visibility="public"
  2016. deprecated="not deprecated">
  2017. </constructor>
  2018. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2019. abstract="false" native="false" synchronized="false"
  2020. static="false" final="false" visibility="public"
  2021. deprecated="not deprecated">
  2022. <param name="protocol" type="java.lang.Class"/>
  2023. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2024. </method>
  2025. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2026. abstract="false" native="false" synchronized="false"
  2027. static="false" final="false" visibility="public"
  2028. deprecated="not deprecated">
  2029. <param name="protocol" type="java.lang.Class"/>
  2030. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2031. </method>
  2032. </class>
  2033. <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2034. </package>
  2035. <package name="org.apache.hadoop.yarn.security.client">
  2036. <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2037. <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
  2038. abstract="true"
  2039. static="false" final="false" visibility="public"
  2040. deprecated="not deprecated">
  2041. <constructor name="BaseClientToAMTokenSecretManager"
  2042. static="false" final="false" visibility="public"
  2043. deprecated="not deprecated">
  2044. </constructor>
  2045. <doc>
  2046. <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
  2047. issued to clients by the RM using the underlying master-key shared by RM to
  2048. the AMs on their launch. All the methods are called by either Hadoop RPC or
  2049. YARN, so this class is strictly for the purpose of inherit/extend and
  2050. register with Hadoop RPC.]]>
  2051. </doc>
  2052. </class>
  2053. <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2054. <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2055. <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2056. abstract="false"
  2057. static="false" final="false" visibility="public"
  2058. deprecated="not deprecated">
  2059. <constructor name="ClientRMSecurityInfo"
  2060. static="false" final="false" visibility="public"
  2061. deprecated="not deprecated">
  2062. </constructor>
  2063. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2064. abstract="false" native="false" synchronized="false"
  2065. static="false" final="false" visibility="public"
  2066. deprecated="not deprecated">
  2067. <param name="protocol" type="java.lang.Class"/>
  2068. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2069. </method>
  2070. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2071. abstract="false" native="false" synchronized="false"
  2072. static="false" final="false" visibility="public"
  2073. deprecated="not deprecated">
  2074. <param name="protocol" type="java.lang.Class"/>
  2075. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2076. </method>
  2077. </class>
  2078. <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2079. <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2080. <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2081. abstract="false"
  2082. static="false" final="false" visibility="public"
  2083. deprecated="not deprecated">
  2084. <constructor name="ClientTimelineSecurityInfo"
  2085. static="false" final="false" visibility="public"
  2086. deprecated="not deprecated">
  2087. </constructor>
  2088. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2089. abstract="false" native="false" synchronized="false"
  2090. static="false" final="false" visibility="public"
  2091. deprecated="not deprecated">
  2092. <param name="protocol" type="java.lang.Class"/>
  2093. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2094. </method>
  2095. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2096. abstract="false" native="false" synchronized="false"
  2097. static="false" final="false" visibility="public"
  2098. deprecated="not deprecated">
  2099. <param name="protocol" type="java.lang.Class"/>
  2100. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2101. </method>
  2102. </class>
  2103. <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2104. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2105. <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  2106. abstract="false"
  2107. static="false" final="false" visibility="public"
  2108. deprecated="not deprecated">
  2109. <constructor name="ClientToAMTokenIdentifier"
  2110. static="false" final="false" visibility="public"
  2111. deprecated="not deprecated">
  2112. </constructor>
  2113. <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
  2114. static="false" final="false" visibility="public"
  2115. deprecated="not deprecated">
  2116. </constructor>
  2117. <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2118. abstract="false" native="false" synchronized="false"
  2119. static="false" final="false" visibility="public"
  2120. deprecated="not deprecated">
  2121. </method>
  2122. <method name="getClientName" return="java.lang.String"
  2123. abstract="false" native="false" synchronized="false"
  2124. static="false" final="false" visibility="public"
  2125. deprecated="not deprecated">
  2126. </method>
  2127. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
  2128. abstract="false" native="false" synchronized="false"
  2129. static="false" final="false" visibility="public"
  2130. deprecated="not deprecated">
  2131. </method>
  2132. <method name="write"
  2133. abstract="false" native="false" synchronized="false"
  2134. static="false" final="false" visibility="public"
  2135. deprecated="not deprecated">
  2136. <param name="out" type="java.io.DataOutput"/>
  2137. <exception name="IOException" type="java.io.IOException"/>
  2138. </method>
  2139. <method name="readFields"
  2140. abstract="false" native="false" synchronized="false"
  2141. static="false" final="false" visibility="public"
  2142. deprecated="not deprecated">
  2143. <param name="in" type="java.io.DataInput"/>
  2144. <exception name="IOException" type="java.io.IOException"/>
  2145. </method>
  2146. <method name="getKind" return="org.apache.hadoop.io.Text"
  2147. abstract="false" native="false" synchronized="false"
  2148. static="false" final="false" visibility="public"
  2149. deprecated="not deprecated">
  2150. </method>
  2151. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  2152. abstract="false" native="false" synchronized="false"
  2153. static="false" final="false" visibility="public"
  2154. deprecated="not deprecated">
  2155. </method>
  2156. <method name="hashCode" return="int"
  2157. abstract="false" native="false" synchronized="false"
  2158. static="false" final="false" visibility="public"
  2159. deprecated="not deprecated">
  2160. </method>
  2161. <method name="equals" return="boolean"
  2162. abstract="false" native="false" synchronized="false"
  2163. static="false" final="false" visibility="public"
  2164. deprecated="not deprecated">
  2165. <param name="other" type="java.lang.Object"/>
  2166. </method>
  2167. <method name="toString" return="java.lang.String"
  2168. abstract="false" native="false" synchronized="false"
  2169. static="false" final="false" visibility="public"
  2170. deprecated="not deprecated">
  2171. </method>
  2172. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2173. transient="false" volatile="false"
  2174. static="true" final="true" visibility="public"
  2175. deprecated="not deprecated">
  2176. </field>
  2177. </class>
  2178. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2179. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2180. <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
  2181. abstract="false"
  2182. static="false" final="false" visibility="public"
  2183. deprecated="not deprecated">
  2184. <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
  2185. static="false" final="false" visibility="public"
  2186. deprecated="not deprecated">
  2187. </constructor>
  2188. <method name="retrievePassword" return="byte[]"
  2189. abstract="false" native="false" synchronized="false"
  2190. static="false" final="false" visibility="public"
  2191. deprecated="not deprecated">
  2192. <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
  2193. <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
  2194. </method>
  2195. <method name="getMasterKey" return="javax.crypto.SecretKey"
  2196. abstract="false" native="false" synchronized="false"
  2197. static="false" final="false" visibility="public"
  2198. deprecated="not deprecated">
  2199. <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2200. </method>
  2201. <method name="setMasterKey"
  2202. abstract="false" native="false" synchronized="false"
  2203. static="false" final="false" visibility="public"
  2204. deprecated="not deprecated">
  2205. <param name="key" type="byte[]"/>
  2206. </method>
  2207. <doc>
  2208. <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
  2209. clients by the RM using the underlying master-key shared by RM to the AMs on
  2210. their launch. All the methods are called by either Hadoop RPC or YARN, so
  2211. this class is strictly for the purpose of inherit/extend and register with
  2212. Hadoop RPC.]]>
  2213. </doc>
  2214. </class>
  2215. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2216. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2217. <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2218. abstract="false"
  2219. static="false" final="false" visibility="public"
  2220. deprecated="not deprecated">
  2221. <constructor name="RMDelegationTokenIdentifier"
  2222. static="false" final="false" visibility="public"
  2223. deprecated="not deprecated">
  2224. </constructor>
  2225. <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2226. static="false" final="false" visibility="public"
  2227. deprecated="not deprecated">
  2228. <doc>
  2229. <![CDATA[Create a new delegation token identifier
  2230. @param owner the effective username of the token owner
  2231. @param renewer the username of the renewer
  2232. @param realUser the real username of the token owner]]>
  2233. </doc>
  2234. </constructor>
  2235. <method name="getKind" return="org.apache.hadoop.io.Text"
  2236. abstract="false" native="false" synchronized="false"
  2237. static="false" final="false" visibility="public"
  2238. deprecated="not deprecated">
  2239. </method>
  2240. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2241. transient="false" volatile="false"
  2242. static="true" final="true" visibility="public"
  2243. deprecated="not deprecated">
  2244. </field>
  2245. <doc>
  2246. <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
  2247. Resource Manager.]]>
  2248. </doc>
  2249. </class>
  2250. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2251. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2252. <class name="RMDelegationTokenSelector" extends="java.lang.Object"
  2253. abstract="false"
  2254. static="false" final="false" visibility="public"
  2255. deprecated="not deprecated">
  2256. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2257. <constructor name="RMDelegationTokenSelector"
  2258. static="false" final="false" visibility="public"
  2259. deprecated="not deprecated">
  2260. </constructor>
  2261. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2262. abstract="false" native="false" synchronized="false"
  2263. static="false" final="false" visibility="public"
  2264. deprecated="not deprecated">
  2265. <param name="service" type="org.apache.hadoop.io.Text"/>
  2266. <param name="tokens" type="java.util.Collection"/>
  2267. </method>
  2268. </class>
  2269. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2270. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2271. <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2272. abstract="false"
  2273. static="false" final="false" visibility="public"
  2274. deprecated="not deprecated">
  2275. <constructor name="TimelineDelegationTokenIdentifier"
  2276. static="false" final="false" visibility="public"
  2277. deprecated="not deprecated">
  2278. </constructor>
  2279. <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2280. static="false" final="false" visibility="public"
  2281. deprecated="not deprecated">
  2282. <doc>
  2283. <![CDATA[Create a new timeline delegation token identifier
  2284. @param owner the effective username of the token owner
  2285. @param renewer the username of the renewer
  2286. @param realUser the real username of the token owner]]>
  2287. </doc>
  2288. </constructor>
  2289. <method name="getKind" return="org.apache.hadoop.io.Text"
  2290. abstract="false" native="false" synchronized="false"
  2291. static="false" final="false" visibility="public"
  2292. deprecated="not deprecated">
  2293. </method>
  2294. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2295. transient="false" volatile="false"
  2296. static="true" final="true" visibility="public"
  2297. deprecated="not deprecated">
  2298. </field>
  2299. </class>
  2300. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2301. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2302. <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
  2303. abstract="false"
  2304. static="false" final="false" visibility="public"
  2305. deprecated="not deprecated">
  2306. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2307. <constructor name="TimelineDelegationTokenSelector"
  2308. static="false" final="false" visibility="public"
  2309. deprecated="not deprecated">
  2310. </constructor>
  2311. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2312. abstract="false" native="false" synchronized="false"
  2313. static="false" final="false" visibility="public"
  2314. deprecated="not deprecated">
  2315. <param name="service" type="org.apache.hadoop.io.Text"/>
  2316. <param name="tokens" type="java.util.Collection"/>
  2317. </method>
  2318. </class>
  2319. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2320. </package>
  2321. <package name="org.apache.hadoop.yarn.server.api">
  2322. </package>
  2323. <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
  2324. </package>
  2325. <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
  2326. </package>
  2327. <package name="org.apache.hadoop.yarn.sharedcache">
  2328. <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2329. <interface name="SharedCacheChecksum" abstract="true"
  2330. static="false" final="false" visibility="public"
  2331. deprecated="not deprecated">
  2332. <method name="computeChecksum" return="java.lang.String"
  2333. abstract="true" native="false" synchronized="false"
  2334. static="false" final="false" visibility="public"
  2335. deprecated="not deprecated">
  2336. <param name="in" type="java.io.InputStream"/>
  2337. <exception name="IOException" type="java.io.IOException"/>
  2338. <doc>
  2339. <![CDATA[Calculate the checksum of the passed input stream.
  2340. @param in <code>InputStream</code> to be checksumed
  2341. @return the message digest of the input stream
  2342. @throws IOException]]>
  2343. </doc>
  2344. </method>
  2345. </interface>
  2346. <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2347. <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2348. <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
  2349. abstract="false"
  2350. static="false" final="false" visibility="public"
  2351. deprecated="not deprecated">
  2352. <constructor name="SharedCacheChecksumFactory"
  2353. static="false" final="false" visibility="public"
  2354. deprecated="not deprecated">
  2355. </constructor>
  2356. <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
  2357. abstract="false" native="false" synchronized="false"
  2358. static="true" final="false" visibility="public"
  2359. deprecated="not deprecated">
  2360. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2361. <doc>
  2362. <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
  2363. algorithm implementation
  2364. (see <code>yarn.sharedcache.checksum.algo.impl</code>)
  2365. @return <code>SharedCacheChecksum</code> object]]>
  2366. </doc>
  2367. </method>
  2368. </class>
  2369. <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2370. </package>
  2371. <package name="org.apache.hadoop.yarn.state">
  2372. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2373. <class name="InvalidStateTransitionException" extends="org.apache.hadoop.yarn.state.InvalidStateTransitonException"
  2374. abstract="false"
  2375. static="false" final="false" visibility="public"
  2376. deprecated="not deprecated">
  2377. <constructor name="InvalidStateTransitionException" type="java.lang.Enum, java.lang.Enum"
  2378. static="false" final="false" visibility="public"
  2379. deprecated="not deprecated">
  2380. </constructor>
  2381. <doc>
  2382. <![CDATA[The exception that happens when you call invalid state transition.]]>
  2383. </doc>
  2384. </class>
  2385. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2386. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2387. <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  2388. abstract="false"
  2389. static="false" final="false" visibility="public"
  2390. deprecated="Use {@link InvalidStateTransitionException} instead.">
  2391. <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
  2392. static="false" final="false" visibility="public"
  2393. deprecated="not deprecated">
  2394. </constructor>
  2395. <method name="getCurrentState" return="java.lang.Enum"
  2396. abstract="false" native="false" synchronized="false"
  2397. static="false" final="false" visibility="public"
  2398. deprecated="not deprecated">
  2399. </method>
  2400. <method name="getEvent" return="java.lang.Enum"
  2401. abstract="false" native="false" synchronized="false"
  2402. static="false" final="false" visibility="public"
  2403. deprecated="not deprecated">
  2404. </method>
  2405. <doc>
  2406. <![CDATA[@deprecated Use {@link InvalidStateTransitionException} instead.]]>
  2407. </doc>
  2408. </class>
  2409. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2410. <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2411. <interface name="MultipleArcTransition" abstract="true"
  2412. static="false" final="false" visibility="public"
  2413. deprecated="not deprecated">
  2414. <method name="transition" return="STATE"
  2415. abstract="true" native="false" synchronized="false"
  2416. static="false" final="false" visibility="public"
  2417. deprecated="not deprecated">
  2418. <param name="operand" type="OPERAND"/>
  2419. <param name="event" type="EVENT"/>
  2420. <doc>
  2421. <![CDATA[Transition hook.
  2422. @return the postState. Post state must be one of the
  2423. valid post states registered in StateMachine.
  2424. @param operand the entity attached to the FSM, whose internal
  2425. state may change.
  2426. @param event causal event]]>
  2427. </doc>
  2428. </method>
  2429. <doc>
  2430. <![CDATA[Hook for Transition.
  2431. Post state is decided by Transition hook. Post state must be one of the
  2432. valid post states registered in StateMachine.]]>
  2433. </doc>
  2434. </interface>
  2435. <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2436. <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2437. <interface name="SingleArcTransition" abstract="true"
  2438. static="false" final="false" visibility="public"
  2439. deprecated="not deprecated">
  2440. <method name="transition"
  2441. abstract="true" native="false" synchronized="false"
  2442. static="false" final="false" visibility="public"
  2443. deprecated="not deprecated">
  2444. <param name="operand" type="OPERAND"/>
  2445. <param name="event" type="EVENT"/>
  2446. <doc>
  2447. <![CDATA[Transition hook.
  2448. @param operand the entity attached to the FSM, whose internal
  2449. state may change.
  2450. @param event causal event]]>
  2451. </doc>
  2452. </method>
  2453. <doc>
  2454. <![CDATA[Hook for Transition. This lead to state machine to move to
  2455. the post state as registered in the state machine.]]>
  2456. </doc>
  2457. </interface>
  2458. <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2459. <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
  2460. <interface name="StateMachine" abstract="true"
  2461. static="false" final="false" visibility="public"
  2462. deprecated="not deprecated">
  2463. <method name="getCurrentState" return="STATE"
  2464. abstract="true" native="false" synchronized="false"
  2465. static="false" final="false" visibility="public"
  2466. deprecated="not deprecated">
  2467. </method>
  2468. <method name="doTransition" return="STATE"
  2469. abstract="true" native="false" synchronized="false"
  2470. static="false" final="false" visibility="public"
  2471. deprecated="not deprecated">
  2472. <param name="eventType" type="EVENTTYPE"/>
  2473. <param name="event" type="EVENT"/>
  2474. <exception name="InvalidStateTransitionException" type="org.apache.hadoop.yarn.state.InvalidStateTransitionException"/>
  2475. </method>
  2476. </interface>
  2477. <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
  2478. <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2479. <class name="StateMachineFactory" extends="java.lang.Object"
  2480. abstract="false"
  2481. static="false" final="true" visibility="public"
  2482. deprecated="not deprecated">
  2483. <constructor name="StateMachineFactory" type="STATE"
  2484. static="false" final="false" visibility="public"
  2485. deprecated="not deprecated">
  2486. <doc>
  2487. <![CDATA[Constructor
  2488. This is the only constructor in the API.]]>
  2489. </doc>
  2490. </constructor>
  2491. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2492. abstract="false" native="false" synchronized="false"
  2493. static="false" final="false" visibility="public"
  2494. deprecated="not deprecated">
  2495. <param name="preState" type="STATE"/>
  2496. <param name="postState" type="STATE"/>
  2497. <param name="eventType" type="EVENTTYPE"/>
  2498. <doc>
  2499. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2500. transition added as a new legal transition. This overload
  2501. has no hook object.
  2502. Note that the returned StateMachineFactory is a distinct
  2503. object.
  2504. This method is part of the API.
  2505. @param preState pre-transition state
  2506. @param postState post-transition state
  2507. @param eventType stimulus for the transition]]>
  2508. </doc>
  2509. </method>
  2510. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2511. abstract="false" native="false" synchronized="false"
  2512. static="false" final="false" visibility="public"
  2513. deprecated="not deprecated">
  2514. <param name="preState" type="STATE"/>
  2515. <param name="postState" type="STATE"/>
  2516. <param name="eventTypes" type="java.util.Set"/>
  2517. <doc>
  2518. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2519. transition added as a new legal transition. This overload
  2520. has no hook object.
  2521. Note that the returned StateMachineFactory is a distinct
  2522. object.
  2523. This method is part of the API.
  2524. @param preState pre-transition state
  2525. @param postState post-transition state
  2526. @param eventTypes List of stimuli for the transitions]]>
  2527. </doc>
  2528. </method>
  2529. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2530. abstract="false" native="false" synchronized="false"
  2531. static="false" final="false" visibility="public"
  2532. deprecated="not deprecated">
  2533. <param name="preState" type="STATE"/>
  2534. <param name="postState" type="STATE"/>
  2535. <param name="eventTypes" type="java.util.Set"/>
  2536. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2537. <doc>
  2538. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2539. transition added as a new legal transition
  2540. Note that the returned StateMachineFactory is a distinct
  2541. object.
  2542. This method is part of the API.
  2543. @param preState pre-transition state
  2544. @param postState post-transition state
  2545. @param eventTypes List of stimuli for the transitions
  2546. @param hook transition hook]]>
  2547. </doc>
  2548. </method>
  2549. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2550. abstract="false" native="false" synchronized="false"
  2551. static="false" final="false" visibility="public"
  2552. deprecated="not deprecated">
  2553. <param name="preState" type="STATE"/>
  2554. <param name="postState" type="STATE"/>
  2555. <param name="eventType" type="EVENTTYPE"/>
  2556. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2557. <doc>
  2558. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2559. transition added as a new legal transition
  2560. Note that the returned StateMachineFactory is a distinct object.
  2561. This method is part of the API.
  2562. @param preState pre-transition state
  2563. @param postState post-transition state
  2564. @param eventType stimulus for the transition
  2565. @param hook transition hook]]>
  2566. </doc>
  2567. </method>
  2568. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2569. abstract="false" native="false" synchronized="false"
  2570. static="false" final="false" visibility="public"
  2571. deprecated="not deprecated">
  2572. <param name="preState" type="STATE"/>
  2573. <param name="postStates" type="java.util.Set"/>
  2574. <param name="eventType" type="EVENTTYPE"/>
  2575. <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
  2576. <doc>
  2577. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2578. transition added as a new legal transition
  2579. Note that the returned StateMachineFactory is a distinct object.
  2580. This method is part of the API.
  2581. @param preState pre-transition state
  2582. @param postStates valid post-transition states
  2583. @param eventType stimulus for the transition
  2584. @param hook transition hook]]>
  2585. </doc>
  2586. </method>
  2587. <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2588. abstract="false" native="false" synchronized="false"
  2589. static="false" final="false" visibility="public"
  2590. deprecated="not deprecated">
  2591. <doc>
  2592. <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
  2593. you won't need any synchronization to build a state machine
  2594. Note that the returned StateMachineFactory is a distinct object.
  2595. This method is part of the API.
  2596. The only way you could distinguish the returned
  2597. StateMachineFactory from {@code this} would be by
  2598. measuring the performance of the derived
  2599. {@code StateMachine} you can get from it.
  2600. Calling this is optional. It doesn't change the semantics of the factory,
  2601. if you call it then when you use the factory there is no synchronization.]]>
  2602. </doc>
  2603. </method>
  2604. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2605. abstract="false" native="false" synchronized="false"
  2606. static="false" final="false" visibility="public"
  2607. deprecated="not deprecated">
  2608. <param name="operand" type="OPERAND"/>
  2609. <param name="initialState" type="STATE"/>
  2610. <param name="listener" type="org.apache.hadoop.yarn.state.StateTransitionListener"/>
  2611. <doc>
  2612. <![CDATA[A StateMachine that accepts a transition listener.
  2613. @param operand the object upon which the returned
  2614. {@link StateMachine} will operate.
  2615. @param initialState the state in which the returned
  2616. {@link StateMachine} will start.
  2617. @param listener An implementation of a {@link StateTransitionListener}.
  2618. @return A (@link StateMachine}.]]>
  2619. </doc>
  2620. </method>
  2621. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2622. abstract="false" native="false" synchronized="false"
  2623. static="false" final="false" visibility="public"
  2624. deprecated="not deprecated">
  2625. <param name="operand" type="OPERAND"/>
  2626. <param name="initialState" type="STATE"/>
  2627. </method>
  2628. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2629. abstract="false" native="false" synchronized="false"
  2630. static="false" final="false" visibility="public"
  2631. deprecated="not deprecated">
  2632. <param name="operand" type="OPERAND"/>
  2633. </method>
  2634. <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
  2635. abstract="false" native="false" synchronized="false"
  2636. static="false" final="false" visibility="public"
  2637. deprecated="not deprecated">
  2638. <param name="name" type="java.lang.String"/>
  2639. <doc>
  2640. <![CDATA[Generate a graph represents the state graph of this StateMachine
  2641. @param name graph name
  2642. @return Graph object generated]]>
  2643. </doc>
  2644. </method>
  2645. <doc>
  2646. <![CDATA[State machine topology.
  2647. This object is semantically immutable. If you have a
  2648. StateMachineFactory there's no operation in the API that changes
  2649. its semantic properties.
  2650. @param <OPERAND> The object type on which this state machine operates.
  2651. @param <STATE> The state of the entity.
  2652. @param <EVENTTYPE> The external eventType to be handled.
  2653. @param <EVENT> The event object.]]>
  2654. </doc>
  2655. </class>
  2656. <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2657. <!-- start interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  2658. <interface name="StateTransitionListener" abstract="true"
  2659. static="false" final="false" visibility="public"
  2660. deprecated="not deprecated">
  2661. <method name="preTransition"
  2662. abstract="true" native="false" synchronized="false"
  2663. static="false" final="false" visibility="public"
  2664. deprecated="not deprecated">
  2665. <param name="op" type="OPERAND"/>
  2666. <param name="beforeState" type="STATE"/>
  2667. <param name="eventToBeProcessed" type="EVENT"/>
  2668. <doc>
  2669. <![CDATA[Pre Transition Hook. This will be called before transition.
  2670. @param op Operand.
  2671. @param beforeState State before transition.
  2672. @param eventToBeProcessed Incoming Event.]]>
  2673. </doc>
  2674. </method>
  2675. <method name="postTransition"
  2676. abstract="true" native="false" synchronized="false"
  2677. static="false" final="false" visibility="public"
  2678. deprecated="not deprecated">
  2679. <param name="op" type="OPERAND"/>
  2680. <param name="beforeState" type="STATE"/>
  2681. <param name="afterState" type="STATE"/>
  2682. <param name="processedEvent" type="EVENT"/>
  2683. <doc>
  2684. <![CDATA[Post Transition Hook. This will be called after the transition.
  2685. @param op Operand.
  2686. @param beforeState State before transition.
  2687. @param afterState State after transition.
  2688. @param processedEvent Processed Event.]]>
  2689. </doc>
  2690. </method>
  2691. <doc>
  2692. <![CDATA[A State Transition Listener.
  2693. It exposes a pre and post transition hook called before and
  2694. after the transition.]]>
  2695. </doc>
  2696. </interface>
  2697. <!-- end interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  2698. </package>
  2699. <package name="org.apache.hadoop.yarn.util">
  2700. <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2701. <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
  2702. abstract="true"
  2703. static="false" final="false" visibility="public"
  2704. deprecated="not deprecated">
  2705. <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
  2706. static="false" final="false" visibility="public"
  2707. deprecated="not deprecated">
  2708. </constructor>
  2709. <constructor name="AbstractLivelinessMonitor" type="java.lang.String"
  2710. static="false" final="false" visibility="public"
  2711. deprecated="not deprecated">
  2712. </constructor>
  2713. <method name="serviceStart"
  2714. abstract="false" native="false" synchronized="false"
  2715. static="false" final="false" visibility="protected"
  2716. deprecated="not deprecated">
  2717. <exception name="Exception" type="java.lang.Exception"/>
  2718. </method>
  2719. <method name="serviceStop"
  2720. abstract="false" native="false" synchronized="false"
  2721. static="false" final="false" visibility="protected"
  2722. deprecated="not deprecated">
  2723. <exception name="Exception" type="java.lang.Exception"/>
  2724. </method>
  2725. <method name="expire"
  2726. abstract="true" native="false" synchronized="false"
  2727. static="false" final="false" visibility="protected"
  2728. deprecated="not deprecated">
  2729. <param name="ob" type="O"/>
  2730. </method>
  2731. <method name="setExpireInterval"
  2732. abstract="false" native="false" synchronized="false"
  2733. static="false" final="false" visibility="protected"
  2734. deprecated="not deprecated">
  2735. <param name="expireInterval" type="int"/>
  2736. </method>
  2737. <method name="getExpireInterval" return="long"
  2738. abstract="false" native="false" synchronized="false"
  2739. static="false" final="false" visibility="protected"
  2740. deprecated="not deprecated">
  2741. <param name="o" type="O"/>
  2742. </method>
  2743. <method name="setMonitorInterval"
  2744. abstract="false" native="false" synchronized="false"
  2745. static="false" final="false" visibility="protected"
  2746. deprecated="not deprecated">
  2747. <param name="monitorInterval" type="long"/>
  2748. </method>
  2749. <method name="receivedPing"
  2750. abstract="false" native="false" synchronized="true"
  2751. static="false" final="false" visibility="public"
  2752. deprecated="not deprecated">
  2753. <param name="ob" type="O"/>
  2754. </method>
  2755. <method name="register"
  2756. abstract="false" native="false" synchronized="true"
  2757. static="false" final="false" visibility="public"
  2758. deprecated="not deprecated">
  2759. <param name="ob" type="O"/>
  2760. </method>
  2761. <method name="register"
  2762. abstract="false" native="false" synchronized="true"
  2763. static="false" final="false" visibility="public"
  2764. deprecated="not deprecated">
  2765. <param name="ob" type="O"/>
  2766. <param name="expireTime" type="long"/>
  2767. </method>
  2768. <method name="unregister"
  2769. abstract="false" native="false" synchronized="true"
  2770. static="false" final="false" visibility="public"
  2771. deprecated="not deprecated">
  2772. <param name="ob" type="O"/>
  2773. </method>
  2774. <method name="resetTimer"
  2775. abstract="false" native="false" synchronized="true"
  2776. static="false" final="false" visibility="public"
  2777. deprecated="not deprecated">
  2778. </method>
  2779. <method name="setResetTimeOnStart"
  2780. abstract="false" native="false" synchronized="false"
  2781. static="false" final="false" visibility="protected"
  2782. deprecated="not deprecated">
  2783. <param name="resetTimeOnStart" type="boolean"/>
  2784. </method>
  2785. <field name="DEFAULT_EXPIRE" type="int"
  2786. transient="false" volatile="false"
  2787. static="true" final="true" visibility="public"
  2788. deprecated="not deprecated">
  2789. </field>
  2790. <doc>
  2791. <![CDATA[A simple liveliness monitor with which clients can register, trust the
  2792. component to monitor liveliness, get a call-back on expiry and then finally
  2793. unregister.]]>
  2794. </doc>
  2795. </class>
  2796. <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  2797. <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2798. <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
  2799. abstract="false"
  2800. static="false" final="false" visibility="public"
  2801. deprecated="not deprecated">
  2802. <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
  2803. static="false" final="false" visibility="public"
  2804. deprecated="not deprecated">
  2805. </constructor>
  2806. <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
  2807. static="false" final="false" visibility="public"
  2808. deprecated="not deprecated">
  2809. <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
  2810. </constructor>
  2811. <doc>
  2812. <![CDATA[This type has been deprecated in favor of
  2813. {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
  2814. ApplicationClassLoader should use that type instead.]]>
  2815. </doc>
  2816. </class>
  2817. <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  2818. <!-- start class org.apache.hadoop.yarn.util.BoundedAppender -->
  2819. <class name="BoundedAppender" extends="java.lang.Object"
  2820. abstract="false"
  2821. static="false" final="false" visibility="public"
  2822. deprecated="not deprecated">
  2823. <constructor name="BoundedAppender" type="int"
  2824. static="false" final="false" visibility="public"
  2825. deprecated="not deprecated">
  2826. </constructor>
  2827. <method name="append" return="org.apache.hadoop.yarn.util.BoundedAppender"
  2828. abstract="false" native="false" synchronized="false"
  2829. static="false" final="false" visibility="public"
  2830. deprecated="not deprecated">
  2831. <param name="csq" type="java.lang.CharSequence"/>
  2832. <doc>
  2833. <![CDATA[Append a {@link CharSequence} considering {@link #limit}, truncating
  2834. from the head of {@code csq} or {@link #messages} when necessary.
  2835. @param csq the {@link CharSequence} to append
  2836. @return this]]>
  2837. </doc>
  2838. </method>
  2839. <method name="length" return="int"
  2840. abstract="false" native="false" synchronized="false"
  2841. static="false" final="false" visibility="public"
  2842. deprecated="not deprecated">
  2843. <doc>
  2844. <![CDATA[Get current length of messages considering truncates
  2845. without header and ellipses.
  2846. @return current length]]>
  2847. </doc>
  2848. </method>
  2849. <method name="getLimit" return="int"
  2850. abstract="false" native="false" synchronized="false"
  2851. static="false" final="false" visibility="public"
  2852. deprecated="not deprecated">
  2853. </method>
  2854. <method name="toString" return="java.lang.String"
  2855. abstract="false" native="false" synchronized="false"
  2856. static="false" final="false" visibility="public"
  2857. deprecated="not deprecated">
  2858. <doc>
  2859. <![CDATA[Get a string representation of the actual contents, displaying also a
  2860. header and ellipses when there was a truncate.
  2861. @return String representation of the {@link #messages}]]>
  2862. </doc>
  2863. </method>
  2864. <field name="TRUNCATED_MESSAGES_TEMPLATE" type="java.lang.String"
  2865. transient="false" volatile="false"
  2866. static="true" final="true" visibility="public"
  2867. deprecated="not deprecated">
  2868. </field>
  2869. <doc>
  2870. <![CDATA[A {@link CharSequence} appender that considers its {@link #limit} as upper
  2871. bound.
  2872. <p>
  2873. When {@link #limit} would be reached on append, past messages will be
  2874. truncated from head, and a header telling the user about truncation will be
  2875. prepended, with ellipses in between header and messages.
  2876. <p>
  2877. Note that header and ellipses are not counted against {@link #limit}.
  2878. <p>
  2879. An example:
  2880. <pre>
  2881. {@code
  2882. // At the beginning it's an empty string
  2883. final Appendable shortAppender = new BoundedAppender(80);
  2884. // The whole message fits into limit
  2885. shortAppender.append(
  2886. "message1 this is a very long message but fitting into limit\n");
  2887. // The first message is truncated, the second not
  2888. shortAppender.append("message2 this is shorter than the previous one\n");
  2889. // The first message is deleted, the second truncated, the third
  2890. // preserved
  2891. shortAppender.append("message3 this is even shorter message, maybe.\n");
  2892. // The first two are deleted, the third one truncated, the last preserved
  2893. shortAppender.append("message4 the shortest one, yet the greatest :)");
  2894. // Current contents are like this:
  2895. // Diagnostic messages truncated, showing last 80 chars out of 199:
  2896. // ...s is even shorter message, maybe.
  2897. // message4 the shortest one, yet the greatest :)
  2898. }
  2899. </pre>
  2900. <p>
  2901. Note that <tt>null</tt> values are {@link #append(CharSequence) append}ed
  2902. just like in {@link StringBuilder#append(CharSequence) original
  2903. implementation}.
  2904. <p>
  2905. Note that this class is not thread safe.]]>
  2906. </doc>
  2907. </class>
  2908. <!-- end class org.apache.hadoop.yarn.util.BoundedAppender -->
  2909. <!-- start interface org.apache.hadoop.yarn.util.Clock -->
  2910. <interface name="Clock" abstract="true"
  2911. static="false" final="false" visibility="public"
  2912. deprecated="not deprecated">
  2913. <method name="getTime" return="long"
  2914. abstract="true" native="false" synchronized="false"
  2915. static="false" final="false" visibility="public"
  2916. deprecated="not deprecated">
  2917. </method>
  2918. <doc>
  2919. <![CDATA[A simple clock interface that gives you time.]]>
  2920. </doc>
  2921. </interface>
  2922. <!-- end interface org.apache.hadoop.yarn.util.Clock -->
  2923. <!-- start class org.apache.hadoop.yarn.util.ConverterUtils -->
  2924. <class name="ConverterUtils" extends="java.lang.Object"
  2925. abstract="false"
  2926. static="false" final="false" visibility="public"
  2927. deprecated="not deprecated">
  2928. <constructor name="ConverterUtils"
  2929. static="false" final="false" visibility="public"
  2930. deprecated="not deprecated">
  2931. </constructor>
  2932. <method name="getPathFromYarnURL" return="org.apache.hadoop.fs.Path"
  2933. abstract="false" native="false" synchronized="false"
  2934. static="true" final="false" visibility="public"
  2935. deprecated="not deprecated">
  2936. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  2937. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  2938. <doc>
  2939. <![CDATA[return a hadoop path from a given url
  2940. This method is deprecated, use {@link URL#toPath()} instead.
  2941. @param url
  2942. url to convert
  2943. @return path from {@link URL}
  2944. @throws URISyntaxException]]>
  2945. </doc>
  2946. </method>
  2947. <method name="getYarnUrlFromPath" return="org.apache.hadoop.yarn.api.records.URL"
  2948. abstract="false" native="false" synchronized="false"
  2949. static="true" final="false" visibility="public"
  2950. deprecated="not deprecated">
  2951. <param name="path" type="org.apache.hadoop.fs.Path"/>
  2952. </method>
  2953. <method name="getYarnUrlFromURI" return="org.apache.hadoop.yarn.api.records.URL"
  2954. abstract="false" native="false" synchronized="false"
  2955. static="true" final="false" visibility="public"
  2956. deprecated="not deprecated">
  2957. <param name="uri" type="java.net.URI"/>
  2958. </method>
  2959. <method name="toString" return="java.lang.String"
  2960. abstract="false" native="false" synchronized="false"
  2961. static="true" final="false" visibility="public"
  2962. deprecated="not deprecated">
  2963. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  2964. </method>
  2965. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2966. abstract="false" native="false" synchronized="false"
  2967. static="true" final="false" visibility="public"
  2968. deprecated="not deprecated">
  2969. <param name="recordFactory" type="org.apache.hadoop.yarn.factories.RecordFactory"/>
  2970. <param name="applicationIdStr" type="java.lang.String"/>
  2971. </method>
  2972. <method name="toString" return="java.lang.String"
  2973. abstract="false" native="false" synchronized="false"
  2974. static="true" final="false" visibility="public"
  2975. deprecated="not deprecated">
  2976. <param name="cId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  2977. </method>
  2978. <method name="toNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  2979. abstract="false" native="false" synchronized="false"
  2980. static="true" final="false" visibility="public"
  2981. deprecated="not deprecated">
  2982. <param name="nodeIdStr" type="java.lang.String"/>
  2983. </method>
  2984. <method name="toContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2985. abstract="false" native="false" synchronized="false"
  2986. static="true" final="false" visibility="public"
  2987. deprecated="not deprecated">
  2988. <param name="containerIdStr" type="java.lang.String"/>
  2989. </method>
  2990. <method name="toApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2991. abstract="false" native="false" synchronized="false"
  2992. static="true" final="false" visibility="public"
  2993. deprecated="not deprecated">
  2994. <param name="applicationAttemptIdStr" type="java.lang.String"/>
  2995. </method>
  2996. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  2997. abstract="false" native="false" synchronized="false"
  2998. static="true" final="false" visibility="public"
  2999. deprecated="not deprecated">
  3000. <param name="appIdStr" type="java.lang.String"/>
  3001. </method>
  3002. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  3003. abstract="false" native="false" synchronized="false"
  3004. static="true" final="false" visibility="public"
  3005. deprecated="not deprecated">
  3006. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  3007. <param name="serviceAddr" type="java.net.InetSocketAddress"/>
  3008. <doc>
  3009. <![CDATA[Convert a protobuf token into a rpc token and set its service. Supposed
  3010. to be used for tokens other than RMDelegationToken. For
  3011. RMDelegationToken, use
  3012. {@link #convertFromYarn(org.apache.hadoop.yarn.api.records.Token,
  3013. org.apache.hadoop.io.Text)} instead.
  3014. @param protoToken the yarn token
  3015. @param serviceAddr the connect address for the service
  3016. @return rpc token]]>
  3017. </doc>
  3018. </method>
  3019. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  3020. abstract="false" native="false" synchronized="false"
  3021. static="true" final="false" visibility="public"
  3022. deprecated="not deprecated">
  3023. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  3024. <param name="service" type="org.apache.hadoop.io.Text"/>
  3025. <doc>
  3026. <![CDATA[Convert a protobuf token into a rpc token and set its service.
  3027. @param protoToken the yarn token
  3028. @param service the service for the token]]>
  3029. </doc>
  3030. </method>
  3031. <field name="APPLICATION_PREFIX" type="java.lang.String"
  3032. transient="false" volatile="false"
  3033. static="true" final="true" visibility="public"
  3034. deprecated="not deprecated">
  3035. </field>
  3036. <field name="CONTAINER_PREFIX" type="java.lang.String"
  3037. transient="false" volatile="false"
  3038. static="true" final="true" visibility="public"
  3039. deprecated="not deprecated">
  3040. </field>
  3041. <field name="APPLICATION_ATTEMPT_PREFIX" type="java.lang.String"
  3042. transient="false" volatile="false"
  3043. static="true" final="true" visibility="public"
  3044. deprecated="not deprecated">
  3045. </field>
  3046. <doc>
  3047. <![CDATA[This class contains a set of utilities which help converting data structures
  3048. from/to 'serializableFormat' to/from hadoop/nativejava data structures.]]>
  3049. </doc>
  3050. </class>
  3051. <!-- end class org.apache.hadoop.yarn.util.ConverterUtils -->
  3052. <!-- start class org.apache.hadoop.yarn.util.MonotonicClock -->
  3053. <class name="MonotonicClock" extends="java.lang.Object"
  3054. abstract="false"
  3055. static="false" final="false" visibility="public"
  3056. deprecated="not deprecated">
  3057. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3058. <constructor name="MonotonicClock"
  3059. static="false" final="false" visibility="public"
  3060. deprecated="not deprecated">
  3061. </constructor>
  3062. <method name="getTime" return="long"
  3063. abstract="false" native="false" synchronized="false"
  3064. static="false" final="false" visibility="public"
  3065. deprecated="not deprecated">
  3066. <doc>
  3067. <![CDATA[Get current time from some arbitrary time base in the past, counting in
  3068. milliseconds, and not affected by settimeofday or similar system clock
  3069. changes.
  3070. @return a monotonic clock that counts in milliseconds.]]>
  3071. </doc>
  3072. </method>
  3073. <doc>
  3074. <![CDATA[A monotonic clock from some arbitrary time base in the past, counting in
  3075. milliseconds, and not affected by settimeofday or similar system clock
  3076. changes.
  3077. This is appropriate to use when computing how much longer to wait for an
  3078. interval to expire.
  3079. This function can return a negative value and it must be handled correctly
  3080. by callers. See the documentation of System#nanoTime for caveats.]]>
  3081. </doc>
  3082. </class>
  3083. <!-- end class org.apache.hadoop.yarn.util.MonotonicClock -->
  3084. <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3085. <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
  3086. abstract="true"
  3087. static="false" final="false" visibility="public"
  3088. deprecated="not deprecated">
  3089. <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
  3090. static="false" final="false" visibility="public"
  3091. deprecated="not deprecated">
  3092. <doc>
  3093. <![CDATA[Create process-tree instance with specified root process.
  3094. Subclass must override this.
  3095. @param root process-tree root-process]]>
  3096. </doc>
  3097. </constructor>
  3098. <method name="initialize"
  3099. abstract="false" native="false" synchronized="false"
  3100. static="false" final="false" visibility="public"
  3101. deprecated="not deprecated">
  3102. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  3103. <doc>
  3104. <![CDATA[Initialize the object.
  3105. @throws YarnException Throws an exception on error.]]>
  3106. </doc>
  3107. </method>
  3108. <method name="updateProcessTree"
  3109. abstract="true" native="false" synchronized="false"
  3110. static="false" final="false" visibility="public"
  3111. deprecated="not deprecated">
  3112. <doc>
  3113. <![CDATA[Update the process-tree with latest state.
  3114. Each call to this function should increment the age of the running
  3115. processes that already exist in the process tree. Age is used other API's
  3116. of the interface.]]>
  3117. </doc>
  3118. </method>
  3119. <method name="getProcessTreeDump" return="java.lang.String"
  3120. abstract="true" native="false" synchronized="false"
  3121. static="false" final="false" visibility="public"
  3122. deprecated="not deprecated">
  3123. <doc>
  3124. <![CDATA[Get a dump of the process-tree.
  3125. @return a string concatenating the dump of information of all the processes
  3126. in the process-tree]]>
  3127. </doc>
  3128. </method>
  3129. <method name="getVirtualMemorySize" return="long"
  3130. abstract="false" native="false" synchronized="false"
  3131. static="false" final="false" visibility="public"
  3132. deprecated="not deprecated">
  3133. <doc>
  3134. <![CDATA[Get the virtual memory used by all the processes in the
  3135. process-tree.
  3136. @return virtual memory used by the process-tree in bytes,
  3137. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3138. </doc>
  3139. </method>
  3140. <method name="getRssMemorySize" return="long"
  3141. abstract="false" native="false" synchronized="false"
  3142. static="false" final="false" visibility="public"
  3143. deprecated="not deprecated">
  3144. <doc>
  3145. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3146. in the process-tree.
  3147. @return rss memory used by the process-tree in bytes,
  3148. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3149. </doc>
  3150. </method>
  3151. <method name="getVirtualMemorySize" return="long"
  3152. abstract="false" native="false" synchronized="false"
  3153. static="false" final="false" visibility="public"
  3154. deprecated="not deprecated">
  3155. <param name="olderThanAge" type="int"/>
  3156. <doc>
  3157. <![CDATA[Get the virtual memory used by all the processes in the
  3158. process-tree that are older than the passed in age.
  3159. @param olderThanAge processes above this age are included in the
  3160. memory addition
  3161. @return virtual memory used by the process-tree in bytes for
  3162. processes older than the specified age, {@link #UNAVAILABLE} if it
  3163. cannot be calculated.]]>
  3164. </doc>
  3165. </method>
  3166. <method name="getRssMemorySize" return="long"
  3167. abstract="false" native="false" synchronized="false"
  3168. static="false" final="false" visibility="public"
  3169. deprecated="not deprecated">
  3170. <param name="olderThanAge" type="int"/>
  3171. <doc>
  3172. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3173. in the process-tree that are older than the passed in age.
  3174. @param olderThanAge processes above this age are included in the
  3175. memory addition
  3176. @return rss memory used by the process-tree in bytes for
  3177. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  3178. calculated.]]>
  3179. </doc>
  3180. </method>
  3181. <method name="getCumulativeCpuTime" return="long"
  3182. abstract="false" native="false" synchronized="false"
  3183. static="false" final="false" visibility="public"
  3184. deprecated="not deprecated">
  3185. <doc>
  3186. <![CDATA[Get the CPU time in millisecond used by all the processes in the
  3187. process-tree since the process-tree was created
  3188. @return cumulative CPU time in millisecond since the process-tree
  3189. created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3190. </doc>
  3191. </method>
  3192. <method name="getCpuUsagePercent" return="float"
  3193. abstract="false" native="false" synchronized="false"
  3194. static="false" final="false" visibility="public"
  3195. deprecated="not deprecated">
  3196. <doc>
  3197. <![CDATA[Get the CPU usage by all the processes in the process-tree based on
  3198. average between samples as a ratio of overall CPU cycles similar to top.
  3199. Thus, if 2 out of 4 cores are used this should return 200.0.
  3200. Note: UNAVAILABLE will be returned in case when CPU usage is not
  3201. available. It is NOT advised to return any other error code.
  3202. @return percentage CPU usage since the process-tree was created,
  3203. {@link #UNAVAILABLE} if CPU usage cannot be calculated or not available.]]>
  3204. </doc>
  3205. </method>
  3206. <method name="checkPidPgrpidForMatch" return="boolean"
  3207. abstract="true" native="false" synchronized="false"
  3208. static="false" final="false" visibility="public"
  3209. deprecated="not deprecated">
  3210. <doc>
  3211. <![CDATA[Verify that the tree process id is same as its process group id.
  3212. @return true if the process id matches else return false.]]>
  3213. </doc>
  3214. </method>
  3215. <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
  3216. abstract="false" native="false" synchronized="false"
  3217. static="true" final="false" visibility="public"
  3218. deprecated="not deprecated">
  3219. <param name="pid" type="java.lang.String"/>
  3220. <param name="clazz" type="java.lang.Class"/>
  3221. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3222. <doc>
  3223. <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
  3224. from the class name and configure it. If class name is null, this method
  3225. will try and return a process tree plugin available for this system.
  3226. @param pid process pid of the root of the process tree
  3227. @param clazz class-name
  3228. @param conf configure the plugin with this.
  3229. @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
  3230. is not available for this system.]]>
  3231. </doc>
  3232. </method>
  3233. <field name="UNAVAILABLE" type="int"
  3234. transient="false" volatile="false"
  3235. static="true" final="true" visibility="public"
  3236. deprecated="not deprecated">
  3237. </field>
  3238. <doc>
  3239. <![CDATA[Interface class to obtain process resource usage
  3240. NOTE: This class should not be used by external users, but only by external
  3241. developers to extend and include their own process-tree implementation,
  3242. especially for platforms other than Linux and Windows.]]>
  3243. </doc>
  3244. </class>
  3245. <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3246. <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
  3247. <class name="SystemClock" extends="java.lang.Object"
  3248. abstract="false"
  3249. static="false" final="true" visibility="public"
  3250. deprecated="not deprecated">
  3251. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3252. <constructor name="SystemClock"
  3253. static="false" final="false" visibility="public"
  3254. deprecated="not deprecated">
  3255. </constructor>
  3256. <method name="getInstance" return="org.apache.hadoop.yarn.util.SystemClock"
  3257. abstract="false" native="false" synchronized="false"
  3258. static="true" final="false" visibility="public"
  3259. deprecated="not deprecated">
  3260. </method>
  3261. <method name="getTime" return="long"
  3262. abstract="false" native="false" synchronized="false"
  3263. static="false" final="false" visibility="public"
  3264. deprecated="not deprecated">
  3265. </method>
  3266. <doc>
  3267. <![CDATA[Implementation of {@link Clock} that gives the current time from the system
  3268. clock in milliseconds.
  3269. NOTE: Do not use this to calculate a duration of expire or interval to sleep,
  3270. because it will be broken by settimeofday. Please use {@link MonotonicClock}
  3271. instead.]]>
  3272. </doc>
  3273. </class>
  3274. <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
  3275. <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
  3276. <class name="UTCClock" extends="java.lang.Object"
  3277. abstract="false"
  3278. static="false" final="false" visibility="public"
  3279. deprecated="not deprecated">
  3280. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3281. <constructor name="UTCClock"
  3282. static="false" final="false" visibility="public"
  3283. deprecated="not deprecated">
  3284. </constructor>
  3285. <method name="getTime" return="long"
  3286. abstract="false" native="false" synchronized="false"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. </method>
  3290. <doc>
  3291. <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
  3292. milliseconds.]]>
  3293. </doc>
  3294. </class>
  3295. <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
  3296. </package>
  3297. <package name="org.apache.hadoop.yarn.util.resource">
  3298. </package>
  3299. <package name="org.apache.hadoop.yarn.util.timeline">
  3300. <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3301. <class name="TimelineUtils" extends="java.lang.Object"
  3302. abstract="false"
  3303. static="false" final="false" visibility="public"
  3304. deprecated="not deprecated">
  3305. <constructor name="TimelineUtils"
  3306. static="false" final="false" visibility="public"
  3307. deprecated="not deprecated">
  3308. </constructor>
  3309. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3310. abstract="false" native="false" synchronized="false"
  3311. static="true" final="false" visibility="public"
  3312. deprecated="not deprecated">
  3313. <param name="o" type="java.lang.Object"/>
  3314. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3315. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3316. <exception name="IOException" type="java.io.IOException"/>
  3317. <doc>
  3318. <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
  3319. @param o
  3320. an object to serialize
  3321. @return a JSON string
  3322. @throws IOException
  3323. @throws JsonMappingException
  3324. @throws JsonGenerationException]]>
  3325. </doc>
  3326. </method>
  3327. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3328. abstract="false" native="false" synchronized="false"
  3329. static="true" final="false" visibility="public"
  3330. deprecated="not deprecated">
  3331. <param name="o" type="java.lang.Object"/>
  3332. <param name="pretty" type="boolean"/>
  3333. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3334. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3335. <exception name="IOException" type="java.io.IOException"/>
  3336. <doc>
  3337. <![CDATA[Serialize a POJO object into a JSON string
  3338. @param o
  3339. an object to serialize
  3340. @param pretty
  3341. whether in a pretty format or not
  3342. @return a JSON string
  3343. @throws IOException
  3344. @throws JsonMappingException
  3345. @throws JsonGenerationException]]>
  3346. </doc>
  3347. </method>
  3348. <method name="timelineServiceEnabled" return="boolean"
  3349. abstract="false" native="false" synchronized="false"
  3350. static="true" final="false" visibility="public"
  3351. deprecated="not deprecated">
  3352. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3353. <doc>
  3354. <![CDATA[Returns whether the timeline service is enabled via configuration.
  3355. @param conf the configuration
  3356. @return whether the timeline service is enabled.]]>
  3357. </doc>
  3358. </method>
  3359. <method name="getTimelineServiceVersion" return="float"
  3360. abstract="false" native="false" synchronized="false"
  3361. static="true" final="false" visibility="public"
  3362. deprecated="not deprecated">
  3363. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3364. <doc>
  3365. <![CDATA[Returns the timeline service version. It does not check whether the
  3366. timeline service itself is enabled.
  3367. @param conf the configuration
  3368. @return the timeline service version as a float.]]>
  3369. </doc>
  3370. </method>
  3371. <method name="timelineServiceV1_5Enabled" return="boolean"
  3372. abstract="false" native="false" synchronized="false"
  3373. static="true" final="false" visibility="public"
  3374. deprecated="not deprecated">
  3375. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3376. <doc>
  3377. <![CDATA[Returns whether the timeline service v.1.5 is enabled by default via
  3378. configuration.
  3379. @param conf the configuration
  3380. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  3381. version equal to 1.5.]]>
  3382. </doc>
  3383. </method>
  3384. <method name="createTimelineAbout" return="org.apache.hadoop.yarn.api.records.timeline.TimelineAbout"
  3385. abstract="false" native="false" synchronized="false"
  3386. static="true" final="false" visibility="public"
  3387. deprecated="not deprecated">
  3388. <param name="about" type="java.lang.String"/>
  3389. </method>
  3390. <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
  3391. abstract="false" native="false" synchronized="false"
  3392. static="true" final="false" visibility="public"
  3393. deprecated="not deprecated">
  3394. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3395. </method>
  3396. <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
  3397. abstract="false" native="false" synchronized="false"
  3398. static="true" final="false" visibility="public"
  3399. deprecated="not deprecated">
  3400. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3401. </method>
  3402. <method name="generateDefaultFlowName" return="java.lang.String"
  3403. abstract="false" native="false" synchronized="false"
  3404. static="true" final="false" visibility="public"
  3405. deprecated="not deprecated">
  3406. <param name="appName" type="java.lang.String"/>
  3407. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3408. </method>
  3409. <method name="generateFlowNameTag" return="java.lang.String"
  3410. abstract="false" native="false" synchronized="false"
  3411. static="true" final="false" visibility="public"
  3412. deprecated="not deprecated">
  3413. <param name="flowName" type="java.lang.String"/>
  3414. <doc>
  3415. <![CDATA[Generate flow name tag.
  3416. @param flowName flow name that identifies a distinct flow application which
  3417. can be run repeatedly over time
  3418. @return flow name tag.]]>
  3419. </doc>
  3420. </method>
  3421. <method name="generateFlowVersionTag" return="java.lang.String"
  3422. abstract="false" native="false" synchronized="false"
  3423. static="true" final="false" visibility="public"
  3424. deprecated="not deprecated">
  3425. <param name="flowVersion" type="java.lang.String"/>
  3426. <doc>
  3427. <![CDATA[Generate flow version tag.
  3428. @param flowVersion flow version that keeps track of the changes made to the
  3429. flow
  3430. @return flow version tag.]]>
  3431. </doc>
  3432. </method>
  3433. <method name="generateFlowRunIdTag" return="java.lang.String"
  3434. abstract="false" native="false" synchronized="false"
  3435. static="true" final="false" visibility="public"
  3436. deprecated="not deprecated">
  3437. <param name="flowRunId" type="long"/>
  3438. <doc>
  3439. <![CDATA[Generate flow run ID tag.
  3440. @param flowRunId flow run ID that identifies one instance (or specific
  3441. execution) of that flow
  3442. @return flow run id tag.]]>
  3443. </doc>
  3444. </method>
  3445. <field name="FLOW_NAME_TAG_PREFIX" type="java.lang.String"
  3446. transient="false" volatile="false"
  3447. static="true" final="true" visibility="public"
  3448. deprecated="not deprecated">
  3449. </field>
  3450. <field name="FLOW_VERSION_TAG_PREFIX" type="java.lang.String"
  3451. transient="false" volatile="false"
  3452. static="true" final="true" visibility="public"
  3453. deprecated="not deprecated">
  3454. </field>
  3455. <field name="FLOW_RUN_ID_TAG_PREFIX" type="java.lang.String"
  3456. transient="false" volatile="false"
  3457. static="true" final="true" visibility="public"
  3458. deprecated="not deprecated">
  3459. </field>
  3460. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  3461. transient="false" volatile="false"
  3462. static="true" final="true" visibility="public"
  3463. deprecated="not deprecated">
  3464. </field>
  3465. <doc>
  3466. <![CDATA[The helper class for the timeline module.]]>
  3467. </doc>
  3468. </class>
  3469. <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3470. </package>
  3471. <package name="org.apache.hadoop.yarn.webapp.util">
  3472. </package>
  3473. </api>