Apache_Hadoop_YARN_Common_3.4.0.xml 190 KB

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