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.

Bug 105683 - API Review WSDL Editor - Make template provider api public
Summary: API Review WSDL Editor - Make template provider api public
Status: VERIFIED FIXED
Alias: None
Product: xml
Classification: Unclassified
Component: WSDL Tools (show other bugs)
Version: 6.x
Hardware: All All
: P2 blocker (vote)
Assignee: Shivanand Kini
URL:
Keywords: API_REVIEW_FAST
Depends on:
Blocks: 97238
  Show dependency tree
 
Reported: 2007-06-05 04:14 UTC by Shivanand Kini
Modified: 2008-04-15 20:40 UTC (History)
8 users (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments
ExtensibilityElementTemplateProvider.java (3.87 KB, text/plain)
2007-06-05 04:17 UTC, Shivanand Kini
Details
Template Schema document (2.52 KB, application/octet-stream)
2007-06-05 04:17 UTC, Shivanand Kini
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Shivanand Kini 2007-06-05 04:14:14 UTC
ISSUE:
Template provider api was exposed as friend API in previous releases. Since the
number of users, who use this API has increased considerably, an issue was filed
to make it public. There are currently 25 friends for this API.
There is binding component development kit for creating netbeans plugins to plug
into the wsdl editor/casa editor, which needs these API's to be public
(http://www.netbeans.org/issues/show_bug.cgi?id=97238)

Target milestone:
M10

Dependencies on other issues:
http://www.netbeans.org/issues/show_bug.cgi?id=97238
#1 of http://www.netbeans.org/issues/show_bug.cgi?id=104110

Background of the API:
WSDL Editor provides a SPI called
org.netbeans.modules.xml.wsdl.bindingsupport.spi.ExtensibilityElementTemplateProvider.

This defines a xml document, which provides templates with default values, so
that wsdl bindings can be created with those default values.
There can be more than one templates with different default values. 

For e.g: SOAP binding has three templates:
1. Document literal
2. RPC Literal
3. RPC Encoded
Each of them provide different values to attributes in soap:binding,
soap:operation, soap:body elements.

The wsdl extension developer determines the templates and default values and
creates a xml document whose schema is constrained by the schema defined in 
org.netbeans.modules.xml.wsdl.bindingsupport.template.xsd.templates.xsd.
(under xml/wsdlbindingsupport/api module)

The composite application editor (enterprise/compapp/casaeditor) also uses the
SPI to automatically generate binding code based on the wsdl port.



Interfaces defined:


Attached the source file

Attached the templates.xsd


The interface requests the user of the API to do the following:

1. Return the template xml document
2. Get localized messages to keys defined in the template.
3. do validation to see if the template the the end user has choosen, is
compliant with the abstract WSDL defined before.



Stability Category:
stable
Comment 1 Shivanand Kini 2007-06-05 04:17:04 UTC
Created attachment 43223 [details]
ExtensibilityElementTemplateProvider.java
Comment 2 Shivanand Kini 2007-06-05 04:17:22 UTC
Created attachment 43224 [details]
Template Schema document
Comment 3 Shivanand Kini 2007-06-08 23:04:41 UTC
I have not receieved any comments as of yet.

Please review and if there is no objections I would like to go ahead and commit
these changes by jun 13th-14th.
Comment 4 Shivanand Kini 2007-06-14 01:19:36 UTC
Changed the api to public access.
Comment 5 jlautz 2008-04-09 15:55:04 UTC
Kini -- is there a way for me to verify this?
Comment 6 jlautz 2008-04-15 20:40:11 UTC
Verified with 
Product Version: NetBeans IDE Dev (Build 200804100130) - Java CAPS Enabled
Java: 1.6.0_03; Java HotSpot(TM) Client VM 1.6.0_03-b05
System: SunOS version 5.10 running on x86; ISO646-US; en (nb)
Userdir: /Users/lautz/sierrabuilds/EA3Candidate/.netbeans/caps