Apache_Hadoop_YARN_Common_3.1.0.xml 140 KB

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