Using Java APIs as REST Services

Skip Headers Oracle E-Business Suite Integrated SOA Gateway Developer's Guide Release 12.2 Part Number E20927-12

Content Previou Ne s s t

Using Java APIs as ES! Services Overview !ava "P#s are business inter$a%es based on !ava %lasses. Some spe%iali&ed !ava "P#s '(ose met(ods must use parameters o$ eit(er seriali&able !ava )eans or simple data t*pes su%( as Strin+, #nt, and so $ort( %an be %ate+ori&ed as Java Bean Services. Some !ava %lass provides a%%ess to business lo+i% +overnin+ t(e " rame'ork-based %omponents and pa+es. Su%( !ava %lasses are %alled Application "odule Services and are also %ate+ori&ed as a subt*pe o$ !ava inter$a%e. /o lo%ate t(ese subt*pe o$ !ava inter$a%es, per$orm a sear%( b* spe%i$*in+ #nter$a%e Subt*pe as t(e Cate+or* and !ava )ean Servi%es or "ppli%ation odule Servi%es as t(e Cate+or* alue. )ot( !ava )ean Servi%es and "ppli%ation odule Servi%es %an be eposed as RES/ servi%es onl*. n%e !ava )ean Servi%es or "ppli%ation odule Servi%es (ave been su%%ess$ull* deplo*ed as RES/ servi%es, an inte+ration developer %an invoke t(e deplo*ed RES/ servi%es $rom %lient pro+ram usin+ lan+ua+es like !ava, PHP, !avas%ript, P*t(on, and so on. Using Java Bean Services as t#e ES! Service Invocation E$a%ple /o better understand (o' to use !ava "P#s as RES/ servi%es to $et%( and use appli%ation data, an inter$a%e t*pe o$ !ava )ean Servi%es is used as an eample to eplain detailed desi+n-time and runtime tasks in t(is %(apter. or t(e eample des%ribed in t(e $ollo'in+ se%tions, ra%le !3eveloper 11 g 411.1.1.5.06 is used to %reate a proe%t 'it( a !ava %lass and invoke t(e servi%e. Similar to !ava )ean Servi%es, "ppli%ation odule Servi%es are a subt*pe o$ !ava inter$a%e and %an be eposed as RES/ servi%es 'it( 8E/ and PS/ H//P met(ods. /(ere$ore, t(e servi%e invo%ation $or

