This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
Requesting a development review for xml/xdm, xml/xam, xml/schema/api and xml/wsdl/api. The modules are in release55 branch only.
Chris, you should find four reviewers that will do the review for you. Usually at least two shall be from other teams than yours. Can you negotiate with then and add them to CC?
Yarda, I added five (there may possibly be six) but several are tentative so hopefully there will be enough.
Ok, now when you have the reviewers, it is probably time to provide the review materials. Usually we use the arch.xml document and HTML page generated from it. The important questions are stability of the APIs you export, dependencies that you have on other modules (should be mostly autogenerated), description of the exported APIs (files, classes, properties, etc.). Usually the first review happens before the work starts, so this information need not be 100% correct. High level description of the concept is enough. E.g. how many modules you have, dependencies between them, how they are supposed to be used, for what tasks, etc. For all of this you can find a place in the arch.xml document. More technical info available at http://openide.netbeans.org/tutorial/api.html#write When you think you have such information, please add the html document(s) as attachment or provide the link to it, here in this issue. Then someone, probably I shall announce the review on nbdev@.
Created attachment 30813 [details] architecture description for xam module
Created attachment 30814 [details] architecture description for xdm module
Created attachment 30815 [details] architecture description for schema model module
Created attachment 30816 [details] architecture description for WSDL model module
Architecture descriptions attached.
MK 01: Few comments to XML Retriever (part of XAM module). The crucial method : FileObject retrieveResource(FileObject destinationDir, URI resourceToRetrieve); 1. Missing javadoc 2. Overload the above retrieveResource() method with : FileObject retrieveResource(FileObject destinationDir, URI resourceToRetrieve, boolean overwriteFiles) throws FileAlreadyExistsException... 3. It's nothing said here about catalog.xml file In fact this method creates (and writes entries to) catalog.xml file located under the project's root. The catalog can be used later, and we actually do that, to work with local resources instead of the remote ones. 4. There is no API to process the catalog.xml E.g. "Add WS Client" calls the XML Retriever that adds entries to catalog.xml, but we need to remove entries when WS Client is removed) I think, if the API method modifies an external file, we need also a way to rollback the change (to remove the entry from catalog.xml) 5. Overload the above retrieveResource() method with : FileObject retrieveResource(FileObject destinationDir, FileObject catalogDir, URI resourceToRetrieve, boolean createNewCatalog, boolean overwriteFiles) throws FileAlreadyExistsException... This is due to our usage of XML Retriever in WS support. We'd rather create an extra catalog file for every WS/WS Client. The current aproach (one catalog.xml per project) leads to impassable problems (issue 75215)
I have not yet looked at the Javadoc, so the following comments apply just to the arch descs. Anyway I doubt I could provide very meaningful comments without actually trying to use XDM (and maybe XAM, if I can figure out what it is for) on a real project I am familiar with. For example, apisupport layer editing, or Ant script editing. JNG01 - Delete any empty XML layers please. JNG02 - sample code in XDM arch desc is misformatted (right under BPEL section). Same in Schema Model arch desc. JNG03 - for XDM, probably ought to remove Java synchronization and declare model not thread safe. Clients can add their own synch if they need it. JNG04 - dep list for XAM looks way too big. Dialogs? Projects? Java projects? Editor internals? What do any of these things have to do with XML models? JNG05 - XAM threading model sounds too complicated but maybe it is just not described adequately. JNG06 - "The schema editor uses the WSDL model to support both textual and graphical editing." - is this backwards?
Response to comments from MK: 1. Javadoc has been added to the retrieveResource method. 2, 5. Issuezilla 80011 has been added for these requests. 3,4. Issuezilla 80013 has been added.
LJ01: I do not like an idea to store catalog.xml (or main catalog file - w/ respect to mkuchtiak's "We'd rather create an extra catalog file for every WS/WS Client") directly under project root. In a discussion on nbdev[1] few months ago there was decided that we will use $PROJECT_ROOT/src/conf/xml-resources (in case of Java EE related projects) or $PROJECT_ROOT/xml-resources (in case of Java SE project) as a root directory for xml & wsdl files "downloaded/used" by the IDE, so I would rather see catalog.xml there. LJ02: There should be an option for clients of xml-retriever's API (part of xam module earlier, but now a days retriever becomes standalone module) to somehow specify a name and location of main OASIS catalog file. I'm refering here to JSR-224[2], section 4.4. This comment is mainly from webservices support point of view - this may have also an impact on usability/users productivity of our tools (and it could also save us some work in other areas - mainly in issues dealing with proxy servers). [1]: http://www.netbeans.org/servlets/ReadMsg?list=nbdev&msgNo=33550 [2]: http://www.jcp.org/en/jsr/detail?id=224
LJ03: OASIS catalog seems to (I didn't check it carefully, so take it as an assuption and if I'm wrong then correct me) support also relative URIs, so there should be also something, some method (probably hidden=private) which will translate absolute URLs to relative URIs according to projects/projet's (dist) directory
To LJ01 : Chris created an enhancement (issue 80011) for that. It would be possible to create an extra catalog for each WS/WS Client.
*** Issue 20532 has been marked as a duplicate of this issue. ***
Response to comments from JNG: 1. removed the empty layer files 2. formatting fixed in XDM / Schema / WSDL 3. issue #82004 4. Fixed for XAM, the only import is org.openide.util 5. cleaned up in arch.xml 6. yes, cleaned up in arch.xml
Created attachment 32575 [details] Updated XAM architecture description
Created attachment 32576 [details] Retriever architecture description
I attached updated architecture descriptions for XAM and Retriever (which was split from XAM).
This looks like a forgotten review request. Please resolve it somehow (won'tfix?).
Seems like a review has already been done on this.
Looks like requested review is performed long time ago