Change Log for OSS Inventory API version 1.1

Transcription

1 Change Lg fr OSS Inventry API versin 1.1 OSS thrugh Java Initiative Pierre Gauthier MetaSlv Sftware Inc. INV-API-SPEC_change_lg dc Cpyright 2006 MetaSlv Sftware Inc, Inc. All rights reserved. Use is subject t license terms. page 1 / 11

2 Executive Summary This dcument summarizes the changes t the Inventry API (JSR 142) specificatin Versin 1.1. The main purpse f this versin is T use the Cre Business Entities (CBE) interfaces frm the OSS Cmmn API (JSR 144) Fllw the new Draft f the OSS/J Design Guideline v1.2 Add the Web Service Specificatins Align with Cmmn JSR Versin 1.4 Fix Bugs Hwever, since maintenance release t the specificatin was taking place, additinal mdificatins t the previusly existing Java Value Type interface were als incrprated. All these mdificatins are cming frm the Web Bug tracking system at: The detailed descriptin f changes in this dcument is principally f interest t peple implementing the Inventry API specificatin. page 2 / 11

3 Table f Cntents Executive Summary...2 Table f Cntents Preface Objectives Audience Apprval and Distributin Related Infrmatin Revisin Histry Summary f changes prpsed changes Bug ID: QueryResurce javadc refers t ResurceAggregatesResurce Bug ID: QueryResurce.setReturnedTypes javadc refers t classes that dn't exist Bug ID: Inventry TCK requires all Inventries t be implemented Bug ID: Inventry dcuments specify assciatin management methds as mandatry Bug ID: Incnsistencies f JVTInventrySessin methd ptinality Bug ID: Inventry API shall use ReprtFrmat definitin frm cmmn CBE definitin Bug ID: Hw t implement QueryRespnse and QueryValue Bug ID: Apply OSS/J Design Guidelines v1.2 and Cmmn JSR v1.4 t the OSS Inventry API Use Cmmn CBE definitins fr CBE implementatin Replace all javax.ss exceptins Change Query Values Definitins Add Update Values Definitins page 3 / 11

4 1 Preface 1.1 Objectives This dcument lists all the changes that have been requested fr the maintenance release v1.2 versin f the OSS Inventry API, JSR 142. The changes have been cllected thrugh: Bug parade: Bug and Request Fr Evlutin (RFE) submitted by Java develpers OSS/J specificatin leaders: evlutin necessary t incrprate new cmmn bjects and t imprve the cmmn interfaces and Reference Implementatin that will be inherited by all maintenance releases f the existing OSS APIs OSS/J Architectural Bard: The cmmn API needs t reflect the necessary new architectural recmmendatin (new CBE, etc) 1.2 Audience This dcument is used t start a Maintenance Release f the OSS Inventry API, JSR 142. Accrding t the JCP SM : 1.3 Apprval and Distributin The ML may chse t mdify ne r mre f the prpsed changes based n cmments received during review. 1.4 Related Infrmatin Change Lg fr OSS Cmmn API versin SPEC_change_lg pdf 1.5 Revisin Histry page 4 / 11

5 Date Versin Authr State Cmments December Pierre Gauthier Final Using CBE frm Cmmn JSR MetaSlv Sftware 1.4 Mdificatin t JVT Sessin Bean based n DG 1.2 Additin f Web Service Prfile page 5 / 11

6 2 Summary f changes Bug ID: Inventry TCK can't create randm arrays Bug ID: QueryResurce javadc refers t ResurceAggregatesResurce Bug ID: TCK des nt allw arrays fr attribute type Bug ID: QueryResurce.setReturnedTypes javadc refers t classes that dn't exist Bug ID: testgetentityspecificatintype expects describedentitytype t be ppulated Bug ID: Inventry TCK requires all Inventries t be implemented Bug ID: testqueryinventry inapprpriately fails if certain queries are implemented Bug ID: Inventry dcuments specify assciatin management methds as mandatry Bug ID: Inventry TCK uses null t indicate "all attributes" in sme get methds Bug ID: Inventry TCK's randm string length isn't cnfigurable Bug ID: Inventry TCK des nt allw attribute types withut default cnstructrs Bug ID: cmpliance issue with cmmn spec, breaking AttributeManager in cmmn API Bug ID: Incnsistencies f JVTInventrySessin methd ptinality Bug ID: Invalid test reprt frmat, unreadable Bug ID: Inventry API shall use ReprtFrmat definitin frm cmmn CBE definitin Bug ID: Hw t implement QueryRespnse and QueryValue Bug ID: Apply OSS/J Design Guidelines v1.2 and Cmmn JSR 1.2 t the OSS Inventry API page 6 / 11

