Component Palette Use cases

Click REST Web Services Component Palette, to see usecases

Component Palette Architecture

Partners can make their Web Services available for server mashups in Netbeans 6.0 REST Web Service tooling, using REST Component Palette Architecture. In order to do this, partners need to do the following.

• Create a <component>.xml file that looks like (as shown below, see attached component.xsd also)

<?xml version="1.0" encoding="UTF-8"?>

<component
        xmlns="http://xml.netbeans.org/websvc/rest/component/1.0"
        xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'    
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"             
        xsi:schemaLocation='http://xml.netbeans.org/websvc/rest/component/1.0 
            ../../../../../../../../../src/org/netbeans/modules/websvc/rest/component/component.xsd'      
        name="AddressVerification40"
        category="/StrikeIron"
        nameKey="AddressVerification40_Name"
        categoryKey="StrikeIron_Name"
        bundle="org.netbeans.modules.websvc.rest.component.strikeiron.Bundle">
            
    <description key="AddressVerification40_Desc" 
                 bundle="org.netbeans.modules.websvc.rest.component.strikeiron.Bundle"/>
        
    <icons>
        <icon url="org/netbeans/modules/websvc/rest/component/strikeiron/resources/strikeiron16.png" size="16"/>
        <icon url="org/netbeans/modules/websvc/rest/component/strikeiron/resources/strikeiron32.png" size="32"/>
    </icons>
        
    <service name="USAddressVerification">      
        <method name="VerifyAddressUSA" 
                serviceName="USAddressVerification" portName="USAddressVerificationSoap" 
                type="http://schemas.xmlsoap.org/wsdl/"
                url="http://wsparam.strikeiron.com/USAddressVerification4_0?WSDL">
            <!-- name value is wsdl:binding:/wsdl:operation[@name] -->
            <!-- serviceName value is wsdl:service[@name] -->
            <!-- portName value is wsdl:service/wsdl:port[@name] -->
            <documentation>
                This operation corrects house numbers, street directions, street 
                names, street types, apartment numbers, P.O. boxes, street name 
                misspellings, validates street type extensions, standardizes city 
                names and state names, appends missing state abbreviation and 
                standardizes addresses according to postal authority rules.
            </documentation>
        </method>
    </service>
    
</component>

• Create a netbeans module (It will have the following structure)
• Add the <component>.xml file to the module and put its location in the layer.xml file as shown below

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "http://www.netbeans.org/dtds/filesystem-1_1.dtd">
<filesystem>
    
    <folder name="RestComponents">
        <folder name="StrikeIron">
            <file name="AddressVerification40.xml" url="/org/netbeans/modules/websvc/rest/component/strikeiron/resources/AddressVerification40.xml" />
        </folder>
    </folder>
    
</filesystem>

• If needed I18n the names of category and component names that show on palette in the Bundle.properties
• Build an nbm file from this module
• Make this module available through the netbeans update center.

Note: If NB users already installed partner modules, they will get overwritten during update based on the Module version. In other words modules will get updated only if y > x, where y and x are floating point numbers.

Click partnersvc.zip to download a partner module for StrikeIron Services

Attachments

component.xsd		13679 bytes
partnersvc.zip		77324 bytes