Apache_Hadoop_YARN_Common_3.2.2.xml 181 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957
  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 Sun Jan 03 10:30:33 UTC 2021 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="Apache Hadoop YARN Common 3.2.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.2.2.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/org/apache/httpcomponents/httpclient/4.5.13/httpclient-4.5.13.jar:/maven/org/apache/httpcomponents/httpcore/4.4.13/httpcore-4.4.13.jar:/maven/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/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar:/maven/org/eclipse/jetty/jetty-server/9.4.20.v20190813/jetty-server-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-http/9.4.20.v20190813/jetty-http-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-io/9.4.20.v20190813/jetty-io-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-servlet/9.4.20.v20190813/jetty-servlet-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-security/9.4.20.v20190813/jetty-security-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-webapp/9.4.20.v20190813/jetty-webapp-9.4.20.v20190813.jar:/maven/org/eclipse/jetty/jetty-xml/9.4.20.v20190813/jetty-xml-9.4.20.v20190813.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.4/commons-beanutils-1.9.4.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.7/commons-lang3-3.7.jar:/maven/org/apache/commons/commons-text/1.4/commons-text-1.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.55/jsch-0.1.55.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.2/jsr305-3.0.2.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.6.Final/netty-3.10.6.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:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/build/source/hadoop-hdfs-project/hadoop-hdfs-client/target/hadoop-hdfs-client-3.2.2.jar:/maven/com/squareup/okhttp/okhttp/2.7.5/okhttp-2.7.5.jar:/maven/com/squareup/okio/okio/1.6.0/okio-1.6.0.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.9.10/jackson-annotations-2.9.10.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-yarn-api-3.2.2.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.2.2.jar:/maven/com/nimbusds/nimbus-jose-jwt/7.9/nimbus-jose-jwt-7.9.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.19/commons-compress-1.19.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.4.20.v20190813/jetty-util-9.4.20.v20190813.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/27.0-jre/guava-27.0-jre.jar:/maven/com/google/guava/failureaccess/1.0/failureaccess-1.0.jar:/maven/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:/maven/org/checkerframework/checker-qual/2.5.2/checker-qual-2.5.2.jar:/maven/com/google/errorprone/error_prone_annotations/2.2.0/error_prone_annotations-2.2.0.jar:/maven/com/google/j2objc/j2objc-annotations/1.1/j2objc-annotations-1.1.jar:/maven/org/codehaus/mojo/animal-sniffer-annotations/1.17/animal-sniffer-annotations-1.17.jar:/maven/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.2.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.9.10/jackson-core-2.9.10.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.9.10.4/jackson-databind-2.9.10.4.jar:/maven/com/fasterxml/jackson/module/jackson-module-jaxb-annotations/2.9.10/jackson-module-jaxb-annotations-2.9.10.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-json-provider/2.9.10/jackson-jaxrs-json-provider-2.9.10.jar:/maven/com/fasterxml/jackson/jaxrs/jackson-jaxrs-base/2.9.10/jackson-jaxrs-base-2.9.10.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.2.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. <method name="actionDecommissionInstances" return="int"
  621. abstract="true" native="false" synchronized="false"
  622. static="false" final="false" visibility="public"
  623. deprecated="not deprecated">
  624. <param name="appName" type="java.lang.String"/>
  625. <param name="componentInstances" type="java.util.List"/>
  626. <exception name="IOException" type="java.io.IOException"/>
  627. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  628. <doc>
  629. <![CDATA[Decommission component instances of a long running service.
  630. @param appName the name of the application.
  631. @param componentInstances the name of the component instances.]]>
  632. </doc>
  633. </method>
  634. <field name="YARN_APP_ADMIN_CLIENT_PREFIX" type="java.lang.String"
  635. transient="false" volatile="false"
  636. static="true" final="true" visibility="public"
  637. deprecated="not deprecated">
  638. </field>
  639. <field name="DEFAULT_TYPE" type="java.lang.String"
  640. transient="false" volatile="false"
  641. static="true" final="true" visibility="public"
  642. deprecated="not deprecated">
  643. </field>
  644. <field name="DEFAULT_CLASS_NAME" type="java.lang.String"
  645. transient="false" volatile="false"
  646. static="true" final="true" visibility="public"
  647. deprecated="not deprecated">
  648. </field>
  649. <field name="UNIT_TEST_TYPE" type="java.lang.String"
  650. transient="false" volatile="false"
  651. static="true" final="true" visibility="public"
  652. deprecated="not deprecated">
  653. </field>
  654. <field name="UNIT_TEST_CLASS_NAME" type="java.lang.String"
  655. transient="false" volatile="false"
  656. static="true" final="true" visibility="public"
  657. deprecated="not deprecated">
  658. </field>
  659. <doc>
  660. <![CDATA[Client for managing applications.]]>
  661. </doc>
  662. </class>
  663. <!-- end class org.apache.hadoop.yarn.client.api.AppAdminClient -->
  664. <!-- start class org.apache.hadoop.yarn.client.api.TimelineClient -->
  665. <class name="TimelineClient" extends="org.apache.hadoop.service.CompositeService"
  666. abstract="true"
  667. static="false" final="false" visibility="public"
  668. deprecated="not deprecated">
  669. <implements name="java.io.Flushable"/>
  670. <constructor name="TimelineClient" type="java.lang.String"
  671. static="false" final="false" visibility="protected"
  672. deprecated="not deprecated">
  673. </constructor>
  674. <method name="createTimelineClient" return="org.apache.hadoop.yarn.client.api.TimelineClient"
  675. abstract="false" native="false" synchronized="false"
  676. static="true" final="false" visibility="public"
  677. deprecated="not deprecated">
  678. <doc>
  679. <![CDATA[Creates an instance of the timeline v.1.x client.
  680. The current UGI when the user initialize the client will be used to do the
  681. put and the delegation token operations. The current user may use
  682. {@link UserGroupInformation#doAs} another user to construct and initialize
  683. a timeline client if the following operations are supposed to be conducted
  684. by that user.
  685. @return the created timeline client instance]]>
  686. </doc>
  687. </method>
  688. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  689. abstract="true" native="false" synchronized="false"
  690. static="false" final="false" visibility="public"
  691. deprecated="not deprecated">
  692. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  693. <exception name="IOException" type="java.io.IOException"/>
  694. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  695. <doc>
  696. <![CDATA[<p>
  697. Send the information of a number of conceptual entities to the timeline
  698. server. It is a blocking API. The method will not return until it gets the
  699. response from the timeline server.
  700. </p>
  701. @param entities
  702. the collection of {@link TimelineEntity}
  703. @return the error information if the sent entities are not correctly stored
  704. @throws IOException if there are I/O errors
  705. @throws YarnException if entities are incomplete/invalid]]>
  706. </doc>
  707. </method>
  708. <method name="putEntities" return="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse"
  709. abstract="true" native="false" synchronized="false"
  710. static="false" final="false" visibility="public"
  711. deprecated="not deprecated">
  712. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  713. <param name="groupId" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"/>
  714. <param name="entities" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity[]"/>
  715. <exception name="IOException" type="java.io.IOException"/>
  716. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  717. <doc>
  718. <![CDATA[<p>
  719. Send the information of a number of conceptual entities to the timeline
  720. server. It is a blocking API. The method will not return until it gets the
  721. response from the timeline server.
  722. This API is only for timeline service v1.5
  723. </p>
  724. @param appAttemptId {@link ApplicationAttemptId}
  725. @param groupId {@link TimelineEntityGroupId}
  726. @param entities
  727. the collection of {@link TimelineEntity}
  728. @return the error information if the sent entities are not correctly stored
  729. @throws IOException if there are I/O errors
  730. @throws YarnException if entities are incomplete/invalid]]>
  731. </doc>
  732. </method>
  733. <method name="putDomain"
  734. abstract="true" native="false" synchronized="false"
  735. static="false" final="false" visibility="public"
  736. deprecated="not deprecated">
  737. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  738. <exception name="IOException" type="java.io.IOException"/>
  739. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  740. <doc>
  741. <![CDATA[<p>
  742. Send the information of a domain to the timeline server. It is a
  743. blocking API. The method will not return until it gets the response from
  744. the timeline server.
  745. </p>
  746. @param domain
  747. an {@link TimelineDomain} object
  748. @throws IOException
  749. @throws YarnException]]>
  750. </doc>
  751. </method>
  752. <method name="putDomain"
  753. abstract="true" native="false" synchronized="false"
  754. static="false" final="false" visibility="public"
  755. deprecated="not deprecated">
  756. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  757. <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
  758. <exception name="IOException" type="java.io.IOException"/>
  759. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  760. <doc>
  761. <![CDATA[<p>
  762. Send the information of a domain to the timeline server. It is a
  763. blocking API. The method will not return until it gets the response from
  764. the timeline server.
  765. This API is only for timeline service v1.5
  766. </p>
  767. @param domain
  768. an {@link TimelineDomain} object
  769. @param appAttemptId {@link ApplicationAttemptId}
  770. @throws IOException
  771. @throws YarnException]]>
  772. </doc>
  773. </method>
  774. <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
  775. abstract="true" native="false" synchronized="false"
  776. static="false" final="false" visibility="public"
  777. deprecated="not deprecated">
  778. <param name="renewer" type="java.lang.String"/>
  779. <exception name="IOException" type="java.io.IOException"/>
  780. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  781. <doc>
  782. <![CDATA[<p>
  783. Get a delegation token so as to be able to talk to the timeline server in a
  784. secure way.
  785. </p>
  786. @param renewer
  787. Address of the renewer who can renew these tokens when needed by
  788. securely talking to the timeline server
  789. @return a delegation token ({@link Token}) that can be used to talk to the
  790. timeline server
  791. @throws IOException
  792. @throws YarnException]]>
  793. </doc>
  794. </method>
  795. <method name="renewDelegationToken" return="long"
  796. abstract="true" native="false" synchronized="false"
  797. static="false" final="false" visibility="public"
  798. deprecated="not deprecated">
  799. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  800. <exception name="IOException" type="java.io.IOException"/>
  801. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  802. <doc>
  803. <![CDATA[<p>
  804. Renew a timeline delegation token.
  805. </p>
  806. @param timelineDT
  807. the delegation token to renew
  808. @return the new expiration time
  809. @throws IOException
  810. @throws YarnException]]>
  811. </doc>
  812. </method>
  813. <method name="cancelDelegationToken"
  814. abstract="true" native="false" synchronized="false"
  815. static="false" final="false" visibility="public"
  816. deprecated="not deprecated">
  817. <param name="timelineDT" type="org.apache.hadoop.security.token.Token"/>
  818. <exception name="IOException" type="java.io.IOException"/>
  819. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  820. <doc>
  821. <![CDATA[<p>
  822. Cancel a timeline delegation token.
  823. </p>
  824. @param timelineDT
  825. the delegation token to cancel
  826. @throws IOException
  827. @throws YarnException]]>
  828. </doc>
  829. </method>
  830. <doc>
  831. <![CDATA[A client library that can be used to post some information in terms of a
  832. number of conceptual entities. This client library needs to be used along
  833. with Timeline V.1.x server versions.
  834. Refer {@link TimelineV2Client} for ATS V2 interface.]]>
  835. </doc>
  836. </class>
  837. <!-- end class org.apache.hadoop.yarn.client.api.TimelineClient -->
  838. <!-- start class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
  839. <class name="TimelineReaderClient" extends="org.apache.hadoop.service.CompositeService"
  840. abstract="true"
  841. static="false" final="false" visibility="public"
  842. deprecated="not deprecated">
  843. <constructor name="TimelineReaderClient" type="java.lang.String"
  844. static="false" final="false" visibility="public"
  845. deprecated="not deprecated">
  846. </constructor>
  847. <method name="createTimelineReaderClient" return="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
  848. abstract="false" native="false" synchronized="false"
  849. static="true" final="false" visibility="public"
  850. deprecated="not deprecated">
  851. <doc>
  852. <![CDATA[Create a new instance of Timeline Reader Client.]]>
  853. </doc>
  854. </method>
  855. <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  856. abstract="true" native="false" synchronized="false"
  857. static="false" final="false" visibility="public"
  858. deprecated="not deprecated">
  859. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  860. <param name="fields" type="java.lang.String"/>
  861. <param name="filters" type="java.util.Map"/>
  862. <exception name="IOException" type="java.io.IOException"/>
  863. <doc>
  864. <![CDATA[Gets application entity.
  865. @param appId application id
  866. @param fields Fields to be fetched. Defaults to INFO.
  867. @param filters Filters to be applied while fetching entities.
  868. @return entity of the application
  869. @throws IOException]]>
  870. </doc>
  871. </method>
  872. <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  873. abstract="true" native="false" synchronized="false"
  874. static="false" final="false" visibility="public"
  875. deprecated="not deprecated">
  876. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  877. <param name="fields" type="java.lang.String"/>
  878. <param name="filters" type="java.util.Map"/>
  879. <exception name="IOException" type="java.io.IOException"/>
  880. <doc>
  881. <![CDATA[Gets application attempt entity.
  882. @param appAttemptId application attempt id
  883. @param fields Fields to be fetched. Defaults to INFO.
  884. @param filters Filters to be applied while fetching entities.
  885. @return entity associated with application attempt
  886. @throws IOException]]>
  887. </doc>
  888. </method>
  889. <method name="getApplicationAttemptEntities" return="java.util.List"
  890. abstract="true" native="false" synchronized="false"
  891. static="false" final="false" visibility="public"
  892. deprecated="not deprecated">
  893. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  894. <param name="fields" type="java.lang.String"/>
  895. <param name="filters" type="java.util.Map"/>
  896. <param name="limit" type="long"/>
  897. <param name="fromId" type="java.lang.String"/>
  898. <exception name="IOException" type="java.io.IOException"/>
  899. <doc>
  900. <![CDATA[Gets application attempt entities.
  901. @param appId application id
  902. @param fields Fields to be fetched. Defaults to INFO.
  903. @param filters Filters to be applied while fetching entities.
  904. @param limit Number of entities to return.
  905. @param fromId Retrieve next set of generic ids from given fromId
  906. @return list of application attempt entities
  907. @throws IOException]]>
  908. </doc>
  909. </method>
  910. <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  911. abstract="true" native="false" synchronized="false"
  912. static="false" final="false" visibility="public"
  913. deprecated="not deprecated">
  914. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  915. <param name="fields" type="java.lang.String"/>
  916. <param name="filters" type="java.util.Map"/>
  917. <exception name="IOException" type="java.io.IOException"/>
  918. <doc>
  919. <![CDATA[Gets Timeline entity for the container.
  920. @param containerId container id
  921. @param fields Fields to be fetched. Defaults to INFO.
  922. @param filters Filters to be applied while fetching entities.
  923. @return timeline entity for container
  924. @throws IOException]]>
  925. </doc>
  926. </method>
  927. <method name="getContainerEntities" return="java.util.List"
  928. abstract="true" native="false" synchronized="false"
  929. static="false" final="false" visibility="public"
  930. deprecated="not deprecated">
  931. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  932. <param name="fields" type="java.lang.String"/>
  933. <param name="filters" type="java.util.Map"/>
  934. <param name="limit" type="long"/>
  935. <param name="fromId" type="java.lang.String"/>
  936. <exception name="IOException" type="java.io.IOException"/>
  937. <doc>
  938. <![CDATA[Gets container entities for an application.
  939. @param appId application id
  940. @param fields Fields to be fetched. Defaults to INFO.
  941. @param filters Filters to be applied while fetching entities.
  942. @param limit Number of entities to return.
  943. @param fromId Retrieve next set of generic ids from given fromId
  944. @return list of entities
  945. @throws IOException]]>
  946. </doc>
  947. </method>
  948. <doc>
  949. <![CDATA[A client library that can be used to get Timeline Entities associated with
  950. application, application attempt or containers. This client library needs to
  951. be used along with time line v.2 server version.]]>
  952. </doc>
  953. </class>
  954. <!-- end class org.apache.hadoop.yarn.client.api.TimelineReaderClient -->
  955. </package>
  956. <package name="org.apache.hadoop.yarn.client.api.impl">
  957. <!-- start class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
  958. <class name="TimelineReaderClientImpl" extends="org.apache.hadoop.yarn.client.api.TimelineReaderClient"
  959. abstract="false"
  960. static="false" final="false" visibility="public"
  961. deprecated="not deprecated">
  962. <constructor name="TimelineReaderClientImpl"
  963. static="false" final="false" visibility="public"
  964. deprecated="not deprecated">
  965. </constructor>
  966. <method name="serviceInit"
  967. abstract="false" native="false" synchronized="false"
  968. static="false" final="false" visibility="protected"
  969. deprecated="not deprecated">
  970. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  971. <exception name="Exception" type="java.lang.Exception"/>
  972. </method>
  973. <method name="getApplicationEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  974. abstract="false" native="false" synchronized="false"
  975. static="false" final="false" visibility="public"
  976. deprecated="not deprecated">
  977. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  978. <param name="fields" type="java.lang.String"/>
  979. <param name="filters" type="java.util.Map"/>
  980. <exception name="IOException" type="java.io.IOException"/>
  981. </method>
  982. <method name="getApplicationAttemptEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  983. abstract="false" native="false" synchronized="false"
  984. static="false" final="false" visibility="public"
  985. deprecated="not deprecated">
  986. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  987. <param name="fields" type="java.lang.String"/>
  988. <param name="filters" type="java.util.Map"/>
  989. <exception name="IOException" type="java.io.IOException"/>
  990. </method>
  991. <method name="getApplicationAttemptEntities" return="java.util.List"
  992. abstract="false" native="false" synchronized="false"
  993. static="false" final="false" visibility="public"
  994. deprecated="not deprecated">
  995. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  996. <param name="fields" type="java.lang.String"/>
  997. <param name="filters" type="java.util.Map"/>
  998. <param name="limit" type="long"/>
  999. <param name="fromId" type="java.lang.String"/>
  1000. <exception name="IOException" type="java.io.IOException"/>
  1001. </method>
  1002. <method name="getContainerEntity" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
  1003. abstract="false" native="false" synchronized="false"
  1004. static="false" final="false" visibility="public"
  1005. deprecated="not deprecated">
  1006. <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  1007. <param name="fields" type="java.lang.String"/>
  1008. <param name="filters" type="java.util.Map"/>
  1009. <exception name="IOException" type="java.io.IOException"/>
  1010. </method>
  1011. <method name="getContainerEntities" return="java.util.List"
  1012. abstract="false" native="false" synchronized="false"
  1013. static="false" final="false" visibility="public"
  1014. deprecated="not deprecated">
  1015. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1016. <param name="fields" type="java.lang.String"/>
  1017. <param name="filters" type="java.util.Map"/>
  1018. <param name="limit" type="long"/>
  1019. <param name="fromId" type="java.lang.String"/>
  1020. <exception name="IOException" type="java.io.IOException"/>
  1021. </method>
  1022. <method name="doGetUri" return="com.sun.jersey.api.client.ClientResponse"
  1023. abstract="false" native="false" synchronized="false"
  1024. static="false" final="false" visibility="protected"
  1025. deprecated="not deprecated">
  1026. <param name="base" type="java.net.URI"/>
  1027. <param name="path" type="java.lang.String"/>
  1028. <param name="params" type="javax.ws.rs.core.MultivaluedMap"/>
  1029. <exception name="IOException" type="java.io.IOException"/>
  1030. </method>
  1031. <doc>
  1032. <![CDATA[Implementation of TimelineReaderClient interface.]]>
  1033. </doc>
  1034. </class>
  1035. <!-- end class org.apache.hadoop.yarn.client.api.impl.TimelineReaderClientImpl -->
  1036. </package>
  1037. <package name="org.apache.hadoop.yarn.event">
  1038. <!-- start class org.apache.hadoop.yarn.event.AbstractEvent -->
  1039. <class name="AbstractEvent" extends="java.lang.Object"
  1040. abstract="true"
  1041. static="false" final="false" visibility="public"
  1042. deprecated="not deprecated">
  1043. <implements name="org.apache.hadoop.yarn.event.Event"/>
  1044. <constructor name="AbstractEvent" type="TYPE"
  1045. static="false" final="false" visibility="public"
  1046. deprecated="not deprecated">
  1047. </constructor>
  1048. <constructor name="AbstractEvent" type="TYPE, long"
  1049. static="false" final="false" visibility="public"
  1050. deprecated="not deprecated">
  1051. </constructor>
  1052. <method name="getTimestamp" return="long"
  1053. abstract="false" native="false" synchronized="false"
  1054. static="false" final="false" visibility="public"
  1055. deprecated="not deprecated">
  1056. </method>
  1057. <method name="getType" return="TYPE"
  1058. abstract="false" native="false" synchronized="false"
  1059. static="false" final="false" visibility="public"
  1060. deprecated="not deprecated">
  1061. </method>
  1062. <method name="toString" return="java.lang.String"
  1063. abstract="false" native="false" synchronized="false"
  1064. static="false" final="false" visibility="public"
  1065. deprecated="not deprecated">
  1066. </method>
  1067. <doc>
  1068. <![CDATA[Parent class of all the events. All events extend this class.]]>
  1069. </doc>
  1070. </class>
  1071. <!-- end class org.apache.hadoop.yarn.event.AbstractEvent -->
  1072. <!-- start class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  1073. <class name="AsyncDispatcher" extends="org.apache.hadoop.service.AbstractService"
  1074. abstract="false"
  1075. static="false" final="false" visibility="public"
  1076. deprecated="not deprecated">
  1077. <implements name="org.apache.hadoop.yarn.event.Dispatcher"/>
  1078. <constructor name="AsyncDispatcher"
  1079. static="false" final="false" visibility="public"
  1080. deprecated="not deprecated">
  1081. </constructor>
  1082. <constructor name="AsyncDispatcher" type="java.util.concurrent.BlockingQueue"
  1083. static="false" final="false" visibility="public"
  1084. deprecated="not deprecated">
  1085. </constructor>
  1086. <constructor name="AsyncDispatcher" type="java.lang.String"
  1087. static="false" final="false" visibility="public"
  1088. deprecated="not deprecated">
  1089. <doc>
  1090. <![CDATA[Set a name for this dispatcher thread.
  1091. @param dispatcherName name of the dispatcher thread]]>
  1092. </doc>
  1093. </constructor>
  1094. <method name="disableExitOnDispatchException"
  1095. abstract="false" native="false" synchronized="false"
  1096. static="false" final="false" visibility="public"
  1097. deprecated="not deprecated">
  1098. </method>
  1099. <method name="serviceInit"
  1100. abstract="false" native="false" synchronized="false"
  1101. static="false" final="false" visibility="protected"
  1102. deprecated="not deprecated">
  1103. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1104. <exception name="Exception" type="java.lang.Exception"/>
  1105. </method>
  1106. <method name="serviceStart"
  1107. abstract="false" native="false" synchronized="false"
  1108. static="false" final="false" visibility="protected"
  1109. deprecated="not deprecated">
  1110. <exception name="Exception" type="java.lang.Exception"/>
  1111. </method>
  1112. <method name="setDrainEventsOnStop"
  1113. abstract="false" native="false" synchronized="false"
  1114. static="false" final="false" visibility="public"
  1115. deprecated="not deprecated">
  1116. </method>
  1117. <method name="serviceStop"
  1118. abstract="false" native="false" synchronized="false"
  1119. static="false" final="false" visibility="protected"
  1120. deprecated="not deprecated">
  1121. <exception name="Exception" type="java.lang.Exception"/>
  1122. </method>
  1123. <method name="dispatch"
  1124. abstract="false" native="false" synchronized="false"
  1125. static="false" final="false" visibility="protected"
  1126. deprecated="not deprecated">
  1127. <param name="event" type="org.apache.hadoop.yarn.event.Event"/>
  1128. </method>
  1129. <method name="register"
  1130. abstract="false" native="false" synchronized="false"
  1131. static="false" final="false" visibility="public"
  1132. deprecated="not deprecated">
  1133. <param name="eventType" type="java.lang.Class"/>
  1134. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  1135. </method>
  1136. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  1137. abstract="false" native="false" synchronized="false"
  1138. static="false" final="false" visibility="public"
  1139. deprecated="not deprecated">
  1140. </method>
  1141. <method name="isEventThreadWaiting" return="boolean"
  1142. abstract="false" native="false" synchronized="false"
  1143. static="false" final="false" visibility="protected"
  1144. deprecated="not deprecated">
  1145. </method>
  1146. <method name="isDrained" return="boolean"
  1147. abstract="false" native="false" synchronized="false"
  1148. static="false" final="false" visibility="protected"
  1149. deprecated="not deprecated">
  1150. </method>
  1151. <method name="isStopped" return="boolean"
  1152. abstract="false" native="false" synchronized="false"
  1153. static="false" final="false" visibility="protected"
  1154. deprecated="not deprecated">
  1155. </method>
  1156. <field name="eventDispatchers" type="java.util.Map"
  1157. transient="false" volatile="false"
  1158. static="false" final="true" visibility="protected"
  1159. deprecated="not deprecated">
  1160. </field>
  1161. <doc>
  1162. <![CDATA[Dispatches {@link Event}s in a separate thread. Currently only single thread
  1163. does that. Potentially there could be multiple channels for each event type
  1164. class and a thread pool can be used to dispatch the events.]]>
  1165. </doc>
  1166. </class>
  1167. <!-- end class org.apache.hadoop.yarn.event.AsyncDispatcher -->
  1168. <!-- start interface org.apache.hadoop.yarn.event.Dispatcher -->
  1169. <interface name="Dispatcher" abstract="true"
  1170. static="false" final="false" visibility="public"
  1171. deprecated="not deprecated">
  1172. <method name="getEventHandler" return="org.apache.hadoop.yarn.event.EventHandler"
  1173. abstract="true" native="false" synchronized="false"
  1174. static="false" final="false" visibility="public"
  1175. deprecated="not deprecated">
  1176. </method>
  1177. <method name="register"
  1178. abstract="true" native="false" synchronized="false"
  1179. static="false" final="false" visibility="public"
  1180. deprecated="not deprecated">
  1181. <param name="eventType" type="java.lang.Class"/>
  1182. <param name="handler" type="org.apache.hadoop.yarn.event.EventHandler"/>
  1183. </method>
  1184. <doc>
  1185. <![CDATA[Event Dispatcher interface. It dispatches events to registered
  1186. event handlers based on event types.]]>
  1187. </doc>
  1188. </interface>
  1189. <!-- end interface org.apache.hadoop.yarn.event.Dispatcher -->
  1190. <!-- start interface org.apache.hadoop.yarn.event.Event -->
  1191. <interface name="Event" abstract="true"
  1192. static="false" final="false" visibility="public"
  1193. deprecated="not deprecated">
  1194. <method name="getType" return="TYPE"
  1195. abstract="true" native="false" synchronized="false"
  1196. static="false" final="false" visibility="public"
  1197. deprecated="not deprecated">
  1198. </method>
  1199. <method name="getTimestamp" return="long"
  1200. abstract="true" native="false" synchronized="false"
  1201. static="false" final="false" visibility="public"
  1202. deprecated="not deprecated">
  1203. </method>
  1204. <method name="toString" return="java.lang.String"
  1205. abstract="true" native="false" synchronized="false"
  1206. static="false" final="false" visibility="public"
  1207. deprecated="not deprecated">
  1208. </method>
  1209. <doc>
  1210. <![CDATA[Interface defining events api.]]>
  1211. </doc>
  1212. </interface>
  1213. <!-- end interface org.apache.hadoop.yarn.event.Event -->
  1214. <!-- start interface org.apache.hadoop.yarn.event.EventHandler -->
  1215. <interface name="EventHandler" abstract="true"
  1216. static="false" final="false" visibility="public"
  1217. deprecated="not deprecated">
  1218. <method name="handle"
  1219. abstract="true" native="false" synchronized="false"
  1220. static="false" final="false" visibility="public"
  1221. deprecated="not deprecated">
  1222. <param name="event" type="T"/>
  1223. </method>
  1224. <doc>
  1225. <![CDATA[Interface for handling events of type T
  1226. @param <T> parameterized event of type T]]>
  1227. </doc>
  1228. </interface>
  1229. <!-- end interface org.apache.hadoop.yarn.event.EventHandler -->
  1230. </package>
  1231. <package name="org.apache.hadoop.yarn.factories">
  1232. </package>
  1233. <package name="org.apache.hadoop.yarn.factory.providers">
  1234. </package>
  1235. <package name="org.apache.hadoop.yarn.logaggregation">
  1236. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  1237. <class name="AggregatedLogFormat" extends="java.lang.Object"
  1238. abstract="false"
  1239. static="false" final="false" visibility="public"
  1240. deprecated="not deprecated">
  1241. <constructor name="AggregatedLogFormat"
  1242. static="false" final="false" visibility="public"
  1243. deprecated="not deprecated">
  1244. </constructor>
  1245. </class>
  1246. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat -->
  1247. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  1248. <class name="AggregatedLogFormat.LogKey" extends="java.lang.Object"
  1249. abstract="false"
  1250. static="true" final="false" visibility="public"
  1251. deprecated="not deprecated">
  1252. <implements name="org.apache.hadoop.io.Writable"/>
  1253. <constructor name="LogKey"
  1254. static="false" final="false" visibility="public"
  1255. deprecated="not deprecated">
  1256. </constructor>
  1257. <constructor name="LogKey" type="org.apache.hadoop.yarn.api.records.ContainerId"
  1258. static="false" final="false" visibility="public"
  1259. deprecated="not deprecated">
  1260. </constructor>
  1261. <constructor name="LogKey" type="java.lang.String"
  1262. static="false" final="false" visibility="public"
  1263. deprecated="not deprecated">
  1264. </constructor>
  1265. <method name="hashCode" return="int"
  1266. abstract="false" native="false" synchronized="false"
  1267. static="false" final="false" visibility="public"
  1268. deprecated="not deprecated">
  1269. </method>
  1270. <method name="equals" return="boolean"
  1271. abstract="false" native="false" synchronized="false"
  1272. static="false" final="false" visibility="public"
  1273. deprecated="not deprecated">
  1274. <param name="obj" type="java.lang.Object"/>
  1275. </method>
  1276. <method name="toString" return="java.lang.String"
  1277. abstract="false" native="false" synchronized="false"
  1278. static="false" final="false" visibility="public"
  1279. deprecated="not deprecated">
  1280. </method>
  1281. </class>
  1282. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey -->
  1283. <!-- start class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1284. <class name="AggregatedLogFormat.LogReader" extends="java.lang.Object"
  1285. abstract="false"
  1286. static="true" final="false" visibility="public"
  1287. deprecated="not deprecated">
  1288. <constructor name="LogReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path"
  1289. static="false" final="false" visibility="public"
  1290. deprecated="not deprecated">
  1291. <exception name="IOException" type="java.io.IOException"/>
  1292. </constructor>
  1293. <method name="getApplicationOwner" return="java.lang.String"
  1294. abstract="false" native="false" synchronized="false"
  1295. static="false" final="false" visibility="public"
  1296. deprecated="not deprecated">
  1297. <exception name="IOException" type="java.io.IOException"/>
  1298. <doc>
  1299. <![CDATA[Returns the owner of the application.
  1300. @return the application owner.
  1301. @throws IOException if we can not get the application owner.]]>
  1302. </doc>
  1303. </method>
  1304. <method name="getApplicationAcls" return="java.util.Map"
  1305. abstract="false" native="false" synchronized="false"
  1306. static="false" final="false" visibility="public"
  1307. deprecated="not deprecated">
  1308. <exception name="IOException" type="java.io.IOException"/>
  1309. <doc>
  1310. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  1311. found.
  1312. @return a map of the Application ACLs.
  1313. @throws IOException if we can not get the application acls.]]>
  1314. </doc>
  1315. </method>
  1316. <method name="next" return="java.io.DataInputStream"
  1317. abstract="false" native="false" synchronized="false"
  1318. static="false" final="false" visibility="public"
  1319. deprecated="not deprecated">
  1320. <param name="key" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  1321. <exception name="IOException" type="java.io.IOException"/>
  1322. <doc>
  1323. <![CDATA[Read the next key and return the value-stream.
  1324. @param key the log key
  1325. @return the valueStream if there are more keys or null otherwise
  1326. @throws IOException if we can not get the dataInputStream
  1327. for the next key]]>
  1328. </doc>
  1329. </method>
  1330. <method name="readAcontainerLogs"
  1331. abstract="false" native="false" synchronized="false"
  1332. static="true" final="false" visibility="public"
  1333. deprecated="not deprecated">
  1334. <param name="valueStream" type="java.io.DataInputStream"/>
  1335. <param name="writer" type="java.io.Writer"/>
  1336. <param name="logUploadedTime" type="long"/>
  1337. <exception name="IOException" type="java.io.IOException"/>
  1338. <doc>
  1339. <![CDATA[Writes all logs for a single container to the provided writer.
  1340. @param valueStream the valueStream
  1341. @param writer the log writer
  1342. @param logUploadedTime the time stamp
  1343. @throws IOException if we can not read the container logs.]]>
  1344. </doc>
  1345. </method>
  1346. <method name="readAcontainerLogs"
  1347. abstract="false" native="false" synchronized="false"
  1348. static="true" final="false" visibility="public"
  1349. deprecated="not deprecated">
  1350. <param name="valueStream" type="java.io.DataInputStream"/>
  1351. <param name="writer" type="java.io.Writer"/>
  1352. <exception name="IOException" type="java.io.IOException"/>
  1353. <doc>
  1354. <![CDATA[Writes all logs for a single container to the provided writer.
  1355. @param valueStream the value stream
  1356. @param writer the log writer
  1357. @throws IOException if we can not read the container logs.]]>
  1358. </doc>
  1359. </method>
  1360. <method name="readAContainerLogsForALogType"
  1361. abstract="false" native="false" synchronized="false"
  1362. static="true" final="false" visibility="public"
  1363. deprecated="not deprecated">
  1364. <param name="valueStream" type="java.io.DataInputStream"/>
  1365. <param name="out" type="java.io.PrintStream"/>
  1366. <param name="logUploadedTime" type="long"/>
  1367. <exception name="IOException" type="java.io.IOException"/>
  1368. <doc>
  1369. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1370. all types for a single container.
  1371. @param valueStream the value stream
  1372. @param out the print stream
  1373. @param logUploadedTime the time stamp
  1374. @throws IOException if we can not read the container log by specifying
  1375. the container log type.]]>
  1376. </doc>
  1377. </method>
  1378. <method name="readAContainerLogsForALogType"
  1379. abstract="false" native="false" synchronized="false"
  1380. static="true" final="false" visibility="public"
  1381. deprecated="not deprecated">
  1382. <param name="valueStream" type="java.io.DataInputStream"/>
  1383. <param name="out" type="java.io.PrintStream"/>
  1384. <param name="logUploadedTime" type="long"/>
  1385. <param name="bytes" type="long"/>
  1386. <exception name="IOException" type="java.io.IOException"/>
  1387. <doc>
  1388. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1389. all types for a single container for the specific bytes.
  1390. @param valueStream the value stream
  1391. @param out the output print stream
  1392. @param logUploadedTime the log upload time stamp
  1393. @param bytes the output size of the log
  1394. @throws IOException if we can not read the container log]]>
  1395. </doc>
  1396. </method>
  1397. <method name="readAContainerLogsForALogType"
  1398. abstract="false" native="false" synchronized="false"
  1399. static="true" final="false" visibility="public"
  1400. deprecated="not deprecated">
  1401. <param name="valueStream" type="java.io.DataInputStream"/>
  1402. <param name="out" type="java.io.PrintStream"/>
  1403. <exception name="IOException" type="java.io.IOException"/>
  1404. <doc>
  1405. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1406. all types for a single container.
  1407. @param valueStream the value stream
  1408. @param out the output print stream
  1409. @throws IOException if we can not read the container log]]>
  1410. </doc>
  1411. </method>
  1412. <method name="readContainerLogsForALogType" return="int"
  1413. abstract="false" native="false" synchronized="false"
  1414. static="true" final="false" visibility="public"
  1415. deprecated="not deprecated">
  1416. <param name="valueStream" type="java.io.DataInputStream"/>
  1417. <param name="out" type="java.io.PrintStream"/>
  1418. <param name="logUploadedTime" type="long"/>
  1419. <param name="logType" type="java.util.List"/>
  1420. <exception name="IOException" type="java.io.IOException"/>
  1421. <doc>
  1422. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1423. the specific types for a single container.
  1424. @param valueStream the value stream
  1425. @param out the output print stream
  1426. @param logUploadedTime the log uploaded time stamp
  1427. @param logType the given log type
  1428. @throws IOException if we can not read the container logs]]>
  1429. </doc>
  1430. </method>
  1431. <method name="readContainerLogsForALogType" return="int"
  1432. abstract="false" native="false" synchronized="false"
  1433. static="true" final="false" visibility="public"
  1434. deprecated="not deprecated">
  1435. <param name="valueStream" type="java.io.DataInputStream"/>
  1436. <param name="out" type="java.io.PrintStream"/>
  1437. <param name="logUploadedTime" type="long"/>
  1438. <param name="logType" type="java.util.List"/>
  1439. <param name="bytes" type="long"/>
  1440. <exception name="IOException" type="java.io.IOException"/>
  1441. <doc>
  1442. <![CDATA[Keep calling this till you get a {@link EOFException} for getting logs of
  1443. the specific types for a single container.
  1444. @param valueStream the value stream
  1445. @param out the output print stream
  1446. @param logUploadedTime the log uploaded time stamp
  1447. @param logType the given log type
  1448. @throws IOException if we can not read the container logs]]>
  1449. </doc>
  1450. </method>
  1451. <method name="close"
  1452. abstract="false" native="false" synchronized="false"
  1453. static="false" final="false" visibility="public"
  1454. deprecated="not deprecated">
  1455. </method>
  1456. </class>
  1457. <!-- end class org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader -->
  1458. </package>
  1459. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller">
  1460. <!-- start class org.apache.hadoop.yarn.logaggregation.filecontroller.LogAggregationFileController -->
  1461. <class name="LogAggregationFileController" extends="java.lang.Object"
  1462. abstract="true"
  1463. static="false" final="false" visibility="public"
  1464. deprecated="not deprecated">
  1465. <constructor name="LogAggregationFileController"
  1466. static="false" final="false" visibility="public"
  1467. deprecated="not deprecated">
  1468. </constructor>
  1469. <method name="initialize"
  1470. abstract="false" native="false" synchronized="false"
  1471. static="false" final="false" visibility="public"
  1472. deprecated="not deprecated">
  1473. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1474. <param name="controllerName" type="java.lang.String"/>
  1475. <doc>
  1476. <![CDATA[Initialize the log file controller.
  1477. @param conf the Configuration
  1478. @param controllerName the log controller class name]]>
  1479. </doc>
  1480. </method>
  1481. <method name="initInternal"
  1482. abstract="true" native="false" synchronized="false"
  1483. static="false" final="false" visibility="protected"
  1484. deprecated="not deprecated">
  1485. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1486. <doc>
  1487. <![CDATA[Derived classes initialize themselves using this method.
  1488. @param conf the Configuration]]>
  1489. </doc>
  1490. </method>
  1491. <method name="getRemoteRootLogDir" return="org.apache.hadoop.fs.Path"
  1492. abstract="false" native="false" synchronized="false"
  1493. static="false" final="false" visibility="public"
  1494. deprecated="not deprecated">
  1495. <doc>
  1496. <![CDATA[Get the remote root log directory.
  1497. @return the remote root log directory path]]>
  1498. </doc>
  1499. </method>
  1500. <method name="getRemoteRootLogDirSuffix" return="java.lang.String"
  1501. abstract="false" native="false" synchronized="false"
  1502. static="false" final="false" visibility="public"
  1503. deprecated="not deprecated">
  1504. <doc>
  1505. <![CDATA[Get the log aggregation directory suffix.
  1506. @return the log aggregation directory suffix]]>
  1507. </doc>
  1508. </method>
  1509. <method name="initializeWriter"
  1510. abstract="true" native="false" synchronized="false"
  1511. static="false" final="false" visibility="public"
  1512. deprecated="not deprecated">
  1513. <param name="context" type="org.apache.hadoop.yarn.logaggregation.filecontroller.LogAggregationFileControllerContext"/>
  1514. <exception name="IOException" type="java.io.IOException"/>
  1515. <doc>
  1516. <![CDATA[Initialize the writer.
  1517. @param context the {@link LogAggregationFileControllerContext}
  1518. @throws IOException if fails to initialize the writer]]>
  1519. </doc>
  1520. </method>
  1521. <method name="closeWriter"
  1522. abstract="true" native="false" synchronized="false"
  1523. static="false" final="false" visibility="public"
  1524. deprecated="not deprecated">
  1525. <exception name="LogAggregationDFSException" type="org.apache.hadoop.yarn.logaggregation.filecontroller.LogAggregationDFSException"/>
  1526. <doc>
  1527. <![CDATA[Close the writer.
  1528. @throws LogAggregationDFSException if the closing of the writer fails
  1529. (for example due to HDFS quota being exceeded)]]>
  1530. </doc>
  1531. </method>
  1532. <method name="write"
  1533. abstract="true" native="false" synchronized="false"
  1534. static="false" final="false" visibility="public"
  1535. deprecated="not deprecated">
  1536. <param name="logKey" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogKey"/>
  1537. <param name="logValue" type="org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogValue"/>
  1538. <exception name="IOException" type="java.io.IOException"/>
  1539. <doc>
  1540. <![CDATA[Write the log content.
  1541. @param logKey the log key
  1542. @param logValue the log content
  1543. @throws IOException if fails to write the logs]]>
  1544. </doc>
  1545. </method>
  1546. <method name="postWrite"
  1547. abstract="true" native="false" synchronized="false"
  1548. static="false" final="false" visibility="public"
  1549. deprecated="not deprecated">
  1550. <param name="record" type="org.apache.hadoop.yarn.logaggregation.filecontroller.LogAggregationFileControllerContext"/>
  1551. <exception name="Exception" type="java.lang.Exception"/>
  1552. <doc>
  1553. <![CDATA[Operations needed after write the log content.
  1554. @param record the {@link LogAggregationFileControllerContext}
  1555. @throws Exception if anything fails]]>
  1556. </doc>
  1557. </method>
  1558. <method name="closePrintStream"
  1559. abstract="false" native="false" synchronized="false"
  1560. static="false" final="false" visibility="protected"
  1561. deprecated="not deprecated">
  1562. <param name="out" type="java.io.OutputStream"/>
  1563. </method>
  1564. <method name="readAggregatedLogs" return="boolean"
  1565. abstract="true" native="false" synchronized="false"
  1566. static="false" final="false" visibility="public"
  1567. deprecated="not deprecated">
  1568. <param name="logRequest" type="org.apache.hadoop.yarn.logaggregation.ContainerLogsRequest"/>
  1569. <param name="os" type="java.io.OutputStream"/>
  1570. <exception name="IOException" type="java.io.IOException"/>
  1571. <doc>
  1572. <![CDATA[Output container log.
  1573. @param logRequest {@link ContainerLogsRequest}
  1574. @param os the output stream
  1575. @return true if we can read the aggregated logs successfully
  1576. @throws IOException if we can not access the log file.]]>
  1577. </doc>
  1578. </method>
  1579. <method name="readAggregatedLogsMeta" return="java.util.List"
  1580. abstract="true" native="false" synchronized="false"
  1581. static="false" final="false" visibility="public"
  1582. deprecated="not deprecated">
  1583. <param name="logRequest" type="org.apache.hadoop.yarn.logaggregation.ContainerLogsRequest"/>
  1584. <exception name="IOException" type="java.io.IOException"/>
  1585. <doc>
  1586. <![CDATA[Return a list of {@link ContainerLogMeta} for an application
  1587. from Remote FileSystem.
  1588. @param logRequest {@link ContainerLogsRequest}
  1589. @return a list of {@link ContainerLogMeta}
  1590. @throws IOException if there is no available log file]]>
  1591. </doc>
  1592. </method>
  1593. <method name="renderAggregatedLogsBlock"
  1594. abstract="true" native="false" synchronized="false"
  1595. static="false" final="false" visibility="public"
  1596. deprecated="not deprecated">
  1597. <param name="html" type="org.apache.hadoop.yarn.webapp.view.HtmlBlock.Block"/>
  1598. <param name="context" type="org.apache.hadoop.yarn.webapp.View.ViewContext"/>
  1599. <doc>
  1600. <![CDATA[Render Aggregated Logs block.
  1601. @param html the html
  1602. @param context the ViewContext]]>
  1603. </doc>
  1604. </method>
  1605. <method name="getApplicationOwner" return="java.lang.String"
  1606. abstract="true" native="false" synchronized="false"
  1607. static="false" final="false" visibility="public"
  1608. deprecated="not deprecated">
  1609. <param name="aggregatedLogPath" type="org.apache.hadoop.fs.Path"/>
  1610. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1611. <exception name="IOException" type="java.io.IOException"/>
  1612. <doc>
  1613. <![CDATA[Returns the owner of the application.
  1614. @param aggregatedLogPath the aggregatedLog path
  1615. @param appId the ApplicationId
  1616. @return the application owner
  1617. @throws IOException if we can not get the application owner]]>
  1618. </doc>
  1619. </method>
  1620. <method name="getApplicationAcls" return="java.util.Map"
  1621. abstract="true" native="false" synchronized="false"
  1622. static="false" final="false" visibility="public"
  1623. deprecated="not deprecated">
  1624. <param name="aggregatedLogPath" type="org.apache.hadoop.fs.Path"/>
  1625. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1626. <exception name="IOException" type="java.io.IOException"/>
  1627. <doc>
  1628. <![CDATA[Returns ACLs for the application. An empty map is returned if no ACLs are
  1629. found.
  1630. @param aggregatedLogPath the aggregatedLog path.
  1631. @param appId the ApplicationId
  1632. @return a map of the Application ACLs.
  1633. @throws IOException if we can not get the application acls]]>
  1634. </doc>
  1635. </method>
  1636. <method name="verifyAndCreateRemoteLogDir"
  1637. abstract="false" native="false" synchronized="false"
  1638. static="false" final="false" visibility="public"
  1639. deprecated="not deprecated">
  1640. <doc>
  1641. <![CDATA[Verify and create the remote log directory.]]>
  1642. </doc>
  1643. </method>
  1644. <method name="createAppDir"
  1645. abstract="false" native="false" synchronized="false"
  1646. static="false" final="false" visibility="public"
  1647. deprecated="not deprecated">
  1648. <param name="user" type="java.lang.String"/>
  1649. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1650. <param name="userUgi" type="org.apache.hadoop.security.UserGroupInformation"/>
  1651. <doc>
  1652. <![CDATA[Create remote Application directory for log aggregation.
  1653. @param user the user
  1654. @param appId the application ID
  1655. @param userUgi the UGI]]>
  1656. </doc>
  1657. </method>
  1658. <method name="getFileSystem" return="org.apache.hadoop.fs.FileSystem"
  1659. abstract="false" native="false" synchronized="false"
  1660. static="false" final="false" visibility="protected"
  1661. deprecated="not deprecated">
  1662. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1663. <exception name="IOException" type="java.io.IOException"/>
  1664. </method>
  1665. <method name="createDir"
  1666. abstract="false" native="false" synchronized="false"
  1667. static="false" final="false" visibility="protected"
  1668. deprecated="not deprecated">
  1669. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  1670. <param name="path" type="org.apache.hadoop.fs.Path"/>
  1671. <param name="fsPerm" type="org.apache.hadoop.fs.permission.FsPermission"/>
  1672. <exception name="IOException" type="java.io.IOException"/>
  1673. </method>
  1674. <method name="checkExists" return="boolean"
  1675. abstract="false" native="false" synchronized="false"
  1676. static="false" final="false" visibility="protected"
  1677. deprecated="not deprecated">
  1678. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  1679. <param name="path" type="org.apache.hadoop.fs.Path"/>
  1680. <param name="fsPerm" type="org.apache.hadoop.fs.permission.FsPermission"/>
  1681. <exception name="IOException" type="java.io.IOException"/>
  1682. </method>
  1683. <method name="getRemoteNodeLogFileForApp" return="org.apache.hadoop.fs.Path"
  1684. abstract="false" native="false" synchronized="false"
  1685. static="false" final="false" visibility="public"
  1686. deprecated="not deprecated">
  1687. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1688. <param name="user" type="java.lang.String"/>
  1689. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1690. <doc>
  1691. <![CDATA[Get the remote aggregated log path.
  1692. @param appId the ApplicationId
  1693. @param user the Application Owner
  1694. @param nodeId the NodeManager Id
  1695. @return the remote aggregated log path]]>
  1696. </doc>
  1697. </method>
  1698. <method name="getRemoteAppLogDir" return="org.apache.hadoop.fs.Path"
  1699. abstract="false" native="false" synchronized="false"
  1700. static="false" final="false" visibility="public"
  1701. deprecated="not deprecated">
  1702. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  1703. <param name="appOwner" type="java.lang.String"/>
  1704. <exception name="IOException" type="java.io.IOException"/>
  1705. <doc>
  1706. <![CDATA[Get the remote application directory for log aggregation.
  1707. @param appId the Application ID
  1708. @param appOwner the Application Owner
  1709. @return the remote application directory
  1710. @throws IOException if can not find the remote application directory]]>
  1711. </doc>
  1712. </method>
  1713. <method name="cleanOldLogs"
  1714. abstract="false" native="false" synchronized="false"
  1715. static="false" final="false" visibility="protected"
  1716. deprecated="not deprecated">
  1717. <param name="remoteNodeLogFileForApp" type="org.apache.hadoop.fs.Path"/>
  1718. <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
  1719. <param name="userUgi" type="org.apache.hadoop.security.UserGroupInformation"/>
  1720. </method>
  1721. <method name="aggregatedLogSuffix" return="java.lang.String"
  1722. abstract="false" native="false" synchronized="false"
  1723. static="false" final="false" visibility="protected"
  1724. deprecated="not deprecated">
  1725. <param name="fileName" type="java.lang.String"/>
  1726. <doc>
  1727. <![CDATA[Create the aggregated log suffix. The LogAggregationFileController
  1728. should call this to get the suffix and append the suffix to the end
  1729. of each log. This would keep the aggregated log format consistent.
  1730. @param fileName the File Name
  1731. @return the aggregated log suffix String]]>
  1732. </doc>
  1733. </method>
  1734. <method name="isFsSupportsChmod" return="boolean"
  1735. abstract="false" native="false" synchronized="false"
  1736. static="false" final="false" visibility="public"
  1737. deprecated="not deprecated">
  1738. </method>
  1739. <method name="belongsToAppAttempt" return="boolean"
  1740. abstract="false" native="false" synchronized="false"
  1741. static="false" final="false" visibility="protected"
  1742. deprecated="not deprecated">
  1743. <param name="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  1744. <param name="containerIdStr" type="java.lang.String"/>
  1745. </method>
  1746. <field name="TLDIR_PERMISSIONS" type="org.apache.hadoop.fs.permission.FsPermission"
  1747. transient="false" volatile="false"
  1748. static="true" final="true" visibility="protected"
  1749. deprecated="not deprecated">
  1750. <doc>
  1751. <![CDATA[Permissions for the top level directory under which app directories will be
  1752. created.]]>
  1753. </doc>
  1754. </field>
  1755. <field name="APP_DIR_PERMISSIONS" type="org.apache.hadoop.fs.permission.FsPermission"
  1756. transient="false" volatile="false"
  1757. static="true" final="true" visibility="protected"
  1758. deprecated="not deprecated">
  1759. <doc>
  1760. <![CDATA[Permissions for the Application directory.]]>
  1761. </doc>
  1762. </field>
  1763. <field name="APP_LOG_FILE_UMASK" type="org.apache.hadoop.fs.permission.FsPermission"
  1764. transient="false" volatile="false"
  1765. static="true" final="true" visibility="protected"
  1766. deprecated="not deprecated">
  1767. <doc>
  1768. <![CDATA[Umask for the log file.]]>
  1769. </doc>
  1770. </field>
  1771. <field name="LOG_AGGREGATION_FS_SUPPORT_APPEND" type="java.lang.String"
  1772. transient="false" volatile="false"
  1773. static="true" final="true" visibility="public"
  1774. deprecated="not deprecated">
  1775. </field>
  1776. <field name="conf" type="org.apache.hadoop.conf.Configuration"
  1777. transient="false" volatile="false"
  1778. static="false" final="false" visibility="protected"
  1779. deprecated="not deprecated">
  1780. </field>
  1781. <field name="remoteRootLogDir" type="org.apache.hadoop.fs.Path"
  1782. transient="false" volatile="false"
  1783. static="false" final="false" visibility="protected"
  1784. deprecated="not deprecated">
  1785. </field>
  1786. <field name="remoteRootLogDirSuffix" type="java.lang.String"
  1787. transient="false" volatile="false"
  1788. static="false" final="false" visibility="protected"
  1789. deprecated="not deprecated">
  1790. </field>
  1791. <field name="retentionSize" type="int"
  1792. transient="false" volatile="false"
  1793. static="false" final="false" visibility="protected"
  1794. deprecated="not deprecated">
  1795. </field>
  1796. <field name="fileControllerName" type="java.lang.String"
  1797. transient="false" volatile="false"
  1798. static="false" final="false" visibility="protected"
  1799. deprecated="not deprecated">
  1800. </field>
  1801. <field name="fsSupportsChmod" type="boolean"
  1802. transient="false" volatile="false"
  1803. static="false" final="false" visibility="protected"
  1804. deprecated="not deprecated">
  1805. </field>
  1806. <doc>
  1807. <![CDATA[Base class to implement Log Aggregation File Controller.]]>
  1808. </doc>
  1809. </class>
  1810. <!-- end class org.apache.hadoop.yarn.logaggregation.filecontroller.LogAggregationFileController -->
  1811. </package>
  1812. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.ifile">
  1813. </package>
  1814. <package name="org.apache.hadoop.yarn.logaggregation.filecontroller.tfile">
  1815. </package>
  1816. <package name="org.apache.hadoop.yarn.nodelabels">
  1817. </package>
  1818. <package name="org.apache.hadoop.yarn.nodelabels.event">
  1819. </package>
  1820. <package name="org.apache.hadoop.yarn.security">
  1821. <!-- start class org.apache.hadoop.yarn.security.AccessRequest -->
  1822. <class name="AccessRequest" extends="java.lang.Object"
  1823. abstract="false"
  1824. static="false" final="false" visibility="public"
  1825. deprecated="not deprecated">
  1826. <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"
  1827. static="false" final="false" visibility="public"
  1828. deprecated="not deprecated">
  1829. </constructor>
  1830. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1831. abstract="false" native="false" synchronized="false"
  1832. static="false" final="false" visibility="public"
  1833. deprecated="not deprecated">
  1834. </method>
  1835. <method name="getAccessType" return="org.apache.hadoop.yarn.security.AccessType"
  1836. abstract="false" native="false" synchronized="false"
  1837. static="false" final="false" visibility="public"
  1838. deprecated="not deprecated">
  1839. </method>
  1840. <method name="getAppId" return="java.lang.String"
  1841. abstract="false" native="false" synchronized="false"
  1842. static="false" final="false" visibility="public"
  1843. deprecated="not deprecated">
  1844. </method>
  1845. <method name="getAppName" return="java.lang.String"
  1846. abstract="false" native="false" synchronized="false"
  1847. static="false" final="false" visibility="public"
  1848. deprecated="not deprecated">
  1849. </method>
  1850. <method name="getEntity" return="org.apache.hadoop.yarn.security.PrivilegedEntity"
  1851. abstract="false" native="false" synchronized="false"
  1852. static="false" final="false" visibility="public"
  1853. deprecated="not deprecated">
  1854. </method>
  1855. <method name="getForwardedAddresses" return="java.util.List"
  1856. abstract="false" native="false" synchronized="false"
  1857. static="false" final="false" visibility="public"
  1858. deprecated="not deprecated">
  1859. </method>
  1860. <method name="getRemoteAddress" return="java.lang.String"
  1861. abstract="false" native="false" synchronized="false"
  1862. static="false" final="false" visibility="public"
  1863. deprecated="not deprecated">
  1864. </method>
  1865. <doc>
  1866. <![CDATA[This request object contains all the context information to determine whether
  1867. a user has permission to access the target entity.
  1868. user : the user who's currently accessing
  1869. accessType : the access type against the entity.
  1870. entity : the target object user is accessing.
  1871. appId : the associated app Id for current access. This could be null
  1872. if no app is associated.
  1873. appName : the associated app name for current access. This could be null if
  1874. no app is associated.
  1875. remoteAddress : The caller's remote ip address.
  1876. forwardedAddresses : In case this is an http request, this contains the
  1877. originating IP address of a client connecting to a web
  1878. server through an HTTP proxy or load balancer. This
  1879. parameter is null, if it's a RPC request.]]>
  1880. </doc>
  1881. </class>
  1882. <!-- end class org.apache.hadoop.yarn.security.AccessRequest -->
  1883. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1884. <class name="AMRMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  1885. abstract="false"
  1886. static="false" final="false" visibility="public"
  1887. deprecated="not deprecated">
  1888. <constructor name="AMRMTokenIdentifier"
  1889. static="false" final="false" visibility="public"
  1890. deprecated="not deprecated">
  1891. </constructor>
  1892. <constructor name="AMRMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, int"
  1893. static="false" final="false" visibility="public"
  1894. deprecated="not deprecated">
  1895. </constructor>
  1896. <method name="write"
  1897. abstract="false" native="false" synchronized="false"
  1898. static="false" final="false" visibility="public"
  1899. deprecated="not deprecated">
  1900. <param name="out" type="java.io.DataOutput"/>
  1901. <exception name="IOException" type="java.io.IOException"/>
  1902. </method>
  1903. <method name="readFields"
  1904. abstract="false" native="false" synchronized="false"
  1905. static="false" final="false" visibility="public"
  1906. deprecated="not deprecated">
  1907. <param name="in" type="java.io.DataInput"/>
  1908. <exception name="IOException" type="java.io.IOException"/>
  1909. </method>
  1910. <method name="getKind" return="org.apache.hadoop.io.Text"
  1911. abstract="false" native="false" synchronized="false"
  1912. static="false" final="false" visibility="public"
  1913. deprecated="not deprecated">
  1914. </method>
  1915. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  1916. abstract="false" native="false" synchronized="false"
  1917. static="false" final="false" visibility="public"
  1918. deprecated="not deprecated">
  1919. </method>
  1920. <method name="getKeyId" return="int"
  1921. abstract="false" native="false" synchronized="false"
  1922. static="false" final="false" visibility="public"
  1923. deprecated="not deprecated">
  1924. </method>
  1925. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.AMRMTokenIdentifierProto"
  1926. abstract="false" native="false" synchronized="false"
  1927. static="false" final="false" visibility="public"
  1928. deprecated="not deprecated">
  1929. </method>
  1930. <method name="hashCode" return="int"
  1931. abstract="false" native="false" synchronized="false"
  1932. static="false" final="false" visibility="public"
  1933. deprecated="not deprecated">
  1934. </method>
  1935. <method name="equals" return="boolean"
  1936. abstract="false" native="false" synchronized="false"
  1937. static="false" final="false" visibility="public"
  1938. deprecated="not deprecated">
  1939. <param name="other" type="java.lang.Object"/>
  1940. </method>
  1941. <method name="toString" return="java.lang.String"
  1942. abstract="false" native="false" synchronized="false"
  1943. static="false" final="false" visibility="public"
  1944. deprecated="not deprecated">
  1945. </method>
  1946. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  1947. transient="false" volatile="false"
  1948. static="true" final="true" visibility="public"
  1949. deprecated="not deprecated">
  1950. </field>
  1951. <doc>
  1952. <![CDATA[AMRMTokenIdentifier is the TokenIdentifier to be used by
  1953. ApplicationMasters to authenticate to the ResourceManager.]]>
  1954. </doc>
  1955. </class>
  1956. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenIdentifier -->
  1957. <!-- start class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1958. <class name="AMRMTokenSelector" extends="java.lang.Object"
  1959. abstract="false"
  1960. static="false" final="false" visibility="public"
  1961. deprecated="not deprecated">
  1962. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  1963. <constructor name="AMRMTokenSelector"
  1964. static="false" final="false" visibility="public"
  1965. deprecated="not deprecated">
  1966. </constructor>
  1967. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  1968. abstract="false" native="false" synchronized="false"
  1969. static="false" final="false" visibility="public"
  1970. deprecated="not deprecated">
  1971. <param name="service" type="org.apache.hadoop.io.Text"/>
  1972. <param name="tokens" type="java.util.Collection"/>
  1973. </method>
  1974. </class>
  1975. <!-- end class org.apache.hadoop.yarn.security.AMRMTokenSelector -->
  1976. <!-- start class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  1977. <class name="ContainerManagerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  1978. abstract="false"
  1979. static="false" final="false" visibility="public"
  1980. deprecated="not deprecated">
  1981. <constructor name="ContainerManagerSecurityInfo"
  1982. static="false" final="false" visibility="public"
  1983. deprecated="not deprecated">
  1984. </constructor>
  1985. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  1986. abstract="false" native="false" synchronized="false"
  1987. static="false" final="false" visibility="public"
  1988. deprecated="not deprecated">
  1989. <param name="protocol" type="java.lang.Class"/>
  1990. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1991. </method>
  1992. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  1993. abstract="false" native="false" synchronized="false"
  1994. static="false" final="false" visibility="public"
  1995. deprecated="not deprecated">
  1996. <param name="protocol" type="java.lang.Class"/>
  1997. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  1998. </method>
  1999. </class>
  2000. <!-- end class org.apache.hadoop.yarn.security.ContainerManagerSecurityInfo -->
  2001. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  2002. <class name="ContainerTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  2003. abstract="false"
  2004. static="false" final="false" visibility="public"
  2005. deprecated="not deprecated">
  2006. <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"
  2007. static="false" final="false" visibility="public"
  2008. deprecated="not deprecated">
  2009. </constructor>
  2010. <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"
  2011. static="false" final="false" visibility="public"
  2012. deprecated="Use one of the other constructors instead.">
  2013. <doc>
  2014. <![CDATA[Creates a instance.
  2015. @param appSubmitter appSubmitter
  2016. @param containerID container ID
  2017. @param creationTime creation time
  2018. @param expiryTimeStamp expiry timestamp
  2019. @param hostName hostname
  2020. @param logAggregationContext log aggregation context
  2021. @param masterKeyId master key ID
  2022. @param priority priority
  2023. @param r resource needed by the container
  2024. @param rmIdentifier ResourceManager identifier
  2025. @deprecated Use one of the other constructors instead.]]>
  2026. </doc>
  2027. </constructor>
  2028. <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"
  2029. static="false" final="false" visibility="public"
  2030. deprecated="not deprecated">
  2031. </constructor>
  2032. <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"
  2033. static="false" final="false" visibility="public"
  2034. deprecated="not deprecated">
  2035. </constructor>
  2036. <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"
  2037. static="false" final="false" visibility="public"
  2038. deprecated="not deprecated">
  2039. </constructor>
  2040. <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"
  2041. static="false" final="false" visibility="public"
  2042. deprecated="not deprecated">
  2043. <doc>
  2044. <![CDATA[Convenience Constructor for existing clients.
  2045. @param containerID containerID
  2046. @param containerVersion containerVersion
  2047. @param hostName hostName
  2048. @param appSubmitter appSubmitter
  2049. @param r resource
  2050. @param expiryTimeStamp expiryTimeStamp
  2051. @param masterKeyId masterKeyId
  2052. @param rmIdentifier rmIdentifier
  2053. @param priority priority
  2054. @param creationTime creationTime
  2055. @param logAggregationContext logAggregationContext
  2056. @param nodeLabelExpression nodeLabelExpression
  2057. @param containerType containerType
  2058. @param executionType executionType
  2059. @param allocationRequestId allocationRequestId]]>
  2060. </doc>
  2061. </constructor>
  2062. <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"
  2063. static="false" final="false" visibility="public"
  2064. deprecated="not deprecated">
  2065. <doc>
  2066. <![CDATA[Create a Container Token Identifier.
  2067. @param containerID containerID
  2068. @param containerVersion containerVersion
  2069. @param hostName hostName
  2070. @param appSubmitter appSubmitter
  2071. @param r resource
  2072. @param expiryTimeStamp expiryTimeStamp
  2073. @param masterKeyId masterKeyId
  2074. @param rmIdentifier rmIdentifier
  2075. @param priority priority
  2076. @param creationTime creationTime
  2077. @param logAggregationContext logAggregationContext
  2078. @param nodeLabelExpression nodeLabelExpression
  2079. @param containerType containerType
  2080. @param executionType executionType
  2081. @param allocationRequestId allocationRequestId
  2082. @param allocationTags Set of allocation Tags.]]>
  2083. </doc>
  2084. </constructor>
  2085. <constructor name="ContainerTokenIdentifier"
  2086. static="false" final="false" visibility="public"
  2087. deprecated="not deprecated">
  2088. <doc>
  2089. <![CDATA[Default constructor needed by RPC layer/SecretManager.]]>
  2090. </doc>
  2091. </constructor>
  2092. <method name="getContainerID" return="org.apache.hadoop.yarn.api.records.ContainerId"
  2093. abstract="false" native="false" synchronized="false"
  2094. static="false" final="false" visibility="public"
  2095. deprecated="not deprecated">
  2096. </method>
  2097. <method name="getApplicationSubmitter" return="java.lang.String"
  2098. abstract="false" native="false" synchronized="false"
  2099. static="false" final="false" visibility="public"
  2100. deprecated="not deprecated">
  2101. </method>
  2102. <method name="getNmHostAddress" return="java.lang.String"
  2103. abstract="false" native="false" synchronized="false"
  2104. static="false" final="false" visibility="public"
  2105. deprecated="not deprecated">
  2106. </method>
  2107. <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
  2108. abstract="false" native="false" synchronized="false"
  2109. static="false" final="false" visibility="public"
  2110. deprecated="not deprecated">
  2111. </method>
  2112. <method name="getExpiryTimeStamp" return="long"
  2113. abstract="false" native="false" synchronized="false"
  2114. static="false" final="false" visibility="public"
  2115. deprecated="not deprecated">
  2116. </method>
  2117. <method name="getMasterKeyId" return="int"
  2118. abstract="false" native="false" synchronized="false"
  2119. static="false" final="false" visibility="public"
  2120. deprecated="not deprecated">
  2121. </method>
  2122. <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
  2123. abstract="false" native="false" synchronized="false"
  2124. static="false" final="false" visibility="public"
  2125. deprecated="not deprecated">
  2126. </method>
  2127. <method name="getCreationTime" return="long"
  2128. abstract="false" native="false" synchronized="false"
  2129. static="false" final="false" visibility="public"
  2130. deprecated="not deprecated">
  2131. </method>
  2132. <method name="getRMIdentifier" return="long"
  2133. abstract="false" native="false" synchronized="false"
  2134. static="false" final="false" visibility="public"
  2135. deprecated="not deprecated">
  2136. <doc>
  2137. <![CDATA[Get the RMIdentifier of RM in which containers are allocated.
  2138. @return RMIdentifier]]>
  2139. </doc>
  2140. </method>
  2141. <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
  2142. abstract="false" native="false" synchronized="false"
  2143. static="false" final="false" visibility="public"
  2144. deprecated="not deprecated">
  2145. <doc>
  2146. <![CDATA[Get the ContainerType of container to allocate.
  2147. @return ContainerType]]>
  2148. </doc>
  2149. </method>
  2150. <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
  2151. abstract="false" native="false" synchronized="false"
  2152. static="false" final="false" visibility="public"
  2153. deprecated="not deprecated">
  2154. <doc>
  2155. <![CDATA[Get the ExecutionType of container to allocate
  2156. @return ExecutionType]]>
  2157. </doc>
  2158. </method>
  2159. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ContainerTokenIdentifierProto"
  2160. abstract="false" native="false" synchronized="false"
  2161. static="false" final="false" visibility="public"
  2162. deprecated="not deprecated">
  2163. </method>
  2164. <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
  2165. abstract="false" native="false" synchronized="false"
  2166. static="false" final="false" visibility="public"
  2167. deprecated="not deprecated">
  2168. </method>
  2169. <method name="getAllocationRequestId" return="long"
  2170. abstract="false" native="false" synchronized="false"
  2171. static="false" final="false" visibility="public"
  2172. deprecated="not deprecated">
  2173. </method>
  2174. <method name="write"
  2175. abstract="false" native="false" synchronized="false"
  2176. static="false" final="false" visibility="public"
  2177. deprecated="not deprecated">
  2178. <param name="out" type="java.io.DataOutput"/>
  2179. <exception name="IOException" type="java.io.IOException"/>
  2180. </method>
  2181. <method name="readFields"
  2182. abstract="false" native="false" synchronized="false"
  2183. static="false" final="false" visibility="public"
  2184. deprecated="not deprecated">
  2185. <param name="in" type="java.io.DataInput"/>
  2186. <exception name="IOException" type="java.io.IOException"/>
  2187. </method>
  2188. <method name="getKind" return="org.apache.hadoop.io.Text"
  2189. abstract="false" native="false" synchronized="false"
  2190. static="false" final="false" visibility="public"
  2191. deprecated="not deprecated">
  2192. </method>
  2193. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  2194. abstract="false" native="false" synchronized="false"
  2195. static="false" final="false" visibility="public"
  2196. deprecated="not deprecated">
  2197. </method>
  2198. <method name="getVersion" return="int"
  2199. abstract="false" native="false" synchronized="false"
  2200. static="false" final="false" visibility="public"
  2201. deprecated="not deprecated">
  2202. <doc>
  2203. <![CDATA[Get the Container version
  2204. @return container version]]>
  2205. </doc>
  2206. </method>
  2207. <method name="getNodeLabelExpression" return="java.lang.String"
  2208. abstract="false" native="false" synchronized="false"
  2209. static="false" final="false" visibility="public"
  2210. deprecated="not deprecated">
  2211. <doc>
  2212. <![CDATA[Get the node-label-expression in the original ResourceRequest]]>
  2213. </doc>
  2214. </method>
  2215. <method name="getAllcationTags" return="java.util.Set"
  2216. abstract="false" native="false" synchronized="false"
  2217. static="false" final="false" visibility="public"
  2218. deprecated="not deprecated">
  2219. </method>
  2220. <method name="hashCode" return="int"
  2221. abstract="false" native="false" synchronized="false"
  2222. static="false" final="false" visibility="public"
  2223. deprecated="not deprecated">
  2224. </method>
  2225. <method name="equals" return="boolean"
  2226. abstract="false" native="false" synchronized="false"
  2227. static="false" final="false" visibility="public"
  2228. deprecated="not deprecated">
  2229. <param name="other" type="java.lang.Object"/>
  2230. </method>
  2231. <method name="toString" return="java.lang.String"
  2232. abstract="false" native="false" synchronized="false"
  2233. static="false" final="false" visibility="public"
  2234. deprecated="not deprecated">
  2235. </method>
  2236. <field name="KIND" type="org.apache.hadoop.io.Text"
  2237. transient="false" volatile="false"
  2238. static="true" final="true" visibility="public"
  2239. deprecated="not deprecated">
  2240. </field>
  2241. <doc>
  2242. <![CDATA[TokenIdentifier for a container. Encodes {@link ContainerId},
  2243. {@link Resource} needed by the container and the target NMs host-address.]]>
  2244. </doc>
  2245. </class>
  2246. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenIdentifier -->
  2247. <!-- start class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  2248. <class name="ContainerTokenSelector" extends="java.lang.Object"
  2249. abstract="false"
  2250. static="false" final="false" visibility="public"
  2251. deprecated="not deprecated">
  2252. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2253. <constructor name="ContainerTokenSelector"
  2254. static="false" final="false" visibility="public"
  2255. deprecated="not deprecated">
  2256. </constructor>
  2257. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2258. abstract="false" native="false" synchronized="false"
  2259. static="false" final="false" visibility="public"
  2260. deprecated="not deprecated">
  2261. <param name="service" type="org.apache.hadoop.io.Text"/>
  2262. <param name="tokens" type="java.util.Collection"/>
  2263. </method>
  2264. </class>
  2265. <!-- end class org.apache.hadoop.yarn.security.ContainerTokenSelector -->
  2266. <!-- start class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  2267. <class name="NMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  2268. abstract="false"
  2269. static="false" final="false" visibility="public"
  2270. deprecated="not deprecated">
  2271. <constructor name="NMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, org.apache.hadoop.yarn.api.records.NodeId, java.lang.String, int"
  2272. static="false" final="false" visibility="public"
  2273. deprecated="not deprecated">
  2274. </constructor>
  2275. <constructor name="NMTokenIdentifier"
  2276. static="false" final="false" visibility="public"
  2277. deprecated="not deprecated">
  2278. <doc>
  2279. <![CDATA[Default constructor needed by RPC/Secret manager]]>
  2280. </doc>
  2281. </constructor>
  2282. <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2283. abstract="false" native="false" synchronized="false"
  2284. static="false" final="false" visibility="public"
  2285. deprecated="not deprecated">
  2286. </method>
  2287. <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  2288. abstract="false" native="false" synchronized="false"
  2289. static="false" final="false" visibility="public"
  2290. deprecated="not deprecated">
  2291. </method>
  2292. <method name="getApplicationSubmitter" return="java.lang.String"
  2293. abstract="false" native="false" synchronized="false"
  2294. static="false" final="false" visibility="public"
  2295. deprecated="not deprecated">
  2296. </method>
  2297. <method name="getKeyId" return="int"
  2298. abstract="false" native="false" synchronized="false"
  2299. static="false" final="false" visibility="public"
  2300. deprecated="not deprecated">
  2301. </method>
  2302. <method name="write"
  2303. abstract="false" native="false" synchronized="false"
  2304. static="false" final="false" visibility="public"
  2305. deprecated="not deprecated">
  2306. <param name="out" type="java.io.DataOutput"/>
  2307. <exception name="IOException" type="java.io.IOException"/>
  2308. </method>
  2309. <method name="readFields"
  2310. abstract="false" native="false" synchronized="false"
  2311. static="false" final="false" visibility="public"
  2312. deprecated="not deprecated">
  2313. <param name="in" type="java.io.DataInput"/>
  2314. <exception name="IOException" type="java.io.IOException"/>
  2315. </method>
  2316. <method name="getKind" return="org.apache.hadoop.io.Text"
  2317. abstract="false" native="false" synchronized="false"
  2318. static="false" final="false" visibility="public"
  2319. deprecated="not deprecated">
  2320. </method>
  2321. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  2322. abstract="false" native="false" synchronized="false"
  2323. static="false" final="false" visibility="public"
  2324. deprecated="not deprecated">
  2325. </method>
  2326. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.NMTokenIdentifierProto"
  2327. abstract="false" native="false" synchronized="false"
  2328. static="false" final="false" visibility="public"
  2329. deprecated="not deprecated">
  2330. </method>
  2331. <method name="hashCode" return="int"
  2332. abstract="false" native="false" synchronized="false"
  2333. static="false" final="false" visibility="public"
  2334. deprecated="not deprecated">
  2335. </method>
  2336. <method name="equals" return="boolean"
  2337. abstract="false" native="false" synchronized="false"
  2338. static="false" final="false" visibility="public"
  2339. deprecated="not deprecated">
  2340. <param name="other" type="java.lang.Object"/>
  2341. </method>
  2342. <method name="toString" return="java.lang.String"
  2343. abstract="false" native="false" synchronized="false"
  2344. static="false" final="false" visibility="public"
  2345. deprecated="not deprecated">
  2346. </method>
  2347. <field name="KIND" type="org.apache.hadoop.io.Text"
  2348. transient="false" volatile="false"
  2349. static="true" final="true" visibility="public"
  2350. deprecated="not deprecated">
  2351. </field>
  2352. </class>
  2353. <!-- end class org.apache.hadoop.yarn.security.NMTokenIdentifier -->
  2354. <!-- start class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  2355. <class name="SchedulerSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2356. abstract="false"
  2357. static="false" final="false" visibility="public"
  2358. deprecated="not deprecated">
  2359. <constructor name="SchedulerSecurityInfo"
  2360. static="false" final="false" visibility="public"
  2361. deprecated="not deprecated">
  2362. </constructor>
  2363. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2364. abstract="false" native="false" synchronized="false"
  2365. static="false" final="false" visibility="public"
  2366. deprecated="not deprecated">
  2367. <param name="protocol" type="java.lang.Class"/>
  2368. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2369. </method>
  2370. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2371. abstract="false" native="false" synchronized="false"
  2372. static="false" final="false" visibility="public"
  2373. deprecated="not deprecated">
  2374. <param name="protocol" type="java.lang.Class"/>
  2375. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2376. </method>
  2377. </class>
  2378. <!-- end class org.apache.hadoop.yarn.security.SchedulerSecurityInfo -->
  2379. </package>
  2380. <package name="org.apache.hadoop.yarn.security.admin">
  2381. <!-- start class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2382. <class name="AdminSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2383. abstract="false"
  2384. static="false" final="false" visibility="public"
  2385. deprecated="not deprecated">
  2386. <constructor name="AdminSecurityInfo"
  2387. static="false" final="false" visibility="public"
  2388. deprecated="not deprecated">
  2389. </constructor>
  2390. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2391. abstract="false" native="false" synchronized="false"
  2392. static="false" final="false" visibility="public"
  2393. deprecated="not deprecated">
  2394. <param name="protocol" type="java.lang.Class"/>
  2395. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2396. </method>
  2397. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2398. abstract="false" native="false" synchronized="false"
  2399. static="false" final="false" visibility="public"
  2400. deprecated="not deprecated">
  2401. <param name="protocol" type="java.lang.Class"/>
  2402. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2403. </method>
  2404. </class>
  2405. <!-- end class org.apache.hadoop.yarn.security.admin.AdminSecurityInfo -->
  2406. </package>
  2407. <package name="org.apache.hadoop.yarn.security.client">
  2408. <!-- start class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2409. <class name="BaseClientToAMTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
  2410. abstract="true"
  2411. static="false" final="false" visibility="public"
  2412. deprecated="not deprecated">
  2413. <constructor name="BaseClientToAMTokenSecretManager"
  2414. static="false" final="false" visibility="public"
  2415. deprecated="not deprecated">
  2416. </constructor>
  2417. <doc>
  2418. <![CDATA[A base {@link SecretManager} for AMs to extend and validate Client-RM tokens
  2419. issued to clients by the RM using the underlying master-key shared by RM to
  2420. the AMs on their launch. All the methods are called by either Hadoop RPC or
  2421. YARN, so this class is strictly for the purpose of inherit/extend and
  2422. register with Hadoop RPC.]]>
  2423. </doc>
  2424. </class>
  2425. <!-- end class org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager -->
  2426. <!-- start class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2427. <class name="ClientRMSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2428. abstract="false"
  2429. static="false" final="false" visibility="public"
  2430. deprecated="not deprecated">
  2431. <constructor name="ClientRMSecurityInfo"
  2432. static="false" final="false" visibility="public"
  2433. deprecated="not deprecated">
  2434. </constructor>
  2435. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2436. abstract="false" native="false" synchronized="false"
  2437. static="false" final="false" visibility="public"
  2438. deprecated="not deprecated">
  2439. <param name="protocol" type="java.lang.Class"/>
  2440. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2441. </method>
  2442. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2443. abstract="false" native="false" synchronized="false"
  2444. static="false" final="false" visibility="public"
  2445. deprecated="not deprecated">
  2446. <param name="protocol" type="java.lang.Class"/>
  2447. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2448. </method>
  2449. </class>
  2450. <!-- end class org.apache.hadoop.yarn.security.client.ClientRMSecurityInfo -->
  2451. <!-- start class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2452. <class name="ClientTimelineSecurityInfo" extends="org.apache.hadoop.security.SecurityInfo"
  2453. abstract="false"
  2454. static="false" final="false" visibility="public"
  2455. deprecated="not deprecated">
  2456. <constructor name="ClientTimelineSecurityInfo"
  2457. static="false" final="false" visibility="public"
  2458. deprecated="not deprecated">
  2459. </constructor>
  2460. <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
  2461. abstract="false" native="false" synchronized="false"
  2462. static="false" final="false" visibility="public"
  2463. deprecated="not deprecated">
  2464. <param name="protocol" type="java.lang.Class"/>
  2465. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2466. </method>
  2467. <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
  2468. abstract="false" native="false" synchronized="false"
  2469. static="false" final="false" visibility="public"
  2470. deprecated="not deprecated">
  2471. <param name="protocol" type="java.lang.Class"/>
  2472. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2473. </method>
  2474. </class>
  2475. <!-- end class org.apache.hadoop.yarn.security.client.ClientTimelineSecurityInfo -->
  2476. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2477. <class name="ClientToAMTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
  2478. abstract="false"
  2479. static="false" final="false" visibility="public"
  2480. deprecated="not deprecated">
  2481. <constructor name="ClientToAMTokenIdentifier"
  2482. static="false" final="false" visibility="public"
  2483. deprecated="not deprecated">
  2484. </constructor>
  2485. <constructor name="ClientToAMTokenIdentifier" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, java.lang.String"
  2486. static="false" final="false" visibility="public"
  2487. deprecated="not deprecated">
  2488. </constructor>
  2489. <method name="getApplicationAttemptID" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  2490. abstract="false" native="false" synchronized="false"
  2491. static="false" final="false" visibility="public"
  2492. deprecated="not deprecated">
  2493. </method>
  2494. <method name="getClientName" return="java.lang.String"
  2495. abstract="false" native="false" synchronized="false"
  2496. static="false" final="false" visibility="public"
  2497. deprecated="not deprecated">
  2498. </method>
  2499. <method name="getProto" return="org.apache.hadoop.yarn.proto.YarnSecurityTokenProtos.ClientToAMTokenIdentifierProto"
  2500. abstract="false" native="false" synchronized="false"
  2501. static="false" final="false" visibility="public"
  2502. deprecated="not deprecated">
  2503. </method>
  2504. <method name="write"
  2505. abstract="false" native="false" synchronized="false"
  2506. static="false" final="false" visibility="public"
  2507. deprecated="not deprecated">
  2508. <param name="out" type="java.io.DataOutput"/>
  2509. <exception name="IOException" type="java.io.IOException"/>
  2510. </method>
  2511. <method name="readFields"
  2512. abstract="false" native="false" synchronized="false"
  2513. static="false" final="false" visibility="public"
  2514. deprecated="not deprecated">
  2515. <param name="in" type="java.io.DataInput"/>
  2516. <exception name="IOException" type="java.io.IOException"/>
  2517. </method>
  2518. <method name="getKind" return="org.apache.hadoop.io.Text"
  2519. abstract="false" native="false" synchronized="false"
  2520. static="false" final="false" visibility="public"
  2521. deprecated="not deprecated">
  2522. </method>
  2523. <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
  2524. abstract="false" native="false" synchronized="false"
  2525. static="false" final="false" visibility="public"
  2526. deprecated="not deprecated">
  2527. </method>
  2528. <method name="hashCode" return="int"
  2529. abstract="false" native="false" synchronized="false"
  2530. static="false" final="false" visibility="public"
  2531. deprecated="not deprecated">
  2532. </method>
  2533. <method name="equals" return="boolean"
  2534. abstract="false" native="false" synchronized="false"
  2535. static="false" final="false" visibility="public"
  2536. deprecated="not deprecated">
  2537. <param name="other" type="java.lang.Object"/>
  2538. </method>
  2539. <method name="toString" return="java.lang.String"
  2540. abstract="false" native="false" synchronized="false"
  2541. static="false" final="false" visibility="public"
  2542. deprecated="not deprecated">
  2543. </method>
  2544. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2545. transient="false" volatile="false"
  2546. static="true" final="true" visibility="public"
  2547. deprecated="not deprecated">
  2548. </field>
  2549. </class>
  2550. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier -->
  2551. <!-- start class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2552. <class name="ClientToAMTokenSecretManager" extends="org.apache.hadoop.yarn.security.client.BaseClientToAMTokenSecretManager"
  2553. abstract="false"
  2554. static="false" final="false" visibility="public"
  2555. deprecated="not deprecated">
  2556. <constructor name="ClientToAMTokenSecretManager" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId, byte[]"
  2557. static="false" final="false" visibility="public"
  2558. deprecated="not deprecated">
  2559. </constructor>
  2560. <method name="retrievePassword" return="byte[]"
  2561. abstract="false" native="false" synchronized="false"
  2562. static="false" final="false" visibility="public"
  2563. deprecated="not deprecated">
  2564. <param name="identifier" type="org.apache.hadoop.yarn.security.client.ClientToAMTokenIdentifier"/>
  2565. <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
  2566. </method>
  2567. <method name="getMasterKey" return="javax.crypto.SecretKey"
  2568. abstract="false" native="false" synchronized="false"
  2569. static="false" final="false" visibility="public"
  2570. deprecated="not deprecated">
  2571. <param name="applicationAttemptID" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
  2572. </method>
  2573. <method name="setMasterKey"
  2574. abstract="false" native="false" synchronized="false"
  2575. static="false" final="false" visibility="public"
  2576. deprecated="not deprecated">
  2577. <param name="key" type="byte[]"/>
  2578. </method>
  2579. <doc>
  2580. <![CDATA[A simple {@link SecretManager} for AMs to validate Client-RM tokens issued to
  2581. clients by the RM using the underlying master-key shared by RM to the AMs on
  2582. their launch. All the methods are called by either Hadoop RPC or YARN, so
  2583. this class is strictly for the purpose of inherit/extend and register with
  2584. Hadoop RPC.]]>
  2585. </doc>
  2586. </class>
  2587. <!-- end class org.apache.hadoop.yarn.security.client.ClientToAMTokenSecretManager -->
  2588. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2589. <class name="RMDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2590. abstract="false"
  2591. static="false" final="false" visibility="public"
  2592. deprecated="not deprecated">
  2593. <constructor name="RMDelegationTokenIdentifier"
  2594. static="false" final="false" visibility="public"
  2595. deprecated="not deprecated">
  2596. </constructor>
  2597. <constructor name="RMDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2598. static="false" final="false" visibility="public"
  2599. deprecated="not deprecated">
  2600. <doc>
  2601. <![CDATA[Create a new delegation token identifier
  2602. @param owner the effective username of the token owner
  2603. @param renewer the username of the renewer
  2604. @param realUser the real username of the token owner]]>
  2605. </doc>
  2606. </constructor>
  2607. <method name="getKind" return="org.apache.hadoop.io.Text"
  2608. abstract="false" native="false" synchronized="false"
  2609. static="false" final="false" visibility="public"
  2610. deprecated="not deprecated">
  2611. </method>
  2612. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2613. transient="false" volatile="false"
  2614. static="true" final="true" visibility="public"
  2615. deprecated="not deprecated">
  2616. </field>
  2617. <doc>
  2618. <![CDATA[Delegation Token Identifier that identifies the delegation tokens from the
  2619. Resource Manager.]]>
  2620. </doc>
  2621. </class>
  2622. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier -->
  2623. <!-- start class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2624. <class name="RMDelegationTokenSelector" extends="java.lang.Object"
  2625. abstract="false"
  2626. static="false" final="false" visibility="public"
  2627. deprecated="not deprecated">
  2628. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2629. <constructor name="RMDelegationTokenSelector"
  2630. static="false" final="false" visibility="public"
  2631. deprecated="not deprecated">
  2632. </constructor>
  2633. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2634. abstract="false" native="false" synchronized="false"
  2635. static="false" final="false" visibility="public"
  2636. deprecated="not deprecated">
  2637. <param name="service" type="org.apache.hadoop.io.Text"/>
  2638. <param name="tokens" type="java.util.Collection"/>
  2639. </method>
  2640. </class>
  2641. <!-- end class org.apache.hadoop.yarn.security.client.RMDelegationTokenSelector -->
  2642. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2643. <class name="TimelineDelegationTokenIdentifier" extends="org.apache.hadoop.yarn.security.client.YARNDelegationTokenIdentifier"
  2644. abstract="false"
  2645. static="false" final="false" visibility="public"
  2646. deprecated="not deprecated">
  2647. <constructor name="TimelineDelegationTokenIdentifier"
  2648. static="false" final="false" visibility="public"
  2649. deprecated="not deprecated">
  2650. </constructor>
  2651. <constructor name="TimelineDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
  2652. static="false" final="false" visibility="public"
  2653. deprecated="not deprecated">
  2654. <doc>
  2655. <![CDATA[Create a new timeline delegation token identifier
  2656. @param owner the effective username of the token owner
  2657. @param renewer the username of the renewer
  2658. @param realUser the real username of the token owner]]>
  2659. </doc>
  2660. </constructor>
  2661. <method name="getKind" return="org.apache.hadoop.io.Text"
  2662. abstract="false" native="false" synchronized="false"
  2663. static="false" final="false" visibility="public"
  2664. deprecated="not deprecated">
  2665. </method>
  2666. <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
  2667. transient="false" volatile="false"
  2668. static="true" final="true" visibility="public"
  2669. deprecated="not deprecated">
  2670. </field>
  2671. </class>
  2672. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier -->
  2673. <!-- start class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2674. <class name="TimelineDelegationTokenSelector" extends="java.lang.Object"
  2675. abstract="false"
  2676. static="false" final="false" visibility="public"
  2677. deprecated="not deprecated">
  2678. <implements name="org.apache.hadoop.security.token.TokenSelector"/>
  2679. <constructor name="TimelineDelegationTokenSelector"
  2680. static="false" final="false" visibility="public"
  2681. deprecated="not deprecated">
  2682. </constructor>
  2683. <method name="selectToken" return="org.apache.hadoop.security.token.Token"
  2684. abstract="false" native="false" synchronized="false"
  2685. static="false" final="false" visibility="public"
  2686. deprecated="not deprecated">
  2687. <param name="service" type="org.apache.hadoop.io.Text"/>
  2688. <param name="tokens" type="java.util.Collection"/>
  2689. </method>
  2690. </class>
  2691. <!-- end class org.apache.hadoop.yarn.security.client.TimelineDelegationTokenSelector -->
  2692. </package>
  2693. <package name="org.apache.hadoop.yarn.server.api">
  2694. </package>
  2695. <package name="org.apache.hadoop.yarn.server.api.impl.pb.client">
  2696. </package>
  2697. <package name="org.apache.hadoop.yarn.server.api.impl.pb.service">
  2698. </package>
  2699. <package name="org.apache.hadoop.yarn.sharedcache">
  2700. <!-- start interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2701. <interface name="SharedCacheChecksum" abstract="true"
  2702. static="false" final="false" visibility="public"
  2703. deprecated="not deprecated">
  2704. <method name="computeChecksum" return="java.lang.String"
  2705. abstract="true" native="false" synchronized="false"
  2706. static="false" final="false" visibility="public"
  2707. deprecated="not deprecated">
  2708. <param name="in" type="java.io.InputStream"/>
  2709. <exception name="IOException" type="java.io.IOException"/>
  2710. <doc>
  2711. <![CDATA[Calculate the checksum of the passed input stream.
  2712. @param in <code>InputStream</code> to be checksumed
  2713. @return the message digest of the input stream
  2714. @throws IOException]]>
  2715. </doc>
  2716. </method>
  2717. </interface>
  2718. <!-- end interface org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum -->
  2719. <!-- start class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2720. <class name="SharedCacheChecksumFactory" extends="java.lang.Object"
  2721. abstract="false"
  2722. static="false" final="false" visibility="public"
  2723. deprecated="not deprecated">
  2724. <constructor name="SharedCacheChecksumFactory"
  2725. static="false" final="false" visibility="public"
  2726. deprecated="not deprecated">
  2727. </constructor>
  2728. <method name="getChecksum" return="org.apache.hadoop.yarn.sharedcache.SharedCacheChecksum"
  2729. abstract="false" native="false" synchronized="false"
  2730. static="true" final="false" visibility="public"
  2731. deprecated="not deprecated">
  2732. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  2733. <doc>
  2734. <![CDATA[Get a new <code>SharedCacheChecksum</code> object based on the configurable
  2735. algorithm implementation
  2736. (see <code>yarn.sharedcache.checksum.algo.impl</code>)
  2737. @return <code>SharedCacheChecksum</code> object]]>
  2738. </doc>
  2739. </method>
  2740. </class>
  2741. <!-- end class org.apache.hadoop.yarn.sharedcache.SharedCacheChecksumFactory -->
  2742. </package>
  2743. <package name="org.apache.hadoop.yarn.state">
  2744. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2745. <class name="InvalidStateTransitionException" extends="org.apache.hadoop.yarn.state.InvalidStateTransitonException"
  2746. abstract="false"
  2747. static="false" final="false" visibility="public"
  2748. deprecated="not deprecated">
  2749. <constructor name="InvalidStateTransitionException" type="java.lang.Enum, java.lang.Enum"
  2750. static="false" final="false" visibility="public"
  2751. deprecated="not deprecated">
  2752. </constructor>
  2753. <doc>
  2754. <![CDATA[The exception that happens when you call invalid state transition.]]>
  2755. </doc>
  2756. </class>
  2757. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitionException -->
  2758. <!-- start class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2759. <class name="InvalidStateTransitonException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
  2760. abstract="false"
  2761. static="false" final="false" visibility="public"
  2762. deprecated="Use {@link InvalidStateTransitionException} instead.">
  2763. <constructor name="InvalidStateTransitonException" type="java.lang.Enum, java.lang.Enum"
  2764. static="false" final="false" visibility="public"
  2765. deprecated="not deprecated">
  2766. </constructor>
  2767. <method name="getCurrentState" return="java.lang.Enum"
  2768. abstract="false" native="false" synchronized="false"
  2769. static="false" final="false" visibility="public"
  2770. deprecated="not deprecated">
  2771. </method>
  2772. <method name="getEvent" return="java.lang.Enum"
  2773. abstract="false" native="false" synchronized="false"
  2774. static="false" final="false" visibility="public"
  2775. deprecated="not deprecated">
  2776. </method>
  2777. <doc>
  2778. <![CDATA[@deprecated Use {@link InvalidStateTransitionException} instead.]]>
  2779. </doc>
  2780. </class>
  2781. <!-- end class org.apache.hadoop.yarn.state.InvalidStateTransitonException -->
  2782. <!-- start interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2783. <interface name="MultipleArcTransition" abstract="true"
  2784. static="false" final="false" visibility="public"
  2785. deprecated="not deprecated">
  2786. <method name="transition" return="STATE"
  2787. abstract="true" native="false" synchronized="false"
  2788. static="false" final="false" visibility="public"
  2789. deprecated="not deprecated">
  2790. <param name="operand" type="OPERAND"/>
  2791. <param name="event" type="EVENT"/>
  2792. <doc>
  2793. <![CDATA[Transition hook.
  2794. @return the postState. Post state must be one of the
  2795. valid post states registered in StateMachine.
  2796. @param operand the entity attached to the FSM, whose internal
  2797. state may change.
  2798. @param event causal event]]>
  2799. </doc>
  2800. </method>
  2801. <doc>
  2802. <![CDATA[Hook for Transition.
  2803. Post state is decided by Transition hook. Post state must be one of the
  2804. valid post states registered in StateMachine.]]>
  2805. </doc>
  2806. </interface>
  2807. <!-- end interface org.apache.hadoop.yarn.state.MultipleArcTransition -->
  2808. <!-- start interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2809. <interface name="SingleArcTransition" abstract="true"
  2810. static="false" final="false" visibility="public"
  2811. deprecated="not deprecated">
  2812. <method name="transition"
  2813. abstract="true" native="false" synchronized="false"
  2814. static="false" final="false" visibility="public"
  2815. deprecated="not deprecated">
  2816. <param name="operand" type="OPERAND"/>
  2817. <param name="event" type="EVENT"/>
  2818. <doc>
  2819. <![CDATA[Transition hook.
  2820. @param operand the entity attached to the FSM, whose internal
  2821. state may change.
  2822. @param event causal event]]>
  2823. </doc>
  2824. </method>
  2825. <doc>
  2826. <![CDATA[Hook for Transition. This lead to state machine to move to
  2827. the post state as registered in the state machine.]]>
  2828. </doc>
  2829. </interface>
  2830. <!-- end interface org.apache.hadoop.yarn.state.SingleArcTransition -->
  2831. <!-- start interface org.apache.hadoop.yarn.state.StateMachine -->
  2832. <interface name="StateMachine" abstract="true"
  2833. static="false" final="false" visibility="public"
  2834. deprecated="not deprecated">
  2835. <method name="getCurrentState" return="STATE"
  2836. abstract="true" native="false" synchronized="false"
  2837. static="false" final="false" visibility="public"
  2838. deprecated="not deprecated">
  2839. </method>
  2840. <method name="doTransition" return="STATE"
  2841. abstract="true" native="false" synchronized="false"
  2842. static="false" final="false" visibility="public"
  2843. deprecated="not deprecated">
  2844. <param name="eventType" type="EVENTTYPE"/>
  2845. <param name="event" type="EVENT"/>
  2846. <exception name="InvalidStateTransitionException" type="org.apache.hadoop.yarn.state.InvalidStateTransitionException"/>
  2847. </method>
  2848. </interface>
  2849. <!-- end interface org.apache.hadoop.yarn.state.StateMachine -->
  2850. <!-- start class org.apache.hadoop.yarn.state.StateMachineFactory -->
  2851. <class name="StateMachineFactory" extends="java.lang.Object"
  2852. abstract="false"
  2853. static="false" final="true" visibility="public"
  2854. deprecated="not deprecated">
  2855. <constructor name="StateMachineFactory" type="STATE"
  2856. static="false" final="false" visibility="public"
  2857. deprecated="not deprecated">
  2858. <doc>
  2859. <![CDATA[Constructor
  2860. This is the only constructor in the API.]]>
  2861. </doc>
  2862. </constructor>
  2863. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2864. abstract="false" native="false" synchronized="false"
  2865. static="false" final="false" visibility="public"
  2866. deprecated="not deprecated">
  2867. <param name="preState" type="STATE"/>
  2868. <param name="postState" type="STATE"/>
  2869. <param name="eventType" type="EVENTTYPE"/>
  2870. <doc>
  2871. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2872. transition added as a new legal transition. This overload
  2873. has no hook object.
  2874. Note that the returned StateMachineFactory is a distinct
  2875. object.
  2876. This method is part of the API.
  2877. @param preState pre-transition state
  2878. @param postState post-transition state
  2879. @param eventType stimulus for the transition]]>
  2880. </doc>
  2881. </method>
  2882. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2883. abstract="false" native="false" synchronized="false"
  2884. static="false" final="false" visibility="public"
  2885. deprecated="not deprecated">
  2886. <param name="preState" type="STATE"/>
  2887. <param name="postState" type="STATE"/>
  2888. <param name="eventTypes" type="java.util.Set"/>
  2889. <doc>
  2890. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2891. transition added as a new legal transition. This overload
  2892. has no hook object.
  2893. Note that the returned StateMachineFactory is a distinct
  2894. object.
  2895. This method is part of the API.
  2896. @param preState pre-transition state
  2897. @param postState post-transition state
  2898. @param eventTypes List of stimuli for the transitions]]>
  2899. </doc>
  2900. </method>
  2901. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2902. abstract="false" native="false" synchronized="false"
  2903. static="false" final="false" visibility="public"
  2904. deprecated="not deprecated">
  2905. <param name="preState" type="STATE"/>
  2906. <param name="postState" type="STATE"/>
  2907. <param name="eventTypes" type="java.util.Set"/>
  2908. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2909. <doc>
  2910. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2911. transition added as a new legal transition
  2912. Note that the returned StateMachineFactory is a distinct
  2913. object.
  2914. This method is part of the API.
  2915. @param preState pre-transition state
  2916. @param postState post-transition state
  2917. @param eventTypes List of stimuli for the transitions
  2918. @param hook transition hook]]>
  2919. </doc>
  2920. </method>
  2921. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2922. abstract="false" native="false" synchronized="false"
  2923. static="false" final="false" visibility="public"
  2924. deprecated="not deprecated">
  2925. <param name="preState" type="STATE"/>
  2926. <param name="postState" type="STATE"/>
  2927. <param name="eventType" type="EVENTTYPE"/>
  2928. <param name="hook" type="org.apache.hadoop.yarn.state.SingleArcTransition"/>
  2929. <doc>
  2930. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2931. transition added as a new legal transition
  2932. Note that the returned StateMachineFactory is a distinct object.
  2933. This method is part of the API.
  2934. @param preState pre-transition state
  2935. @param postState post-transition state
  2936. @param eventType stimulus for the transition
  2937. @param hook transition hook]]>
  2938. </doc>
  2939. </method>
  2940. <method name="addTransition" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2941. abstract="false" native="false" synchronized="false"
  2942. static="false" final="false" visibility="public"
  2943. deprecated="not deprecated">
  2944. <param name="preState" type="STATE"/>
  2945. <param name="postStates" type="java.util.Set"/>
  2946. <param name="eventType" type="EVENTTYPE"/>
  2947. <param name="hook" type="org.apache.hadoop.yarn.state.MultipleArcTransition"/>
  2948. <doc>
  2949. <![CDATA[@return a NEW StateMachineFactory just like {@code this} with the current
  2950. transition added as a new legal transition
  2951. Note that the returned StateMachineFactory is a distinct object.
  2952. This method is part of the API.
  2953. @param preState pre-transition state
  2954. @param postStates valid post-transition states
  2955. @param eventType stimulus for the transition
  2956. @param hook transition hook]]>
  2957. </doc>
  2958. </method>
  2959. <method name="installTopology" return="org.apache.hadoop.yarn.state.StateMachineFactory"
  2960. abstract="false" native="false" synchronized="false"
  2961. static="false" final="false" visibility="public"
  2962. deprecated="not deprecated">
  2963. <doc>
  2964. <![CDATA[@return a StateMachineFactory just like {@code this}, except that if
  2965. you won't need any synchronization to build a state machine
  2966. Note that the returned StateMachineFactory is a distinct object.
  2967. This method is part of the API.
  2968. The only way you could distinguish the returned
  2969. StateMachineFactory from {@code this} would be by
  2970. measuring the performance of the derived
  2971. {@code StateMachine} you can get from it.
  2972. Calling this is optional. It doesn't change the semantics of the factory,
  2973. if you call it then when you use the factory there is no synchronization.]]>
  2974. </doc>
  2975. </method>
  2976. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2977. abstract="false" native="false" synchronized="false"
  2978. static="false" final="false" visibility="public"
  2979. deprecated="not deprecated">
  2980. <param name="operand" type="OPERAND"/>
  2981. <param name="initialState" type="STATE"/>
  2982. <param name="listener" type="org.apache.hadoop.yarn.state.StateTransitionListener"/>
  2983. <doc>
  2984. <![CDATA[A StateMachine that accepts a transition listener.
  2985. @param operand the object upon which the returned
  2986. {@link StateMachine} will operate.
  2987. @param initialState the state in which the returned
  2988. {@link StateMachine} will start.
  2989. @param listener An implementation of a {@link StateTransitionListener}.
  2990. @return A (@link StateMachine}.]]>
  2991. </doc>
  2992. </method>
  2993. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  2994. abstract="false" native="false" synchronized="false"
  2995. static="false" final="false" visibility="public"
  2996. deprecated="not deprecated">
  2997. <param name="operand" type="OPERAND"/>
  2998. <param name="initialState" type="STATE"/>
  2999. </method>
  3000. <method name="make" return="org.apache.hadoop.yarn.state.StateMachine"
  3001. abstract="false" native="false" synchronized="false"
  3002. static="false" final="false" visibility="public"
  3003. deprecated="not deprecated">
  3004. <param name="operand" type="OPERAND"/>
  3005. </method>
  3006. <method name="generateStateGraph" return="org.apache.hadoop.yarn.state.Graph"
  3007. abstract="false" native="false" synchronized="false"
  3008. static="false" final="false" visibility="public"
  3009. deprecated="not deprecated">
  3010. <param name="name" type="java.lang.String"/>
  3011. <doc>
  3012. <![CDATA[Generate a graph represents the state graph of this StateMachine
  3013. @param name graph name
  3014. @return Graph object generated]]>
  3015. </doc>
  3016. </method>
  3017. <doc>
  3018. <![CDATA[State machine topology.
  3019. This object is semantically immutable. If you have a
  3020. StateMachineFactory there's no operation in the API that changes
  3021. its semantic properties.
  3022. @param <OPERAND> The object type on which this state machine operates.
  3023. @param <STATE> The state of the entity.
  3024. @param <EVENTTYPE> The external eventType to be handled.
  3025. @param <EVENT> The event object.]]>
  3026. </doc>
  3027. </class>
  3028. <!-- end class org.apache.hadoop.yarn.state.StateMachineFactory -->
  3029. <!-- start interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  3030. <interface name="StateTransitionListener" abstract="true"
  3031. static="false" final="false" visibility="public"
  3032. deprecated="not deprecated">
  3033. <method name="preTransition"
  3034. abstract="true" native="false" synchronized="false"
  3035. static="false" final="false" visibility="public"
  3036. deprecated="not deprecated">
  3037. <param name="op" type="OPERAND"/>
  3038. <param name="beforeState" type="STATE"/>
  3039. <param name="eventToBeProcessed" type="EVENT"/>
  3040. <doc>
  3041. <![CDATA[Pre Transition Hook. This will be called before transition.
  3042. @param op Operand.
  3043. @param beforeState State before transition.
  3044. @param eventToBeProcessed Incoming Event.]]>
  3045. </doc>
  3046. </method>
  3047. <method name="postTransition"
  3048. abstract="true" native="false" synchronized="false"
  3049. static="false" final="false" visibility="public"
  3050. deprecated="not deprecated">
  3051. <param name="op" type="OPERAND"/>
  3052. <param name="beforeState" type="STATE"/>
  3053. <param name="afterState" type="STATE"/>
  3054. <param name="processedEvent" type="EVENT"/>
  3055. <doc>
  3056. <![CDATA[Post Transition Hook. This will be called after the transition.
  3057. @param op Operand.
  3058. @param beforeState State before transition.
  3059. @param afterState State after transition.
  3060. @param processedEvent Processed Event.]]>
  3061. </doc>
  3062. </method>
  3063. <doc>
  3064. <![CDATA[A State Transition Listener.
  3065. It exposes a pre and post transition hook called before and
  3066. after the transition.]]>
  3067. </doc>
  3068. </interface>
  3069. <!-- end interface org.apache.hadoop.yarn.state.StateTransitionListener -->
  3070. </package>
  3071. <package name="org.apache.hadoop.yarn.util">
  3072. <!-- start class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  3073. <class name="AbstractLivelinessMonitor" extends="org.apache.hadoop.service.AbstractService"
  3074. abstract="true"
  3075. static="false" final="false" visibility="public"
  3076. deprecated="not deprecated">
  3077. <constructor name="AbstractLivelinessMonitor" type="java.lang.String, org.apache.hadoop.yarn.util.Clock"
  3078. static="false" final="false" visibility="public"
  3079. deprecated="not deprecated">
  3080. </constructor>
  3081. <constructor name="AbstractLivelinessMonitor" type="java.lang.String"
  3082. static="false" final="false" visibility="public"
  3083. deprecated="not deprecated">
  3084. </constructor>
  3085. <method name="serviceStart"
  3086. abstract="false" native="false" synchronized="false"
  3087. static="false" final="false" visibility="protected"
  3088. deprecated="not deprecated">
  3089. <exception name="Exception" type="java.lang.Exception"/>
  3090. </method>
  3091. <method name="serviceStop"
  3092. abstract="false" native="false" synchronized="false"
  3093. static="false" final="false" visibility="protected"
  3094. deprecated="not deprecated">
  3095. <exception name="Exception" type="java.lang.Exception"/>
  3096. </method>
  3097. <method name="expire"
  3098. abstract="true" native="false" synchronized="false"
  3099. static="false" final="false" visibility="protected"
  3100. deprecated="not deprecated">
  3101. <param name="ob" type="O"/>
  3102. </method>
  3103. <method name="setExpireInterval"
  3104. abstract="false" native="false" synchronized="false"
  3105. static="false" final="false" visibility="protected"
  3106. deprecated="not deprecated">
  3107. <param name="expireInterval" type="int"/>
  3108. </method>
  3109. <method name="getExpireInterval" return="long"
  3110. abstract="false" native="false" synchronized="false"
  3111. static="false" final="false" visibility="protected"
  3112. deprecated="not deprecated">
  3113. <param name="o" type="O"/>
  3114. </method>
  3115. <method name="setMonitorInterval"
  3116. abstract="false" native="false" synchronized="false"
  3117. static="false" final="false" visibility="protected"
  3118. deprecated="not deprecated">
  3119. <param name="monitorInterval" type="long"/>
  3120. </method>
  3121. <method name="receivedPing"
  3122. abstract="false" native="false" synchronized="true"
  3123. static="false" final="false" visibility="public"
  3124. deprecated="not deprecated">
  3125. <param name="ob" type="O"/>
  3126. </method>
  3127. <method name="register"
  3128. abstract="false" native="false" synchronized="true"
  3129. static="false" final="false" visibility="public"
  3130. deprecated="not deprecated">
  3131. <param name="ob" type="O"/>
  3132. </method>
  3133. <method name="register"
  3134. abstract="false" native="false" synchronized="true"
  3135. static="false" final="false" visibility="public"
  3136. deprecated="not deprecated">
  3137. <param name="ob" type="O"/>
  3138. <param name="expireTime" type="long"/>
  3139. </method>
  3140. <method name="unregister"
  3141. abstract="false" native="false" synchronized="true"
  3142. static="false" final="false" visibility="public"
  3143. deprecated="not deprecated">
  3144. <param name="ob" type="O"/>
  3145. </method>
  3146. <method name="resetTimer"
  3147. abstract="false" native="false" synchronized="true"
  3148. static="false" final="false" visibility="public"
  3149. deprecated="not deprecated">
  3150. </method>
  3151. <method name="setResetTimeOnStart"
  3152. abstract="false" native="false" synchronized="false"
  3153. static="false" final="false" visibility="protected"
  3154. deprecated="not deprecated">
  3155. <param name="resetTimeOnStart" type="boolean"/>
  3156. </method>
  3157. <field name="DEFAULT_EXPIRE" type="int"
  3158. transient="false" volatile="false"
  3159. static="true" final="true" visibility="public"
  3160. deprecated="not deprecated">
  3161. </field>
  3162. <doc>
  3163. <![CDATA[A simple liveliness monitor with which clients can register, trust the
  3164. component to monitor liveliness, get a call-back on expiry and then finally
  3165. unregister.]]>
  3166. </doc>
  3167. </class>
  3168. <!-- end class org.apache.hadoop.yarn.util.AbstractLivelinessMonitor -->
  3169. <!-- start class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  3170. <class name="ApplicationClassLoader" extends="org.apache.hadoop.util.ApplicationClassLoader"
  3171. abstract="false"
  3172. static="false" final="false" visibility="public"
  3173. deprecated="not deprecated">
  3174. <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
  3175. static="false" final="false" visibility="public"
  3176. deprecated="not deprecated">
  3177. </constructor>
  3178. <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
  3179. static="false" final="false" visibility="public"
  3180. deprecated="not deprecated">
  3181. <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
  3182. </constructor>
  3183. <doc>
  3184. <![CDATA[This type has been deprecated in favor of
  3185. {@link org.apache.hadoop.util.ApplicationClassLoader}. All new uses of
  3186. ApplicationClassLoader should use that type instead.]]>
  3187. </doc>
  3188. </class>
  3189. <!-- end class org.apache.hadoop.yarn.util.ApplicationClassLoader -->
  3190. <!-- start class org.apache.hadoop.yarn.util.BoundedAppender -->
  3191. <class name="BoundedAppender" extends="java.lang.Object"
  3192. abstract="false"
  3193. static="false" final="false" visibility="public"
  3194. deprecated="not deprecated">
  3195. <constructor name="BoundedAppender" type="int"
  3196. static="false" final="false" visibility="public"
  3197. deprecated="not deprecated">
  3198. </constructor>
  3199. <method name="append" return="org.apache.hadoop.yarn.util.BoundedAppender"
  3200. abstract="false" native="false" synchronized="false"
  3201. static="false" final="false" visibility="public"
  3202. deprecated="not deprecated">
  3203. <param name="csq" type="java.lang.CharSequence"/>
  3204. <doc>
  3205. <![CDATA[Append a {@link CharSequence} considering {@link #limit}, truncating
  3206. from the head of {@code csq} or {@link #messages} when necessary.
  3207. @param csq the {@link CharSequence} to append
  3208. @return this]]>
  3209. </doc>
  3210. </method>
  3211. <method name="length" return="int"
  3212. abstract="false" native="false" synchronized="false"
  3213. static="false" final="false" visibility="public"
  3214. deprecated="not deprecated">
  3215. <doc>
  3216. <![CDATA[Get current length of messages considering truncates
  3217. without header and ellipses.
  3218. @return current length]]>
  3219. </doc>
  3220. </method>
  3221. <method name="getLimit" return="int"
  3222. abstract="false" native="false" synchronized="false"
  3223. static="false" final="false" visibility="public"
  3224. deprecated="not deprecated">
  3225. </method>
  3226. <method name="toString" return="java.lang.String"
  3227. abstract="false" native="false" synchronized="false"
  3228. static="false" final="false" visibility="public"
  3229. deprecated="not deprecated">
  3230. <doc>
  3231. <![CDATA[Get a string representation of the actual contents, displaying also a
  3232. header and ellipses when there was a truncate.
  3233. @return String representation of the {@link #messages}]]>
  3234. </doc>
  3235. </method>
  3236. <field name="TRUNCATED_MESSAGES_TEMPLATE" type="java.lang.String"
  3237. transient="false" volatile="false"
  3238. static="true" final="true" visibility="public"
  3239. deprecated="not deprecated">
  3240. </field>
  3241. <doc>
  3242. <![CDATA[A {@link CharSequence} appender that considers its {@link #limit} as upper
  3243. bound.
  3244. <p>
  3245. When {@link #limit} would be reached on append, past messages will be
  3246. truncated from head, and a header telling the user about truncation will be
  3247. prepended, with ellipses in between header and messages.
  3248. <p>
  3249. Note that header and ellipses are not counted against {@link #limit}.
  3250. <p>
  3251. An example:
  3252. <pre>
  3253. {@code
  3254. // At the beginning it's an empty string
  3255. final Appendable shortAppender = new BoundedAppender(80);
  3256. // The whole message fits into limit
  3257. shortAppender.append(
  3258. "message1 this is a very long message but fitting into limit\n");
  3259. // The first message is truncated, the second not
  3260. shortAppender.append("message2 this is shorter than the previous one\n");
  3261. // The first message is deleted, the second truncated, the third
  3262. // preserved
  3263. shortAppender.append("message3 this is even shorter message, maybe.\n");
  3264. // The first two are deleted, the third one truncated, the last preserved
  3265. shortAppender.append("message4 the shortest one, yet the greatest :)");
  3266. // Current contents are like this:
  3267. // Diagnostic messages truncated, showing last 80 chars out of 199:
  3268. // ...s is even shorter message, maybe.
  3269. // message4 the shortest one, yet the greatest :)
  3270. }
  3271. </pre>
  3272. <p>
  3273. Note that <tt>null</tt> values are {@link #append(CharSequence) append}ed
  3274. just like in {@link StringBuilder#append(CharSequence) original
  3275. implementation}.
  3276. <p>
  3277. Note that this class is not thread safe.]]>
  3278. </doc>
  3279. </class>
  3280. <!-- end class org.apache.hadoop.yarn.util.BoundedAppender -->
  3281. <!-- start interface org.apache.hadoop.yarn.util.Clock -->
  3282. <interface name="Clock" abstract="true"
  3283. static="false" final="false" visibility="public"
  3284. deprecated="not deprecated">
  3285. <method name="getTime" return="long"
  3286. abstract="true" native="false" synchronized="false"
  3287. static="false" final="false" visibility="public"
  3288. deprecated="not deprecated">
  3289. </method>
  3290. <doc>
  3291. <![CDATA[A simple clock interface that gives you time.]]>
  3292. </doc>
  3293. </interface>
  3294. <!-- end interface org.apache.hadoop.yarn.util.Clock -->
  3295. <!-- start class org.apache.hadoop.yarn.util.ConverterUtils -->
  3296. <class name="ConverterUtils" extends="java.lang.Object"
  3297. abstract="false"
  3298. static="false" final="false" visibility="public"
  3299. deprecated="not deprecated">
  3300. <constructor name="ConverterUtils"
  3301. static="false" final="false" visibility="public"
  3302. deprecated="not deprecated">
  3303. </constructor>
  3304. <method name="getPathFromYarnURL" return="org.apache.hadoop.fs.Path"
  3305. abstract="false" native="false" synchronized="false"
  3306. static="true" final="false" visibility="public"
  3307. deprecated="not deprecated">
  3308. <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
  3309. <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
  3310. <doc>
  3311. <![CDATA[return a hadoop path from a given url
  3312. This method is deprecated, use {@link URL#toPath()} instead.
  3313. @param url
  3314. url to convert
  3315. @return path from {@link URL}
  3316. @throws URISyntaxException]]>
  3317. </doc>
  3318. </method>
  3319. <method name="getYarnUrlFromPath" return="org.apache.hadoop.yarn.api.records.URL"
  3320. abstract="false" native="false" synchronized="false"
  3321. static="true" final="false" visibility="public"
  3322. deprecated="not deprecated">
  3323. <param name="path" type="org.apache.hadoop.fs.Path"/>
  3324. </method>
  3325. <method name="getYarnUrlFromURI" return="org.apache.hadoop.yarn.api.records.URL"
  3326. abstract="false" native="false" synchronized="false"
  3327. static="true" final="false" visibility="public"
  3328. deprecated="not deprecated">
  3329. <param name="uri" type="java.net.URI"/>
  3330. </method>
  3331. <method name="toString" return="java.lang.String"
  3332. abstract="false" native="false" synchronized="false"
  3333. static="true" final="false" visibility="public"
  3334. deprecated="not deprecated">
  3335. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3336. </method>
  3337. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3338. abstract="false" native="false" synchronized="false"
  3339. static="true" final="false" visibility="public"
  3340. deprecated="not deprecated">
  3341. <param name="recordFactory" type="org.apache.hadoop.yarn.factories.RecordFactory"/>
  3342. <param name="applicationIdStr" type="java.lang.String"/>
  3343. </method>
  3344. <method name="toString" return="java.lang.String"
  3345. abstract="false" native="false" synchronized="false"
  3346. static="true" final="false" visibility="public"
  3347. deprecated="not deprecated">
  3348. <param name="cId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
  3349. </method>
  3350. <method name="toNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
  3351. abstract="false" native="false" synchronized="false"
  3352. static="true" final="false" visibility="public"
  3353. deprecated="not deprecated">
  3354. <param name="nodeIdStr" type="java.lang.String"/>
  3355. </method>
  3356. <method name="toContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
  3357. abstract="false" native="false" synchronized="false"
  3358. static="true" final="false" visibility="public"
  3359. deprecated="not deprecated">
  3360. <param name="containerIdStr" type="java.lang.String"/>
  3361. </method>
  3362. <method name="toApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
  3363. abstract="false" native="false" synchronized="false"
  3364. static="true" final="false" visibility="public"
  3365. deprecated="not deprecated">
  3366. <param name="applicationAttemptIdStr" type="java.lang.String"/>
  3367. </method>
  3368. <method name="toApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
  3369. abstract="false" native="false" synchronized="false"
  3370. static="true" final="false" visibility="public"
  3371. deprecated="not deprecated">
  3372. <param name="appIdStr" type="java.lang.String"/>
  3373. </method>
  3374. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  3375. abstract="false" native="false" synchronized="false"
  3376. static="true" final="false" visibility="public"
  3377. deprecated="not deprecated">
  3378. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  3379. <param name="serviceAddr" type="java.net.InetSocketAddress"/>
  3380. <doc>
  3381. <![CDATA[Convert a protobuf token into a rpc token and set its service. Supposed
  3382. to be used for tokens other than RMDelegationToken. For
  3383. RMDelegationToken, use
  3384. {@link #convertFromYarn(org.apache.hadoop.yarn.api.records.Token,
  3385. org.apache.hadoop.io.Text)} instead.
  3386. @param protoToken the yarn token
  3387. @param serviceAddr the connect address for the service
  3388. @return rpc token]]>
  3389. </doc>
  3390. </method>
  3391. <method name="convertFromYarn" return="org.apache.hadoop.security.token.Token"
  3392. abstract="false" native="false" synchronized="false"
  3393. static="true" final="false" visibility="public"
  3394. deprecated="not deprecated">
  3395. <param name="protoToken" type="org.apache.hadoop.yarn.api.records.Token"/>
  3396. <param name="service" type="org.apache.hadoop.io.Text"/>
  3397. <doc>
  3398. <![CDATA[Convert a protobuf token into a rpc token and set its service.
  3399. @param protoToken the yarn token
  3400. @param service the service for the token]]>
  3401. </doc>
  3402. </method>
  3403. <field name="APPLICATION_PREFIX" type="java.lang.String"
  3404. transient="false" volatile="false"
  3405. static="true" final="true" visibility="public"
  3406. deprecated="not deprecated">
  3407. </field>
  3408. <field name="CONTAINER_PREFIX" type="java.lang.String"
  3409. transient="false" volatile="false"
  3410. static="true" final="true" visibility="public"
  3411. deprecated="not deprecated">
  3412. </field>
  3413. <field name="APPLICATION_ATTEMPT_PREFIX" type="java.lang.String"
  3414. transient="false" volatile="false"
  3415. static="true" final="true" visibility="public"
  3416. deprecated="not deprecated">
  3417. </field>
  3418. <doc>
  3419. <![CDATA[This class contains a set of utilities which help converting data structures
  3420. from/to 'serializableFormat' to/from hadoop/nativejava data structures.]]>
  3421. </doc>
  3422. </class>
  3423. <!-- end class org.apache.hadoop.yarn.util.ConverterUtils -->
  3424. <!-- start class org.apache.hadoop.yarn.util.MonotonicClock -->
  3425. <class name="MonotonicClock" extends="java.lang.Object"
  3426. abstract="false"
  3427. static="false" final="false" visibility="public"
  3428. deprecated="not deprecated">
  3429. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3430. <constructor name="MonotonicClock"
  3431. static="false" final="false" visibility="public"
  3432. deprecated="not deprecated">
  3433. </constructor>
  3434. <method name="getTime" return="long"
  3435. abstract="false" native="false" synchronized="false"
  3436. static="false" final="false" visibility="public"
  3437. deprecated="not deprecated">
  3438. <doc>
  3439. <![CDATA[Get current time from some arbitrary time base in the past, counting in
  3440. milliseconds, and not affected by settimeofday or similar system clock
  3441. changes.
  3442. @return a monotonic clock that counts in milliseconds.]]>
  3443. </doc>
  3444. </method>
  3445. <doc>
  3446. <![CDATA[A monotonic clock from some arbitrary time base in the past, counting in
  3447. milliseconds, and not affected by settimeofday or similar system clock
  3448. changes.
  3449. This is appropriate to use when computing how much longer to wait for an
  3450. interval to expire.
  3451. This function can return a negative value and it must be handled correctly
  3452. by callers. See the documentation of System#nanoTime for caveats.]]>
  3453. </doc>
  3454. </class>
  3455. <!-- end class org.apache.hadoop.yarn.util.MonotonicClock -->
  3456. <!-- start class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3457. <class name="ResourceCalculatorProcessTree" extends="org.apache.hadoop.conf.Configured"
  3458. abstract="true"
  3459. static="false" final="false" visibility="public"
  3460. deprecated="not deprecated">
  3461. <constructor name="ResourceCalculatorProcessTree" type="java.lang.String"
  3462. static="false" final="false" visibility="public"
  3463. deprecated="not deprecated">
  3464. <doc>
  3465. <![CDATA[Create process-tree instance with specified root process.
  3466. Subclass must override this.
  3467. @param root process-tree root-process]]>
  3468. </doc>
  3469. </constructor>
  3470. <method name="initialize"
  3471. abstract="false" native="false" synchronized="false"
  3472. static="false" final="false" visibility="public"
  3473. deprecated="not deprecated">
  3474. <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
  3475. <doc>
  3476. <![CDATA[Initialize the object.
  3477. @throws YarnException Throws an exception on error.]]>
  3478. </doc>
  3479. </method>
  3480. <method name="updateProcessTree"
  3481. abstract="true" native="false" synchronized="false"
  3482. static="false" final="false" visibility="public"
  3483. deprecated="not deprecated">
  3484. <doc>
  3485. <![CDATA[Update the process-tree with latest state.
  3486. Each call to this function should increment the age of the running
  3487. processes that already exist in the process tree. Age is used other API's
  3488. of the interface.]]>
  3489. </doc>
  3490. </method>
  3491. <method name="getProcessTreeDump" return="java.lang.String"
  3492. abstract="true" native="false" synchronized="false"
  3493. static="false" final="false" visibility="public"
  3494. deprecated="not deprecated">
  3495. <doc>
  3496. <![CDATA[Get a dump of the process-tree.
  3497. @return a string concatenating the dump of information of all the processes
  3498. in the process-tree]]>
  3499. </doc>
  3500. </method>
  3501. <method name="getVirtualMemorySize" return="long"
  3502. abstract="false" native="false" synchronized="false"
  3503. static="false" final="false" visibility="public"
  3504. deprecated="not deprecated">
  3505. <doc>
  3506. <![CDATA[Get the virtual memory used by all the processes in the
  3507. process-tree.
  3508. @return virtual memory used by the process-tree in bytes,
  3509. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3510. </doc>
  3511. </method>
  3512. <method name="getRssMemorySize" return="long"
  3513. abstract="false" native="false" synchronized="false"
  3514. static="false" final="false" visibility="public"
  3515. deprecated="not deprecated">
  3516. <doc>
  3517. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3518. in the process-tree.
  3519. @return rss memory used by the process-tree in bytes,
  3520. {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3521. </doc>
  3522. </method>
  3523. <method name="getVirtualMemorySize" return="long"
  3524. abstract="false" native="false" synchronized="false"
  3525. static="false" final="false" visibility="public"
  3526. deprecated="not deprecated">
  3527. <param name="olderThanAge" type="int"/>
  3528. <doc>
  3529. <![CDATA[Get the virtual memory used by all the processes in the
  3530. process-tree that are older than the passed in age.
  3531. @param olderThanAge processes above this age are included in the
  3532. memory addition
  3533. @return virtual memory used by the process-tree in bytes for
  3534. processes older than the specified age, {@link #UNAVAILABLE} if it
  3535. cannot be calculated.]]>
  3536. </doc>
  3537. </method>
  3538. <method name="getRssMemorySize" return="long"
  3539. abstract="false" native="false" synchronized="false"
  3540. static="false" final="false" visibility="public"
  3541. deprecated="not deprecated">
  3542. <param name="olderThanAge" type="int"/>
  3543. <doc>
  3544. <![CDATA[Get the resident set size (rss) memory used by all the processes
  3545. in the process-tree that are older than the passed in age.
  3546. @param olderThanAge processes above this age are included in the
  3547. memory addition
  3548. @return rss memory used by the process-tree in bytes for
  3549. processes older than specified age, {@link #UNAVAILABLE} if it cannot be
  3550. calculated.]]>
  3551. </doc>
  3552. </method>
  3553. <method name="getCumulativeCpuTime" return="long"
  3554. abstract="false" native="false" synchronized="false"
  3555. static="false" final="false" visibility="public"
  3556. deprecated="not deprecated">
  3557. <doc>
  3558. <![CDATA[Get the CPU time in millisecond used by all the processes in the
  3559. process-tree since the process-tree was created
  3560. @return cumulative CPU time in millisecond since the process-tree
  3561. created, {@link #UNAVAILABLE} if it cannot be calculated.]]>
  3562. </doc>
  3563. </method>
  3564. <method name="getCpuUsagePercent" return="float"
  3565. abstract="false" native="false" synchronized="false"
  3566. static="false" final="false" visibility="public"
  3567. deprecated="not deprecated">
  3568. <doc>
  3569. <![CDATA[Get the CPU usage by all the processes in the process-tree based on
  3570. average between samples as a ratio of overall CPU cycles similar to top.
  3571. Thus, if 2 out of 4 cores are used this should return 200.0.
  3572. Note: UNAVAILABLE will be returned in case when CPU usage is not
  3573. available. It is NOT advised to return any other error code.
  3574. @return percentage CPU usage since the process-tree was created,
  3575. {@link #UNAVAILABLE} if CPU usage cannot be calculated or not available.]]>
  3576. </doc>
  3577. </method>
  3578. <method name="checkPidPgrpidForMatch" return="boolean"
  3579. abstract="true" native="false" synchronized="false"
  3580. static="false" final="false" visibility="public"
  3581. deprecated="not deprecated">
  3582. <doc>
  3583. <![CDATA[Verify that the tree process id is same as its process group id.
  3584. @return true if the process id matches else return false.]]>
  3585. </doc>
  3586. </method>
  3587. <method name="getResourceCalculatorProcessTree" return="org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree"
  3588. abstract="false" native="false" synchronized="false"
  3589. static="true" final="false" visibility="public"
  3590. deprecated="not deprecated">
  3591. <param name="pid" type="java.lang.String"/>
  3592. <param name="clazz" type="java.lang.Class"/>
  3593. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3594. <doc>
  3595. <![CDATA[Create the ResourceCalculatorProcessTree rooted to specified process
  3596. from the class name and configure it. If class name is null, this method
  3597. will try and return a process tree plugin available for this system.
  3598. @param pid process pid of the root of the process tree
  3599. @param clazz class-name
  3600. @param conf configure the plugin with this.
  3601. @return ResourceCalculatorProcessTree or null if ResourceCalculatorPluginTree
  3602. is not available for this system.]]>
  3603. </doc>
  3604. </method>
  3605. <field name="UNAVAILABLE" type="int"
  3606. transient="false" volatile="false"
  3607. static="true" final="true" visibility="public"
  3608. deprecated="not deprecated">
  3609. </field>
  3610. <doc>
  3611. <![CDATA[Interface class to obtain process resource usage
  3612. NOTE: This class should not be used by external users, but only by external
  3613. developers to extend and include their own process-tree implementation,
  3614. especially for platforms other than Linux and Windows.]]>
  3615. </doc>
  3616. </class>
  3617. <!-- end class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree -->
  3618. <!-- start class org.apache.hadoop.yarn.util.SystemClock -->
  3619. <class name="SystemClock" extends="java.lang.Object"
  3620. abstract="false"
  3621. static="false" final="true" visibility="public"
  3622. deprecated="not deprecated">
  3623. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3624. <constructor name="SystemClock"
  3625. static="false" final="false" visibility="public"
  3626. deprecated="not deprecated">
  3627. </constructor>
  3628. <method name="getInstance" return="org.apache.hadoop.yarn.util.SystemClock"
  3629. abstract="false" native="false" synchronized="false"
  3630. static="true" final="false" visibility="public"
  3631. deprecated="not deprecated">
  3632. </method>
  3633. <method name="getTime" return="long"
  3634. abstract="false" native="false" synchronized="false"
  3635. static="false" final="false" visibility="public"
  3636. deprecated="not deprecated">
  3637. </method>
  3638. <doc>
  3639. <![CDATA[Implementation of {@link Clock} that gives the current time from the system
  3640. clock in milliseconds.
  3641. NOTE: Do not use this to calculate a duration of expire or interval to sleep,
  3642. because it will be broken by settimeofday. Please use {@link MonotonicClock}
  3643. instead.]]>
  3644. </doc>
  3645. </class>
  3646. <!-- end class org.apache.hadoop.yarn.util.SystemClock -->
  3647. <!-- start class org.apache.hadoop.yarn.util.UTCClock -->
  3648. <class name="UTCClock" extends="java.lang.Object"
  3649. abstract="false"
  3650. static="false" final="false" visibility="public"
  3651. deprecated="not deprecated">
  3652. <implements name="org.apache.hadoop.yarn.util.Clock"/>
  3653. <constructor name="UTCClock"
  3654. static="false" final="false" visibility="public"
  3655. deprecated="not deprecated">
  3656. </constructor>
  3657. <method name="getTime" return="long"
  3658. abstract="false" native="false" synchronized="false"
  3659. static="false" final="false" visibility="public"
  3660. deprecated="not deprecated">
  3661. </method>
  3662. <doc>
  3663. <![CDATA[Implementation of {@link Clock} that gives the current UTC time in
  3664. milliseconds.]]>
  3665. </doc>
  3666. </class>
  3667. <!-- end class org.apache.hadoop.yarn.util.UTCClock -->
  3668. </package>
  3669. <package name="org.apache.hadoop.yarn.util.resource">
  3670. </package>
  3671. <package name="org.apache.hadoop.yarn.util.timeline">
  3672. <!-- start class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3673. <class name="TimelineUtils" extends="java.lang.Object"
  3674. abstract="false"
  3675. static="false" final="false" visibility="public"
  3676. deprecated="not deprecated">
  3677. <constructor name="TimelineUtils"
  3678. static="false" final="false" visibility="public"
  3679. deprecated="not deprecated">
  3680. </constructor>
  3681. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3682. abstract="false" native="false" synchronized="false"
  3683. static="true" final="false" visibility="public"
  3684. deprecated="not deprecated">
  3685. <param name="o" type="java.lang.Object"/>
  3686. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3687. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3688. <exception name="IOException" type="java.io.IOException"/>
  3689. <doc>
  3690. <![CDATA[Serialize a POJO object into a JSON string not in a pretty format
  3691. @param o
  3692. an object to serialize
  3693. @return a JSON string
  3694. @throws IOException
  3695. @throws JsonMappingException
  3696. @throws JsonGenerationException]]>
  3697. </doc>
  3698. </method>
  3699. <method name="dumpTimelineRecordtoJSON" return="java.lang.String"
  3700. abstract="false" native="false" synchronized="false"
  3701. static="true" final="false" visibility="public"
  3702. deprecated="not deprecated">
  3703. <param name="o" type="java.lang.Object"/>
  3704. <param name="pretty" type="boolean"/>
  3705. <exception name="JsonGenerationException" type="com.fasterxml.jackson.core.JsonGenerationException"/>
  3706. <exception name="JsonMappingException" type="com.fasterxml.jackson.databind.JsonMappingException"/>
  3707. <exception name="IOException" type="java.io.IOException"/>
  3708. <doc>
  3709. <![CDATA[Serialize a POJO object into a JSON string
  3710. @param o
  3711. an object to serialize
  3712. @param pretty
  3713. whether in a pretty format or not
  3714. @return a JSON string
  3715. @throws IOException
  3716. @throws JsonMappingException
  3717. @throws JsonGenerationException]]>
  3718. </doc>
  3719. </method>
  3720. <method name="timelineServiceEnabled" return="boolean"
  3721. abstract="false" native="false" synchronized="false"
  3722. static="true" final="false" visibility="public"
  3723. deprecated="not deprecated">
  3724. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3725. <doc>
  3726. <![CDATA[Returns whether the timeline service is enabled via configuration.
  3727. @param conf the configuration
  3728. @return whether the timeline service is enabled.]]>
  3729. </doc>
  3730. </method>
  3731. <method name="getTimelineServiceVersion" return="float"
  3732. abstract="false" native="false" synchronized="false"
  3733. static="true" final="false" visibility="public"
  3734. deprecated="not deprecated">
  3735. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3736. <doc>
  3737. <![CDATA[Returns the timeline service version. It does not check whether the
  3738. timeline service itself is enabled.
  3739. @param conf the configuration
  3740. @return the timeline service version as a float.]]>
  3741. </doc>
  3742. </method>
  3743. <method name="timelineServiceV1_5Enabled" return="boolean"
  3744. abstract="false" native="false" synchronized="false"
  3745. static="true" final="false" visibility="public"
  3746. deprecated="not deprecated">
  3747. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3748. <doc>
  3749. <![CDATA[Returns whether the timeline service v.1.5 is enabled by default via
  3750. configuration.
  3751. @param conf the configuration
  3752. @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
  3753. version equal to 1.5.]]>
  3754. </doc>
  3755. </method>
  3756. <method name="createTimelineAbout" return="org.apache.hadoop.yarn.api.records.timeline.TimelineAbout"
  3757. abstract="false" native="false" synchronized="false"
  3758. static="true" final="false" visibility="public"
  3759. deprecated="not deprecated">
  3760. <param name="about" type="java.lang.String"/>
  3761. </method>
  3762. <method name="getTimelineTokenServiceAddress" return="java.net.InetSocketAddress"
  3763. abstract="false" native="false" synchronized="false"
  3764. static="true" final="false" visibility="public"
  3765. deprecated="not deprecated">
  3766. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3767. </method>
  3768. <method name="buildTimelineTokenService" return="org.apache.hadoop.io.Text"
  3769. abstract="false" native="false" synchronized="false"
  3770. static="true" final="false" visibility="public"
  3771. deprecated="not deprecated">
  3772. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3773. </method>
  3774. <method name="generateDefaultFlowName" return="java.lang.String"
  3775. abstract="false" native="false" synchronized="false"
  3776. static="true" final="false" visibility="public"
  3777. deprecated="not deprecated">
  3778. <param name="appName" type="java.lang.String"/>
  3779. <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
  3780. </method>
  3781. <method name="generateFlowNameTag" return="java.lang.String"
  3782. abstract="false" native="false" synchronized="false"
  3783. static="true" final="false" visibility="public"
  3784. deprecated="not deprecated">
  3785. <param name="flowName" type="java.lang.String"/>
  3786. <doc>
  3787. <![CDATA[Generate flow name tag.
  3788. @param flowName flow name that identifies a distinct flow application which
  3789. can be run repeatedly over time
  3790. @return flow name tag.]]>
  3791. </doc>
  3792. </method>
  3793. <method name="shortenFlowName" return="java.lang.String"
  3794. abstract="false" native="false" synchronized="false"
  3795. static="true" final="false" visibility="public"
  3796. deprecated="not deprecated">
  3797. <param name="flowName" type="java.lang.String"/>
  3798. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  3799. <doc>
  3800. <![CDATA[Shortens the flow name for the configured size by removing UUID if present.
  3801. @param flowName which has to be shortened
  3802. @param conf to resize the flow name
  3803. @return shortened flowName]]>
  3804. </doc>
  3805. </method>
  3806. <method name="generateFlowVersionTag" return="java.lang.String"
  3807. abstract="false" native="false" synchronized="false"
  3808. static="true" final="false" visibility="public"
  3809. deprecated="not deprecated">
  3810. <param name="flowVersion" type="java.lang.String"/>
  3811. <doc>
  3812. <![CDATA[Generate flow version tag.
  3813. @param flowVersion flow version that keeps track of the changes made to the
  3814. flow
  3815. @return flow version tag.]]>
  3816. </doc>
  3817. </method>
  3818. <method name="generateFlowRunIdTag" return="java.lang.String"
  3819. abstract="false" native="false" synchronized="false"
  3820. static="true" final="false" visibility="public"
  3821. deprecated="not deprecated">
  3822. <param name="flowRunId" type="long"/>
  3823. <doc>
  3824. <![CDATA[Generate flow run ID tag.
  3825. @param flowRunId flow run ID that identifies one instance (or specific
  3826. execution) of that flow
  3827. @return flow run id tag.]]>
  3828. </doc>
  3829. </method>
  3830. <field name="FLOW_NAME_TAG_PREFIX" type="java.lang.String"
  3831. transient="false" volatile="false"
  3832. static="true" final="true" visibility="public"
  3833. deprecated="not deprecated">
  3834. </field>
  3835. <field name="FLOW_VERSION_TAG_PREFIX" type="java.lang.String"
  3836. transient="false" volatile="false"
  3837. static="true" final="true" visibility="public"
  3838. deprecated="not deprecated">
  3839. </field>
  3840. <field name="FLOW_RUN_ID_TAG_PREFIX" type="java.lang.String"
  3841. transient="false" volatile="false"
  3842. static="true" final="true" visibility="public"
  3843. deprecated="not deprecated">
  3844. </field>
  3845. <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
  3846. transient="false" volatile="false"
  3847. static="true" final="true" visibility="public"
  3848. deprecated="not deprecated">
  3849. </field>
  3850. <doc>
  3851. <![CDATA[The helper class for the timeline module.]]>
  3852. </doc>
  3853. </class>
  3854. <!-- end class org.apache.hadoop.yarn.util.timeline.TimelineUtils -->
  3855. </package>
  3856. <package name="org.apache.hadoop.yarn.webapp.util">
  3857. </package>
  3858. </api>