7 3 prpsed changes 3.1 Bug ID: QueryResurce javadc refers t ResurceAggregatesResurce In the javadc fr javax.ss.inventry.resurce.queryresurce near the tp f the file it refers t "ResurceAggregatesResurce" instead f ""ResurceAggregatesResurceAsscValue". The javax.ss.inventry.resurce package will be deprecated. 3.2 Bug ID: QueryResurce.setReturnedTypes javadc refers t classes that dn't exist In the file javax/ss/inventry/resurce/queryresurce.htm in the javadc, fr javax.ss.inventry.resurce.queryresurce the dc fr the methd setreturnedtypes refers t "javax.ss.inventry.resurce.ownerownsresurceasscvalue" which desn't exist. The javax.ss.inventry.resurce package will be deprecated. 3.3 Bug ID: Inventry TCK requires all Inventries t be implemented The Inventry API will be mdified in such a way that nly the Entity Entity Specificatin management functins will be mandatry. N assumptins will be made regarding the nature f the data mdel implemented by a vendr (i.e. the TCK will nt test if there is a Service, Prduct, Resurce r Crss data mdel). The TCK will als test Assciatin management if present. That is if String[] getassciatintypes() return a nn empty array. The different types f assciatins defined by the Inventry package will be mved under the inf mdel RI package. (I.e. in the example infrmatin mdel). and mved int the RI cntrib. data mdel. page 7 / 11

8 3.4 Bug ID: Inventry dcuments specify assciatin management methds as mandatry Implementatin f AssciatinValue methds is defined as mandatry in User's Guide and in the actual interfaces. Hwever, if implementatin f nly ne f the several Inventries is allwed, there are n meaningful assciatins in such implementatin. Assciatin management will nt be mandatry in 1.1 Only the Entity and Entity Specificatin management methds will be mandatry. 3.5 Bug ID: Incnsistencies f JVTInventrySessin methd ptinality TCK, User's Guide and the methd signatures disagree abut the mandatriness f several methds. The fllwing table summarizes the differences (m fr mandatry and fr ptinal): User's Guide TCK signature Methd name m...m...createassciatinsbyvalues...m...m...createentitiesbyvalues...m...m...createentityspecificatinsbyvalues...m...getallassciatinsrelatedtinventryentity...m...m...getassciatinrule...m...getspecificatindefinedentitytypes...m...m...imprtinventrydata...m...m...remveassciatinsbykeys...m...m...remveassciatinsbytemplate...m...m...remveentitiesbykeys...m...m...remveentitiesbytemplate...m...m...remveentityspecificatinsbykeys...m...m...remveentityspecificatinsbytemplate Furthermre, there's - validateentityvaluesbytemplates: ptinal by signature and TCK but isn't mentined by User's Guide at all - getentityspecificatintype: ptinal by signature, mandatry by TCK and nt mentined by User's Guide at all - makeentityvaluefrmspecificatin: ptinal by signature and TCK, User's Guide says bth ptinal (in chapter ) and mandatry (in chapter ,where it is listed twice) - validatevaluesbytypes: ptinal in User's Guide, but desn't exist in interfaces nr TCK at all page 8 / 11

9 The Spec and User Guide will be mdified. 3.6 Bug ID: Inventry API shall use ReprtFrmat definitin frm cmmn CBE definitin The JSR 142 will use the OSS Cmmn API, javax.ss.cbe package instead f defining its wn set f CBE s. 3.7 Bug ID: Hw t implement QueryRespnse and QueryValue The QueryRespnse and QueryValue types seem t be cre types fr interperability f the query peratins, but there dn't seem t be any example implementatins, r any guidance, t help an implementr. Inventry API will extend the query cmpnents and usage as specified in the JSR 144 spec v Bug ID: Apply OSS/J Design Guidelines v1.2 and Cmmn JSR v1.4 t the OSS Inventry API Use Cmmn CBE definitins fr CBE implementatin The JSR 142 will use the OSS Cmmn API, javax.ss.cbe package instead f defining its wn set f CBE s. The fllwing packages are thus remved frm the specificatin: javax.ss.inventry.crss javax.ss.inventry.prduct javax.ss.inventry.resurce page 9 / 11

10 javax.ss.inventry.service Replace all javax.ss exceptins JSR 142 replace all the javax.ss exceptin by the new name frm JSR 144 The fllwing exceptin definitins in the javax.ss dmain have been deprecated and replaced by prefixing their name with the string Oss. javax.ss.illegalargumentexceptin replaced by javax.ss.ossillegalargumentexceptin javax.ss.illegalattributevalueexceptin replaced by javax.ss.ossillegalattributevalueexceptin javax.ss.illegalstateexceptin replaced by javax.ss.ossillegalstateexceptin javax.ss.resyncrequiredexceptin replaced by javax.ss.ossresyncrequiredexceptin javax.ss.setexceptin replaced by javax.ss.osssetexceptin javax.ss.unsupprtedattributeexceptin replaced by javax.ss.ossunsupprtedattributeexceptin javax.ss.unsupprtedoperatinexceptin replaced by javax.ss.ossunsupprtedoperatinexceptin and cnsequently all the methds f the Inventry JVT Sessin will be fixed t reflect the new jvax.ss Exceptins Change Query Values Definitins JSR 142 change the queryvalues definitin t inherit frm the new named query pattern as defined in JSR Add Update Values Definitins JSR 142 define update prcedure value related t inventry by extending the base UpdatePrcedureValue and UpdatePrcedureRespnse frm JSR page 10 / 11

11 page 11 / 11