"ppli%ation odule Servi%es 'ill use t(e similar approa%( as des%ribed $or !ava )ean Servi%es to invoke t(e "ppli%ation odule RES/ servi%es. /(at is, deplo* an inter$a%e t*pe o$ "ppli%ation odule Servi%es as a RES/ servi%e rst, t(en %reate a se%urit* +rant and re%ord t(e deplo*ed :"3;, t(en %reate a proe%t 'it( a !ava %lass, and t(en invoke t(e RES/ servi%e usin+ a !ava %lass. /(is %(apter in%ludes t(e $ollo'in+ RES/ servi%e invo%ation eamples $or !ava )ean Serviv%es< •

#nvokin+ a RES/ Servi%e =sin+ H//P 8E/  et(od

•

"nnotatin+ and #nvokin+ a Custom !ava )ean Servi%e

Invo&ing a ES! Service Using !!P GE! "et#od ES! Service Invocation Scenario Consider a !ava )ean servi%e >RES/ Servi%e ;o%ator> 4ora%le.apps.$nd.rep.'s.servi%e.EbsRest;o%ator6 as an eample to eplain t(e RES/ servi%e invo%ation. RES/ Servi%e ;o%ator is a sample !ava "P# t(at %onsists o$ met(ods to retrieve details about deplo*ed ra%le E-)usiness Suite RES/ servi%es. " !ava %lient is used to make H//P 8E/ re?uest to t(e +etRest#nter$a%e servi%e operation. /(e +etRest#nter$a%e servi%e operation returns t(e details o$ a RES/ servi%e identied b* its internal name. #n t(is eample, H//P )asi% "ut(enti%ation s%(eme is used to provide username and pass'ord in$ormation in t(e H//P re?uest (eader. /(e user %redentials are aut(enti%ated and aut(ori&ed b* #S8>s RES/ Servi%e Provider. "$ter validation, t(e +etRest#nter$a%e servi%e operation ee%utes t(e re?uest $or t(e aut(enti%ated user. "$ter t(e su%%ess$ul servi%e invo%ation, t(e %lient 'ill re%eive a RES/ response messa+e 'it( t(e details o$ t(e RES/ servi%e '(ose internal name (as been passed in H//P =R; at run time durin+ servi%e invo%ation. Invo&ing a ES! Service Using Java

)ased on t(e RES/ servi%e invo%ation s%enario, t(e $ollo'in+ tasks are in%luded in t(is se%tion< 1. 3eplo*in+ a RES/ Servi%e 2. Creatin+ a Se%urit* 8rant @. Re%ordin+ Resour%e #n$ormation $rom 3eplo*ed :"3; A. Creatin+ a Proe%t 'it( a !ava Class B. #nvokin+ a RES/ Servi%e =sin+ a !ava Class

Deploying a ES! Service =se t(e $ollo'in+ steps to deplo* t(e !ava )ean Servi%e %alled RES/ Servi%e ;o%ator< 1. ;o+ in to ra%le E-)usiness Suite as a user '(o (as t(e #nte+ration "dministrator role. Sele%t t(e #nte+rated S" 8ate'a* responsibilit* and t(e #nte+ration Repositor* link $rom t(e navi+ation menu. 2. #n t(e #nte+ration Repositor* tab, %li%k Searc# to a%%ess t(e main Sear%( pa+e. @. Cli%k S#ow "ore Searc# Optionsto displa* more sear%( elds. Enter t(e $ollo'in+ ke* sear%( values as t(e sear%( %riteria< o Cate+or*< #nter$a%e Subt*pe o Cate+or* alue< !ava )ean Servi%es

A. Cli%k Go to ee%ute t(e sear%(.

Cli%k t(e RES/ Servi%e ;o%ator inter$a%e name link to open t(e inter$a%e details pa+e. B. #n t(e RES/ :eb Servi%e tab, enter t(e $ollo'in+ in$ormation< Deploying a Java API as a ES! Service

o Servi%e "lias< servi%elo%ator

/(e alias 'ill be displa*ed as t(e servi%e endpoint in t(e :"3; and s%(ema $or t(e sele%ted met(od or operation. o Sele%t 3esired Servi%e perations

#n t(e Servi%e perations re+ion, H//P met(od %(e%k boes are presele%ted. Please note t(at i$ a !ava met(od is annotated 'it( a spe%i% H//P met(od, t(en t(e %orrespondin+ H//P met(od %(e%k bo is presele%ted $or t(at met(od. /(e administrator %an %(an+e t(e H//P met(od %(e%k bo sele%tion be$ore deplo*in+ t(e servi%e. or more !ava )ean Servi%es annotation +uidelines, see "nnotations $or !ava )ean Servi%es. #n t(is eample, t(e >+etRest#nter$a%e> servi%e operation (as been annotated 'it( t(e 8E/ H//P met(od t(ere$ore, t(e 8E/ %(e%k bo is automati%all* sele%ted. 5. Cli%k Deploy to deplo* t(e servi%e to an ra%le E-)usiness Suite :eb;o+i% environment. n%e t(e RES/ servi%e (as been su%%ess$ull* deplo*ed, >3eplo*ed> appears in t(e RES/ Servi%e Status eld alon+ 'it( t(e (iew )AD* link. Cli%k t(e (iew )AD* link to vie' t(e deplo*ed servi%e :"3; des%ription. or more in$ormation on deplo*in+ RES/ servi%es, see 3eplo*in+ RES/ :eb Servi%es, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

+reating a Security Grant "$ter deplo*in+ t(e RES/ Servi%e ;o%ator as a RES/ servi%e, t(e inte+ration administrator %an %reate a se%urit* +rant to aut(ori&e t(e servi%e or met(od a%%ess privile+es to a spe%i% user, a user +roup, or all users. =se t(e $ollo'in+ steps to %reate a se%urit* +rant<

1. ;o+ in to ra%le E-)usiness Suite as a user '(o (as t(e #nte+ration "dministrator role. Sele%t t(e #nte+rated S" 8ate'a* responsibilit* and t(e #nte+ration Repositor* link $rom t(e navi+ation menu. 2. Per$orm a sear%( to lo%ate t(e RES/ Servi%e ;o%ator servi%e t(e administrator ust deplo*ed earlier. @. #n t(e inter$a%e details pa+e o$ t(e sele%ted %ustom !ava )ean Servi%es, %li%k t(e 8rants tab. A. Sele%t t(e +etRest#nter$a%e met(od %(e%k bo and t(en %li%k +reate Grant. +reating a Security Grant ,or a Selected "et#od

B. #n t(e Create 8rants pa+e, sele%t "ll =ser as t(e 8rantee /*pe.

ote. #n t(is eample, t(e +etRest#nter$a%e servi%e operation is +ranted to all users. #n a%tual implementation, *ou s(ould dene stri%t se%urit* rules. Create +rant to a user or more appropriatel* to a +roup o$ users dened b* roles and responsibilities. +reating t#e Grant to All Users

Cli%k +reate Grant. /(is +rants t(e sele%ted met(od a%%ess privile+e to all ra%le E-)usiness Suite users.

ecording esource In,or%ation ,ro% Deployed )AD*

/o obtain servi%e resour%e in$ormation $rom t(e deplo*ed :"3; $or t(e RES/ Servi%e ;o%ator servi%e, an inte+ration developer %li%ks t(e (iew )AD* link in t(e RES/ :eb Servi%e tab. (iewing )AD* Description

/(e $ollo'in+ :"3; des%ription appears<
xmlns$tns="#ttp$%%xmlns.oracle.com%apps%&nd%soaprovider%po'o%ebsrestlocator%" xmlns="#ttp$%%(adl.dev.'ava.net%)00*%0)" xmlns$xsd="#ttp$%%(((.(+.org%)001%,!c#ema" xmlns$tns1="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%addgrant%" xmlns$tns)="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%addgrants%" xmlns$tns+="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%getoperations%" xmlns$tns/="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%getrestinter&ace%" xmlns$tns="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%getrestinter&aces%" xmlns$tns="#ttp$%%xmlns.oracle.com%apps%&nd%rest%locatorsvc%removegrant%"> <%grammars>

% ... <%reso2rce pat#> ... getRestInterface ! #">

% ml"

& son" <%met#od> <%reso2rce> % ... <%reso2rce pat#> <%application>

Cop* or re%ord t(e $ollo'in+ in$ormation '(i%( 'ill be used later '(en denin+ a !ava %lient< •

Dresour%es baseF(ttp
•

Dresour%e pat(FG+etRest#nter$a%eGirepClassNameIG /(is in$ormation G+etRest#nter$a%eGirepClassNameIG 'ill be used later to $orm t(e later part o$ t(e servi%e =R;. /(e input irepClassNameI is a pat( variable, and it 'ill be repla%ed 'it( t(e internal name o$ an inter$a%e.

+reating a Pro/ect wit# a Java +lass /(is se%tion des%ribes (o' to %reate a proe%t 'it( a !ava %lass t(at 'ill be used to invoke t(e RES/ Servi%e ;o%ator servi%e. !o create a pro/ect and a Java class. 1. pen ra%le !3eveloper.

2. rom t(e main menu, %(oose 0ile 1 ew. #n t(e Ne' 8aller* 'indo', epand t(e 8eneral %ate+or* and sele%t >"ppli%ations>. #n t(e #tems list, sele%t +usto% Application. +reating a Pro/ect in Oracle JDeveloper

Cli%k O2. /(e Create Custom "ppli%ation - Name *our appli%ation pa+e is displa*ed.

@. Enter an appropriate name $or t(e appli%ation in t(e "ppli%ation Name eld, $or eample #S8!avaRES/Proe%t. Cli%k e$t. A. /(e Create Custom "ppli%ation - Name *our proe%t pa+e is displa*ed. Enter an appropriate name $or t(e proe%t in t(e Proe%t Name eld, $or eample #S8!avaRES/Client. #n t(e Proe%t eatures tab, sele%t > Java> $rom t(e "vailable list. ove t(e sele%ted $eature $rom t(e "vailable 'indo' to t(e Sele%ted 'indo' usin+ t(e ri+(t arro' button. Cli%k e$t. B. Cli%k 0inis# in t(e Con+ure !ava Settin+s dialo+ bo. /(e ne'l* %reated proe%t s(ould be visible in t(e Proe%ts 'orkspa%e. 5. Sele%t and ri+(t-%li%k on t(e proe%t name *ou ust %reated in t(e "ppli%ation Navi+ator and %(oose ew $rom t(e drop-do'n sele%tion menu. 7. #n t(e Ne' 8aller* 'indo', epand t(e 8eneral %ate+or* and sele%t >!ava>. #n t(e #tems list, sele%t +lass. Cli%k O2. Selecting a Java +lass

J. #n t(e Create !ava Class dialo+, %(an+e t(e de$ault %lass name to >Rest#nvo%ation8E/et(od>. "%%ept all ot(er de$aults and %li%k O2.

9. /(e ne' %lass opens automati%all* in t(e sour%e editor, displa*in+ t(e skeleton %lass denition. Repla%e t(e skeleton %lass denition 'it( t(e $ollo'in+ !ava %ode< pacage isgrestget import import import import import import import

'ava.io.2&&eredeader 'ava.io.9;Exception 'ava.io.9np2ttream 'ava.io.9np2ttreameader 'ava.net.?ttpU!6onnection 'ava.net.U! com.s2n.'erse7.core.2til.ase/

p2blic class est9nvocation5ETet#od @ %AA A T#is et#od invoes t#e a rest service 2sing ?TTB 5ET et#od (it# pat# parameter in U! A% p2blic static void invoeETCtring svcUrltrDtring 2sernameDtring pass(dDtring pat#Baram t#ro(s 9;Exception @ tring getU! = svcUrltr  "%"  pat#Baram U! 2rl = ne( U!CgetU! %%;btaining connection to invoe t#e service ?ttpU!6onnection conn = C?ttpU!6onnection 2rl.open6onnectionC tring a2t# = 2sername  "$"  pass(d b7teGH b7tes = ase/.encodeCa2t# tring a2t#tr = ne( tringCb7tes %%etting ?ttp #eader val2es conn.sete2estet#odC"5ET" conn.sete2estBropert7C"I2t#oriJation"D "asic "  a2t#tr conn.sete2estBropert7C"Iccept"D "application%'son" conn.sete2estBropert7C"6ontent-!ang2age"D "en-U" conn.setUse6ac#esC&alse conn.set4o9np2tCtr2e conn.set4o;2tp2tCtr2e conn.connectC 7stem.o2t.printlnC"Kn L5ETL re2est sent to U! $ "  2rl 7stem.o2t.printlnC"Kn esponse code - "  conn.getesponse6odeC %%5et esponse tring response = n2ll

tr7 @ response = read?ttpesponseCconn M &inall7 @ i& Cconn N= n2ll conn.disconnectC M %%#o( esponse 7stem.o2t.printlnC"esponse is $ Kn"  response M %AA A T#is met#od reads response sent b7 t#e server and ret2rns it in a string representation. A% private static tring read?ttpesponseC?ttpU!6onnection conn @ 9np2ttream is rd = n2ll 2&&eredeader = n2ll tring2&&er response = ne( tring2&&erC tr7 @ i& Cconn.getesponse6odeC >= /00 @ is = conn.getErrortreamC M else @ is = conn.get9np2ttreamC M rd = ne( 2&&eredeaderCne( 9np2ttreameaderCis tring line (#ile CCline = rd.read!ineC N= n2ll @ response.appendCline response.appendCLKnL M M catc# C9;Exception ioe @ response.appendCioe.getessageC M &inall7 @ i& Cis N= n2ll @ tr7 @ is.closeC M catc# CException e @ M M i& Crd N= n2ll @ tr7 @ rd.closeC M catc# CException e @ M

M M ret2rn Cresponse.totringC M p2blic static void mainCtringGH args t#ro(s Exception @ tring baseUrl = " http://:/webservices/rest/servicelocator " tring svcUrltr1 = baseUrl  "% getRestInterface " %%9nvoe ET service invoeETCsvcUrltr1D "s7sadmin"D "s7sadmin"D "B!O!$F4:B;F9!E" M M

Please note t(at resour%e in$ormation re%orded earlier $rom t(e deplo*ed :"3; is no' pla%ed in t(e base=rl and sv%=rlStr1 elements. P;SK;<N3LPR#;E is t(e inter$a%e internal name and t(at it is assumed to be deplo*ed in t(e instan%e. ote. =se #ttps 4instead o$ (ttp6 in t(e base=rl i$ *our ra%le E-)usiness Suite instan%e is runnin+ on t(e /;S-enabled environment. "dditionall*, *ou need to import t(e /;S %erti%ate into *our %lient !>s ke*store. 10.

Repla%e D(ostname
11.

Save *our 'ork b* sele%tin+ 0ile 1 Save All.

12.

Add re3uired li4rary ,or JSO ,or%at.

=se t(e $ollo'in+ steps to add t(e re?uired librar* le to t(e proe%t properties. a. Sele%t and ri+(t-%li%k on t(e proe%t name *ou ust %reated earlier to open a sele%tion menu. b. Sele%t Pro/ect Properties $rom t(e menu. /(e 3e$ault Properties dialo+ bo opens. %. Sele%t *i4raries and +lasspat#, and %li%k Add *i4rary. /(e "dd ;ibrar* dialo+ bo opens.

d. #n t(e "dd ;ibrar* dialo+ bo, sele%t t(e Proe%t $older and t(en %li%k ew. /(e Create ;ibrar* dialo+ bo opens. e. #n t(e ;ibrar* Name eld, enter >!erse*-bundleL1.0.0.0L1-1-B-1.ar>. Cli%k Add Entry. /(e Sele%t Pat( Entr* dialo+ bo appears. $. #n t(e Sele%t Pat( Entr* dialo+ bo, lo%ate and sele%t t(e >!erse*-bundleL1.0.0.0L1-1-B-1.ar> le t(at *ou (ave do'nloaded. /(is adds it to t(e Classpat(. Cli%k O2. /(e >!erse*-bundleL1.0.0.0L1-1-B-1.ar> is no' added to t(e Proe%t $older. +. /(e Proe%t Properties dialo+ bo appears. Cli%k O2. /(is proe%t is no' set up 'it( t(e re?uired librar*. (eri,ying t#e Added *i4rary

Invo&ing a ES! Service Using a Java +lass "$ter %reatin+ a proe%t 'it( a !ava %lass Rest#nvo%ation8E/et(od.ava, *ou need to %ompile and ee%ute t(e pro%ess to invoke t(e RES/ servi%e.

=se t(e $ollo'in+ steps to %ompile and run t(e !ava %lass< 1. #n t(e "ppli%ation Navi+ator, ri+(t-%li%k on t(e Rest#nvo%ation8E/et(od.ava !ava %lass *ou ust %reated at t(e desi+n time. Sele%t "a&e $rom t(e menu. 2. Ri+(t-%li%k on t(e Rest#nvo%ation8E/et(od.ava !ava %lass. Sele%t un $rom t(e menu. onitor t(is pro%ess and %(e%k $or su%%ess$ul %ompilation in t(e ;o+ 'indo'. eri$* t(at t(e ee%ution is su%%ess$ul in t(e ;o+ 'indo'. e3uest eader In,or%ation #n t(is eample, +etRest#nter$a%e !ava met(od is eposed as a RES/ servi%e operation 'it( 8E/ met(od. /(ere is no input pa*load $or 8E/ met(od. /(e pat( variable irepClassNameI is repla%ed 'it( a%tual value P;SK;<N3LPR#;E sent as part o$ t(e H//P =R; s(o'n belo' '(en t(e +etRest#nter$a%e RES/ servi%e operation is invoked. =R; F (ttp
(iewing Output "essage :(en t(e RES/ servi%e is su%%ess$ull* invoked, t(e $ollo'in+ output in !SN $ormat appears in t(e ;o+ 'indo'< @ ";2tp2tBarameters" $ @ "Ebsesterviceean" $ G @

"alternateIlias" $ "plsl%B!O!$F4:B;F9!E"D "serviceIlias" $ "pro&ile"D '()*(:+N,-'R.+I( "serviceame" $ " "D "(adlUrl" $ "#ttp$%%<#ostname>$%(ebservices%rest%pro&ile3QI4!" M HD "6ontrolean" $ G @ "&ields" $ ""D "&ilter" $ ""D "limit" $ ""D "o&&set" $ "" M H M M

Noti%e t(at t(e servi%e in$ormation identied b* its internal name P;SK;<N3LPR#;E is returned. or eample, t(e :"3; =R;, servi%e name, and servi%e alias are in%luded as part o$ t(e response messa+e.

Annotating and Invo&ing a +usto% Java Bean Service Sin%e not all !ava "P#s re+istered in t(e #nte+ration Repositor* %an be eposed as RES/ servi%es, onl* some spe%iali&ed !ava "P#s des%ribed earlier 'it( proper annotation %an be eposed as RES/ servi%es. /o better understand (o' to annotate t(ose spe%iali&ed !ava "P#s as !ava )ean Servi%es, and (o' to invoke !ava )ean Servi%es 'it( RES/ servi%e se%urit*, t(is se%tion des%ribes t(e entire pro%ess $rom annotatin+ a %ustom !ava "P# to invokin+ t(e servi%e usin+ H//P 8E/ met(od. ES! Service Invocation Scenario /(is eample uses a %ustom !ava "P# %alled Emplo*ee Servi%e 4ora%le.apps.per.sample.servi%e.Emplo*ee#n$o6 to eplain t(e entire annotation and upload pro%esses as 'ell as t(e servi%e invo%ation. /(ere are t'o invo%ation s%enarios. ne s%enario is to +et emplo*ee details, and t(e ot(er one is to +et dire%t reports $or t(e lo++ed in user. /o +et emplo*ee details, an H/; pa+e 'it( !avas%ript is used to make H//P 8E/ re?uest to t(e +etPerson#n$o servi%e operation %ontained in t(e %ustom "P#. "n emplo*ee #3 is provided at run time $or t(e servi%e to retrieve t(e asso%iated emplo*ee name and t(e emplo*ee>s mana+er name. "$ter t(e

su%%ess$ul servi%e invo%ation, t(e emplo*ee details %orrespondin+ to t(e emplo*ee #3 are displa*ed in t(e H/; pa+e. /o +et dire%t reports $or t(e lo++ed in user, a dierent H/; pa+e 'it( !avas%ript is used in t(is s%enario to make H//P 8E/ re?uest to t(e +et3ire%tReports servi%e operation. /(e lo++ed in user %redentials are provided '(en t(e +et3ire%tReports servi%e operation is invoked. "$ter t(e su%%ess$ul servi%e invo%ation, t(e lo++ed in user>s subordinates or t(e user>s dire%t reports are displa*ed in t(e H/; pa+e 'it( t(e re?uested number o$ re%ords s(o'n in ea%( pa+e. High Level Process Flow for Creating Custom Java Bean Services

/o develop %ustom !ava )ean Servi%es, an inte+ration developer needs to %reate and annotate t(e %ustom !ava "P#s based on t(e #nte+ration Repositor* "nnotation Standards $or !ava )ean Servi%es. "$ter t(e inter$a%e %reation, an inte+ration administrator needs to validate t(e annotated "P#s. #$ no error o%%urs durin+ t(e validation, t(e administrator 'ill t(en upload t(e %ustom "P#s to ra%le #nte+ration Repositor* '(ere t(e* %an be publis(ed as RES/ servi%es t(rou+( ra%le E-)usiness Suite #nte+rated S" 8ate'a*. or annotation in$ormation, see< "nnotations $or !ava )ean Servi%es. Annotating and Invo&ing a +usto% Java Bean Service ,ro% !"* Pages wit# Javascript )ased on t(e RES/ servi%e invo%ation s%enario, t(e $ollo'in+ tasks are in%luded in t(is se%tion< 1. Creatin+ and Compilin+ Custom !ava "P#s 2. 3eplo*in+ Custom !ava Classes and Sour%e iles @. Parsin+ and =ploadin+ t(e "nnotated Custom !ava )ean Servi%e to t(e #nte+ration Repositor* A. 3eplo*in+ a Custom !ava )ean Servi%e B. Creatin+ a Se%urit* 8rant

5. Re%ordin+ Resour%e #n$ormation $rom 3eplo*ed :"3; 7. #nvokin+ a Custom RES/ Servi%e $rom H/; Pa+es 'it( !avas%ript

+reating and +o%piling +usto% Java APIs /(is se%tion des%ribes (o' to %reate and annotate a %ustom !ava )ean Servi%e %alled Emplo*ee #n$ormation 4ora%le.apps.per.sample.servi%e.Emplo*ee#n$o6. Guidelines ,or Developing +usto% Java APIs 3urin+ t(e plannin+ sta+e, use t(e $ollo'in+ +uidelines to plan and develop t(e %ustom !ava "P#s t(at 'ill be eposed as RES/ servi%es t(rou+( ra%le E-)usiness Suite #nte+rated S" 8ate'a*< 1. 3evelop a !ava %lass '(ose publi% met(ods provide business $un%tionalit*. )usiness lo+i% s(ould be embedded into t(ese publi% met(ods. o /(e %ustom !ava "P#s and met(od names 'ill be used in :eb servi%e =R;. /(ere$ore, ensure to provide $riendl* names. o #$ *ou need initiali&ed ra%le E-)usiness Suite Contet 'it(in t(e !ava met(od, ensure t(e $ollo'in+< 

=se #S8 Contet 4#Contet6 to +et (andle to runtime in$ormation. or eample, #Contet %t F Contetana+er.+etContet46



Retrieve $ull* initiali&ed ra%le E-)usiness Suite :eb"ppsContet based on t(e re?uest (eader G se%urit* token. or eample, :eb"ppsContet '%t F 4:eb"ppsContet6 %t.+etEternalContet46

:eb"ppsContet ma* be used later $or appli%ation spe%i% validation, su%( as ne +rained a%%ess %ontrol. o Oou ma* use t(e ra%le E-)usiness Suite #nte+rated S" 8ate'a* database %onne%tions 'it(in t(e !ava "P#s.

or eample, %onn F 3)Conne%tionana+er.+etConne%tion46 o ra%le E-)usiness Suite #nte+rated S" 8ate'a* provides a standard e%eption (andlin+ $rom t(e in$rastru%ture. Ensure t(at t(e !ava "P#s t(ro' or ret(ro' a t(ro'able e%eption '(enever an error %ondition o%%urs.

2. #$ above !ava met(ods re?uire %omple data obe%ts to be e%(an+ed as input and output parameters, t(en develop !ava )eans. !ava )eans s(ould< o #mplement ava.io.Seriali&able. o Have no-ar+ument %onstru%tor. o Have a%%essor met(ods, $ollo'in+ >+et> and >set> namin+ %onvention, $or private attributes.

+reating +usto% Java APIs #n t(is eample, *ou need a servi%e t(at 'ill return t(e details o$ a spe%i% person in t(e (ierar%(* o$ t(e lo++ed in user, as 'ell as return all t(e reports o$ t(e lo++ed in user. /o a%(ieve t(is +oal, %reate t(e $ollo'in+ !ava les< •

" !ava %lass Emplo*ee#n$o.ava %ontains t(e $ollo'in+ t(ree met(ods. )ased on t(e s%enarios, t(e* are read-onl* met(ods and 'e 'ill map ea%( !ava met(od to H//P 8E/ verb.

o +et"llReports - /(is met(od returns an arra* o$ all reports o$ t(e re?uestin+ user. o +et3ire%tReports - /(is met(od returns a list o$ dire%t reports o$ t(e re?uestin+ user. o +etPerson#n$o - /(is met(od returns t(e person details $or a spe%i% person #d.

/(is met(od re?uires a ke* identier parameter $or Person #d. /(ere$ore, person#d 'ill be annotated as ke*Lparam. ... A Rparam personI Berson 9denti&ier A Rrep$paramin&o @Rrep$re2iredM @Rrep$0e1-paramM ... •

•

" !ava %lass PerServi%eE%eption.ava t(at etends Servi%eE%eption in ra%le E-)usiness Suite #nte+rated S" 8ate'a*. " !ava )ean Person)ean.ava to %apture person in$ormation.

!o create and co%pile custo% Java APIs. =se t(e $ollo'in+ steps to %reate and %ompile %ustom !ava "P#s< 1. pen ra%le !3eveloper. 2. rom t(e main menu, %(oose 0ile 1 ew. #n t(e Ne' 8aller* 'indo', epand t(e 8eneral %ate+or* and sele%t >"ppli%ations>. #n t(e #tems list, sele%t +usto% Application. Cli%k O2. /(e Create Custom "ppli%ation - Name *our appli%ation pa+e is displa*ed. @. Enter an appropriate name $or t(e appli%ation in t(e "ppli%ation Name eld. Cli%k e$t.

A. /(e Create Custom "ppli%ation - Name *our proe%t pa+e is displa*ed. Enter an appropriate name $or t(e proe%t in t(e Proe%t Name eld, $or eample >#S8!avaLRES/3emo>. #n t(e Proe%t eatures tab, sele%t > Java> $rom t(e "vailable list. ove t(e sele%ted $eature $rom t(e "vailable 'indo' to t(e Sele%ted 'indo' usin+ t(e ri+(t arro' button. Cli%k e$t. B. Cli%k 0inis# in t(e Con+ure !ava Settin+s dialo+ bo. /(e ne'l* %reated proe%t s(ould be visible in t(e Proe%ts 'orkspa%e. 5. Add re3uired li4raries. =se t(e $ollo'in+ steps to add t(e re?uired librar* les to t(e proe%t properties. a. Sele%t and ri+(t-%li%k on t(e proe%t name #S8!avaLRES/3emo *ou ust %reated earlier to open a sele%tion menu. b. Sele%t Pro/ect Properties $rom t(e menu. Selecting Pro/ect Properties ,ro% t#e "enu

/(e 3e$ault Properties dialo+ bo opens. %. Sele%t *i4raries and +lasspat#, and %li%k Add *i4rary. /(e "dd ;ibrar* dialo+ bo opens. Displaying t#e Add *i4rary Dialog

d. #n t(e "dd ;ibrar* dialo+ bo, sele%t and epand t(e Etension $older and %(oose >ra%le !3)C> $rom t(e list.

Cli%k O2. ra%le !3)C is added to t(e Classpat( Entries se%tion. e. Cli%k Add JA7Directory. /(e "dd "r%(ive or 3ire%tor* dialo+ bo appears. )ro'se t(e dire%tor* and lo%ate t(e >$ndall.ar> le. Cli%k Select to add t(e sele%ted >$ndall.ar> le. Browsing to *ocate t#e *i4rary 0ile

=se t(e same approa%( to add >is+a+ent.&ip> le to t(e Classpat( Entries re+ion in t(e Proe%t Properties dialo+. (eri,ying t#e Added *i4raries

Cli%k O2. /(is proe%t is no' set up 'it( t(e re?uired libraries.

7. Sele%t and ri+(t-%li%k on t(e proe%t name #S8!avaLRES/3emo *ou ust %reated and %(oose ew $rom t(e drop-do'n sele%tion menu. J. #n t(e Ne' 8aller* 'indo', epand t(e 8eneral %ate+or* and sele%t >!ava>. #n t(e #tems list, sele%t +lass. Cli%k O2. 9. #n t(e Create !ava Class dialo+, %reate a !ava %lass %alled Person)ean.ava 'it( t(e $ollo'in+ in$ormation< a. Name< Person)ean b. Pa%ka+e< ora%le.apps.per.sample.beans %. Etends< ava.lan+.be%t +reating a Java +lass

Cli%k O2. /(e ne' %lass opens automati%all* in t(e sour%e editor. =se t(e $ollo'in+ !ava %ode $or Person)ean.ava.

pacage oracle.apps.per.sample.beans import 'ava.io.erialiJable import 'ava.2til.4ate p2blic class Bersonean implements erialiJable @ private static &inal long serialSersionU94 = 1! private int person9d private tring &irstame private tring lastame private tring sal2taion private tring &2llame private tring name2&&ix private tring emailIddress private tring emplo7ee2mber private tring (orB#one private 4ate start4ate private int reporting!evel private int s2pervisorBerson9d private tring s2pervisorEmplo7ee2mber private tring s2pervisorF2llame private tring reporting?ierarc#7

p2blic void setBerson9dCint person9d @ t#is.person9d = person9d

M p2blic int getBerson9dC @ ret2rn person9d M p2blic void setFirstameCtring &irstame @ t#is.&irstame = &irstame M p2blic tring getFirstameC @ ret2rn &irstame M p2blic void set!astameCtring lastame @ t#is.lastame = lastame M p2blic tring get!astameC @ ret2rn lastame M p2blic void setal2taionCtring sal2taion @ t#is.sal2taion = sal2taion M p2blic tring getal2taionC @ ret2rn sal2taion M p2blic void setF2llameCtring &2llame @ t#is.&2llame = &2llame M p2blic tring getF2llameC @ ret2rn &2llame M p2blic void setEmailIddressCtring emailIddress @ t#is.emailIddress = emailIddress M p2blic tring getEmailIddressC @

ret2rn emailIddress M p2blic void setEmplo7ee2mberCtring emplo7ee2mber @ t#is.emplo7ee2mber = emplo7ee2mber M p2blic tring getEmplo7ee2mberC @ ret2rn emplo7ee2mber M p2blic void settart4ateC4ate start4ate @ t#is.start4ate = start4ate M p2blic 4ate gettart4ateC @ ret2rn start4ate M p2blic void setame2&&ixCtring name2&&ix @ t#is.name2&&ix = name2&&ix M p2blic tring getame2&&ixC @ ret2rn name2&&ix M p2blic void setQorB#oneCtring (orB#one @ t#is.(orB#one = (orB#one M p2blic tring getQorB#oneC @ ret2rn (orB#one M p2blic void seteporting!evelCint reporting!evel @ t#is.reporting!evel = reporting!evel M p2blic int geteporting!evelC @ ret2rn reporting!evel M

p2blic void set2pervisorBerson9dCint s2pervisorBerson9d @ t#is.s2pervisorBerson9d = s2pervisorBerson9d M p2blic int get2pervisorBerson9dC @ ret2rn s2pervisorBerson9d M p2blic void set2pervisorEmplo7ee2mberCtring s2pervisorEmplo7ee2mber @ t#is.s2pervisorEmplo7ee2mber = s2pervisorEmplo7ee2mber M p2blic tring get2pervisorEmplo7ee2mberC @ ret2rn s2pervisorEmplo7ee2mber M p2blic void set2pervisorF2llameCtring s2pervisorF2llame @ t#is.s2pervisorF2llame = s2pervisorF2llame M p2blic tring get2pervisorF2llameC @ ret2rn s2pervisorF2llame M p2blic void seteporting?ierarc#7Ctring reporting?ierarc#7 @ t#is.reporting?ierarc#7 = reporting?ierarc#7 M p2blic tring geteporting?ierarc#7C @ ret2rn reporting?ierarc#7 M M

o Repeat steps 7, J, and 9 to %reate t(e $ollo'in+ t'o !ava %lasses<

a. PerServi%eE%eption.ava 'it( t(e $ollo'in+ in$ormation< 

Name< PerServi%eE%eption



Pa%ka+e< ora%le.apps.per.sample.%ommon



Etends< ava.lan+.be%t

=se t(e $ollo'in+ !ava %ode $or PerServi%eE%eption.ava< pacage oracle.apps.per.sample.common import

oracle.apps.&nd.isg.app.ebs.rt.common.erviceException

p2blic class BererviceException extends erviceException @ p2blic BererviceExceptionCtring message @ s2perCmessage M p2blic BererviceExceptionCT#ro(able t @ s2perCt M p2blic BererviceExceptionCtring messageD T#ro(able t @ s2perCmessageD t M p2blic BererviceExceptionCtring error6odeD tring messageD T#ro(able t @ s2perCerror6odeD messageD t M M

b. Emplo*ee#n$o.ava 'it( t(e $ollo'in+ in$ormation< 

Name< Emplo*ee#n$o



Pa%ka+e< ora%le.apps.per.sample.servi%e



Etends< ava.lan+.be%t

=se t(e $ollo'in+ !ava %ode $or Emplo*ee#n$o.ava< pacage oracle.apps.per.sample.service import 'ava.sl.6onnection import 'ava.sl.O!Exception import import import import import import import import import import

'ava.2til.Irra7!ist 'ava.2til.?as#ap 'ava.2til.!ist 'ava.2til.ap oracle.apps.&nd.common.QebIpps6ontext oracle.apps.&nd.isg.common.96ontext oracle.apps.&nd.isg.common.mgr.6ontextanager oracle.apps.&nd.isg.common.mgr.46onnectionanager oracle.apps.per.sample.beans.Bersonean oracle.apps.per.sample.common.BererviceException

import oracle.'dbc.;racleBreparedtatement import oracle.'dbc.;raclees2ltet

/22 2 3 sample class to emonstrate how 4ava 3'I can use the I)! R)# framewor05 #his class provies 2 methos to retrieve list of irect reports6 all reports of a person5 It also has methos to 2 retrieve personal etails an accrual balance of a person5 2 7rep:scope public 2 7rep:prouct 'R 2 7rep:ispla1name mplo1ee Information 2 7rep:categor1 IR'-C(3))-)89#' 43;3-93N-)R;IC) 2/ p2blic class Emplo7ee9n&o @ p2blic Emplo7ee9n&oC @ M

s2perC

/22 2 #his metho returns a list of irect reports of the re$uesting user5 2 2 7return (ist of person recors who are irect reports

2 7rep:paraminfo {7rep:innert1pe oracle5apps5per5sample5beans5'erson9ean 2 7rep:scope public 2 7rep:ispla1name !et ,irect Reports 2 7rep:httpverb get 2 7rep:categor1 98)IN))-N#I# sample 2/ %% 4emonstration o& list ret2rn t7pe p2blic !ist get4irecteportsC t#ro(s BererviceException @ %% 5et t#e 95 contextD (#ic# #as r2ntime in&ormation 96ontext ctx = 6ontextanager.get6ontextC %% etrieve &2ll7 initialiJed (ebappscontextD as per t#e re2est #eader % sec2rit7 toen QebIpps6ontext (ctx = CQebIpps6ontext ctx.getExternal6ontextC %% Use (ebappscontext &or apps speci&ic validation e.g. &ine grained access control etc. int 2ser9d = (ctx.getUser9dC tring 2serame = (ctx.getUserameC.toUpper6aseC %% ?ere (e intend to &ilter based on t#e speci&ic 2ser (#o is invoing t#e service tring &ilter = " I4 !ESE! = ) TIT Q9T? UE:IE = $1" !ist person!ist = n2ll tr7 @ ap<9ntegerD Bersonean> map = maeeanC&ilterD 2serame i& Cmap N= n2ll person!ist = ne( Irra7!istCmap.val2esC M catc# CO!Exception sle @ t#ro( ne( BererviceExceptionC"O! error (#ile getting t#e all reports"D sle M ret2rnCperson!ist M

/22 2 #his metho returns an arra1 of all reports of the re$uesting user5 2 2 7return 3rra1 of person recors who are reporting into the re$uesting users organiation hierarch1 2 7rep:scope public 2 7rep:ispla1name !et 3ll Reports 2 7rep:httpverb get 2 7rep:categor1 98)IN))-N#I# sample 2/ %% 4emonstration o& arra7 ret2rn t7pe

p2blic BersoneanGH getIlleportsC t#ro(s BererviceException @ %% 5et t#e 95 contextD (#ic# #as r2ntime in&ormation 96ontext ctx = 6ontextanager.get6ontextC %% etrieve &2ll7 initialiJed (ebappscontextD as per t#e re2est #eader % sec2rit7 toen QebIpps6ontext (ctx = CQebIpps6ontext ctx.getExternal6ontextC

%% Use (ebappscontext &or apps speci&ic validation e.g. &ine grained access control etc. int 2ser9d = (ctx.getUser9dC tring 2serame = (ctx.getUserameC.toUpper6aseC %% ?ere (e intend to &ilter based on t#e speci&ic 2ser (#o is invoing t#e service tring &ilter = " TIT Q9T? UE:IE = $1 " BersoneanGH arra7 = n2ll tr7 @ ap<9ntegerD Bersonean> map = maeeanC&ilterD 2serame i& Cmap N= n2ll arra7 = map.val2esC.toIrra7Cne( BersoneanGmap.siJeCH M catc# CO!Exception sle @ t#ro( ne( BererviceExceptionC"O! error (#ile getting t#e direct reports"D sle M ret2rnCarra7 M

/22 2 #his metho returns the person etails for a specific person i5 #hrows error if the person 2 is not in re$uesting users org hierarch15 2 2 7return ,etails of a person in the logge on users org hierarch15 2 7param personI 'erson Ientifier 2 7rep:paraminfo {7rep:re$uire {7rep:0e1-param 2 7rep:scope public 2 7rep:ispla1name !et 'erson ,etails 2 7rep:httpverb get 2 7rep:categor1 98)IN))-N#I# sample 2/ %% 4emonstration o& simple navigation 2sing pat# param p2blic Bersonean getBerson9n&oCint person9dt#ro(s BererviceException @

%% 5et t#e 95 contextD (#ic# #as r2ntime in&ormation 96ontext ctx = 6ontextanager.get6ontextC %% etrieve &2ll7 initialiJed (ebappscontextD as per t#e re2est #eader % sec2rit7 toen QebIpps6ontext (ctx = CQebIpps6ontext ctx.getExternal6ontextC %% Use (ebappscontext &or apps speci&ic validation e.g. &ine grained access control etc. int 2ser9d = (ctx.getUser9dC tring 2serame = (ctx.getUserameC.toUpper6aseC tring &ilter = " TIT Q9T? UE:IE = $1 " ap<9ntegerD Bersonean> map = n2ll tr7 @ map = maeeanC&ilterD 2serame M catc# sle @ t#ro( CO!Exception ne( BererviceExceptionC"O! error (#ile getting t#e direct reports"D sle M i& Cmap == n2ll t#ro( ne( BererviceExceptionCBererviceException.IUT?;9IT9;:FI9!UED "o org #ierarc#7 &o2nd &or 2ser - "  2serameD n2ll boolean doesExist = map.containse7Cperson9d i& CNdoesExist t#ro( ne( BererviceExceptionCBererviceException.IUT?;9IT9;:FI9!UED "T#e given person "  person9d  " eit#er does not exist or does not belong to t#e c2rrent 2serLs - "  2serame  " #ierarc#7"D n2ll Bersonean bean = map.getCperson9d ret2rnCbean M %AAAAAAAAAAAAAAAAAAAAAAAAA private members AAAAAAAAAAAAAAAAAAAAAAAAAAAA% private ap<9ntegerD Bersonean> maeeanCtring slFilterD tring 2serame t#ro(s O!Exception @ 6onnection conn = n2ll ;racleBreparedtatement stmt = n2ll ;raclees2ltet rs = n2ll ?as#ap<9ntegerD Bersonean> personap = ne( ?as#ap<9ntegerD Bersonean>C 96ontext ctx = 6ontextanager.get6ontextC

tr7 @ tring sl = 5ET:BE;:9F;1  slFilter %% pre&erred (a7 o& obtaining connectionD rat#er t#an &rom QebIpps6ontext conn = 46onnectionanager.get6onnectionC stmt = C;racleBreparedtatement conn.preparetatementCsl stmt.settringC1D 2serame rs = C;raclees2ltet stmt.exec2teO2er7C (#ile Crs N= n2ll VV rs.nextC @ int person9d = rs.get9ntC1 tring rs.gettringC) tring &irstame lastame ==rs.gettringC+ tring title = rs.gettringC/ tring &2llame = rs.gettringC tring name2&&ix = rs.gettringC tring emp2mber = rs.gettringCW tring emailIddr = rs.gettringC8 tring (orB#one = rs.gettringC* int s2pervisor9d = rs.get9ntC10 'ava.2til.4ate start4ate = rs.get4ateC1) int level = rs.get9ntC1 tring s2pervisorame = rs.gettringC1W tring s2pervisorEmp2mber = rs.gettringC18 tring reporting = rs.gettringC1* %% 4o an7 data validation % trans&ormation i& necessar7D #ere Bersonean personean = ne( BersoneanC %% et t#e in&ormation into t#e serialiJable bean personean.setBerson9dCperson9d personean.setFirstameC&irstame personean.set!astameClastame personean.setal2taionCtitle personean.setF2llameC&2llame personean.setame2&&ixCname2&&ix personean.setEmplo7ee2mberCemp2mber personean.setEmailIddressCemailIddr personean.setQorB#oneC(orB#one

personean.set2pervisorBerson9dCs2pervisor9d personean.settart4ateCstart4ate personean.seteporting!evelClevel personean.set2pervisorF2llameCs2pervisorame personean.set2pervisorEmplo7ee2mberCs2pervisorEmp2mber personean.seteporting?ierarc#7Creporting personap.p2tCperson9dD personean M M &inall7 @ i& Crs N= n2ll @ @ rs.closeC M catc# CException e @M rstr7 = n2ll M i& Cstmt N= n2ll @ tr7 @ stmt.closeC M catc# CException e @M stmt = n2ll M %% pre&erred (a7 o& closing t#e connection 46onnectionanager.close6onnectionCconn M ret2rnCpersonap M private static &inal tring 5ET:BE;:9F;1 = "E!E6T 49T96T E.BE;:94D E.F9T:IED E.!IT:IED E.T9T!ED E.FU!!:IED E.UFF9,DKn"  "E.EB!;PEE:UED E.EI9!:I44ED E.Q;:TE!EB?;ED E.UBES9;:94DKn"  "E.UBES9;:I95ET:94D E.EFFE6T9SE:TIT:4ITED E.EFFE6T9SE:E4:4ITEDKn"  "E.UE:94D E.UE:IED !ESE!D B9; E.FU!!:IED B9; E.EB!;PEE:UEDKn"  "P:6;E6T:P:BIT?CE.FU!!:IED L%LKn"  "F;Kn"  "CE!E6T BBF.BE;:94DKn" 

"BBF.F9T:IEDKn"  "BBF.!IT:IEDKn"  "BBF.T9T!EDKn"  "BBF.FU!!:IEDKn"  "BBF.UFF9,DKn"  "BBF.EB!;PEE:UEDKn"  "BBF.EI9!:I44EDKn"  "BBF.Q;:TE!EB?;EDKn"  "BIF.UBES9;:94DKn"  "BIF.UBES9;:I95ET:94DKn"  "5EITETCBBF.EFFE6T9SE:TIT:4ITED BIF.EFFE6T9SE:TIT:4ITE EFFE6T9SE:TIT:4ITED Kn"  "!EITCBBF.EFFE6T9SE:E4:4ITED BIF.EFFE6T9SE:E4:4ITE EFFE6T9SE:E4:4ITEDKn"  "FU.UE:94DKn"  "FU.UE:IEKn" "F; F4:UE FUD BE:I!!:BE;B!E:F BBFDKn"  "BE:I!!:I95ET:F BIFKn"  "Q?EE BBF.BE;:94 = BIF.BE;:94 CKn"  "I4 BBF.U9E:5;UB:94 = BIF.U9E:5;UB:94 CKn"  "I4 CP4ITE ETQEE BBF.EFFE6T9SE:TIT:4ITEKn"  "I4 BBF.EFFE6T9SE:E4:4ITEKn"  "I4 P4ITE ETQEE BIF.EFFE6T9SE:TIT:4ITEKn"  "I4 BIF.EFFE6T9SE:E4:4ITEKn"  "I4 FU.EB!;PEE:94 = BBF.BE;:94Kn"  " EKn"  "6;E6T P UBES9;:94 = B9; BE;:94" M

o Save *our 'ork b* sele%tin+ 0ile 1 Save All. o Sele%t and ri+(t-%li%k on t(e proe%t name #S8!avaLRES/3emo and %(oose "a&e Pro/ect89/pr $rom t(e drop-do'n sele%tion menu. /(e %ompilation pro%ess starts.

eri$* t(at t(e %ompilation pro%ess is su%%ess$ul in t(e essa+e - ;o+ 'indo'.

Deploying +usto% Java +lasses and Source 0iles

n%e t(e %ustom !ava "P# (as been su%%ess$ull* %reated, t(e inte+ration developer needs to %op* t(ese ne'l* %reated !ava %lasses and sour%e les to a tar+et instan%e. or in$ormation on (o' to deplo* t(ese %ustom !ava %lasses, re$er to Se%tion B< 3eplo*in+ Custom "ppli%ation /ier be%ts, 3eplo*in+ Customi&ations in ra%le E-)usiness Suite Release 12.2, * ra%le Support no'led+e 3o%ument 1B77551.1. "$ter t(e su%%ess$ul deplo*ment to a tar+et instan%e, stop and restart t(e mana+ed server.

Parsing and Uploading t#e Annotated +usto% Java Bean Service to t#e Integration epository n%e t(e %ustom !ava %lasses (ave been su%%ess$ull* deplo*ed to a tar+et instan%e, t(e inte+ration administrator needs to validate t(e annotated %ustom inter$a%e denition Emplo*ee #n$ormation a+ainst t(e annotation standards $or !ava )ean Servi%es usin+ #nte+ration Repositor* Parser. 3urin+ t(e validation, i$ no error o%%urs, an i;3/ le 'ill be +enerated. /(e administrator 'ill t(en upload t(e +enerated i;3/ le to ra%le #nte+ration Repositor*. Per$orm t(e $ollo'in+ steps to parse and upload t(e annotated %ustom inter$a%e denition Emplo*ee #n$ormation to ra%le #nte+ration Repositor*< 1. Sour%e t(e environment in t(e run le s*stem and set C;"SSP"/H to in%lude all libraries and !"R les used b* t(e %ustom !ava "P#. 2. Ensure t(e annotated %ustom inter$a%e denition and related !ava %lasses are lo%ated in t(e tar+et instan%e. (eri,ying t#e Annotated +usto% Inter,ace De:nition

@. Ee%ute t(e #nte+ration Repositor* Parser usin+ t(e $ollo'in+ %ommand to validate t(e annotated %ustom inter$a%e denition a+ainst t(e annotation standards< Q#"SLR"C;ELHEGperlGbinGperl QN3L/PGbinGirepLparser.pl -+ -v -usernameFs*sadmin per
Noti%e t(at t(e Emplo*ee#n$oLava.ildt le is su%%ess$ull* +enerated a$ter t(e validation.

A. =pload t(e +enerated Emplo*ee#n$oL!ava.ildt le to t(e #nte+ration Repositor* b* usin+ t(e $ollo'in+ N3;"3 %ommand< . XF4:T;B%bin%F4!;I4 RTQ;:TI 0 P UB!;I4 XF4:T;B%patc#%11%import%(&irep.lct Emplo7ee9n&o:'ava.ildt ;I6!E Bass(ord$

5. eri$* t(e +enerated lo+ le to vie' t(e upload details. (iewing t#e Upload Details

Noti%e t(at t(e upload pro%ess (as been %ompleted su%%ess$ull*. 7. Sear%( t(e uploaded %ustom !ava Servi%e )eans inter$a%e Emplo*ee #n$ormation $rom t(e #nte+ration Repositor*. Cli%k t(e Emplo*ee #n$ormation name link to open t(e inter$a%e details pa+e.

Deploying a +usto% Java Bean Service =se t(e $ollo'in+ steps to deplo* t(e %ustom inter$a%e as a RES/ servi%e< 1. ;o+ in to ra%le E-)usiness Suite as a user '(o (as t(e #nte+ration "dministrator role. Sele%t t(e #nte+rated S" 8ate'a* responsibilit* and t(e #nte+ration Repositor* link $rom t(e navi+ation menu. 2. #n t(e #nte+ration Repositor* tab, %li%k Searc# to a%%ess t(e main Sear%( pa+e. @. Cli%k S#ow "ore Searc# Optionsto displa* more sear%( elds. Sele%t >Custom> in t(e #nter$a%e Sour%e eld. A. Cli%k Go to ee%ute t(e sear%(. Cli%k t(e Emplo*ee #n$ormation inter$a%e name link to open t(e inter$a%e details pa+e. B. #n t(e RES/ :eb Servi%e tab, enter t(e $ollo'in+ in$ormation< o Servi%e "lias< empin$o

/(e alias 'ill be displa*ed as t(e servi%e endpoint in t(e :"3; and s%(ema $or t(e sele%ted met(od or operation.

o Sele%t t(e PS/ %(e%k bo $or t(e 8et Person 3etails !ava met(od. ;eave t(e rest o$ presele%ted %(e%k boes un%(an+ed.

5. Cli%k Deploy to deplo* t(e servi%e to an ra%le E-)usiness Suite :eb;o+i% environment. n%e t(e RES/ servi%e (as been su%%ess$ull* deplo*ed, >3eplo*ed> appears in t(e RES/ Servi%e Status eld alon+ 'it( t(e (iew )AD* link. Cli%k t(e (iew )AD* link to vie' t(e deplo*ed servi%e :"3; des%ription. or more in$ormation on deplo*in+ RES/ servi%es, see 3eplo*in+ RES/ :eb Servi%es, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

+reating a Security Grant "$ter deplo*in+ t(e %ustom inter$a%e Emplo*ee #n$ormation as a RES/ servi%e, t(e inte+ration administrator %an %reate a se%urit* +rant to aut(ori&e t(e servi%e a%%ess privile+es to all users. =se t(e $ollo'in+ steps to %reate a se%urit* +rant< 1. ;o+ in to ra%le E-)usiness Suite as a user '(o (as t(e #nte+ration "dministrator role. Sele%t t(e #nte+rated S" 8ate'a* responsibilit* and t(e #nte+ration Repositor* link $rom t(e navi+ation menu. 2. Per$orm a sear%( to lo%ate t(e Emplo*ee #n$ormation servi%e t(e administrator ust deplo*ed earlier. @. Sele%t t(e Emplo*ee #n$ormation name link $rom t(e sear%( result table to displa* t(e inter$a%e details pa+e. Cli%k t(e 8rants tab. A. Sele%t t(e Emplo*ee #n$ormation servi%e and t(en %li%k +reate Grant. B. #n t(e Create 8rants pa+e, sele%t "ll =sers as t(e 8rantee /*pe.

ote. #n t(is eample, t(e Emplo*ee #n$ormation servi%e is +ranted to all users. #n a%tual implementation, *ou s(ould dene stri%t se%urit* rules. Create +rant to a user or more appropriatel* to a +roup o$ users dened b* roles and responsibilities. Cli%k +reate Grant. /(is +rants t(e sele%ted servi%e a%%ess privile+e to all ra%le E-)usiness Suite users.

ecording esource In,or%ation ,ro% Deployed )AD* /o obtain servi%e resour%e in$ormation $rom t(e deplo*ed :"3; $or t(e %ustom Emplo*ee #n$ormation servi%e, %li%k t(e (iew )AD* link in t(e RES/ :eb Servi%e tab. /(e $ollo'in+ :"3; des%ription appears< <%grammars>



/response < > <%met#od> <%reso2rce> <%met#od> <%reso2rce>


mediaT7pe="application%xml"

t7pe="tns+$getBerson9n&o:;2tp2t" %> <%met#od> <%reso2rce> > < /response> <%met#od> <%reso2rce> <%reso2rce pat#> <%application>

Cop* or re%ord t(e $ollo'in+ in$ormation '(i%( 'ill be used later '(en denin+ a !ava %lient< •

Dresour%es baseF#ttp.77;#ostna%e1.;port17we4services7rest7e%pin,oG /(is in$ormation (ttp
•

Dresour%e pat(FG+etPerson#n$oG
Note t(at
Dresour%e pat(FG+et3ire%tReportsG /(is in$ormation G+et3ire%tReportsG 'ill be used later to $orm t(e later part o$ t(e servi%e =R;.

Invo&ing a +usto% ES! Service ,ro% !"* Using Javascript /(is eample %ontains t'o invo%ation s%enarios< 1. 8et emplo*ee personal in$ormation b* invokin+ +etPerson#n$o RES/ servi%e operation 2. 8et dire%t reports $or t(e lo++ed in user b* invokin+ +et3ire%tReports RES/ servi%e operation 'it( pa+ination %ontrol parameter Scenario 8. Get E%ployee Personal In,or%ation =se t(e $ollo'in+ steps to invoke t(e deplo*ed +etPerson#n$o RES/ servi%e operation< 1. Create an H/; le usin+ an* tet editor 'it( t(e $ollo'in+ %ontent< ). +. <#tml> /. <#ead> .