xml.wsdlui/javahelp/org/netbeans/modules/xml/wsdlui/docs/wsdl_editor_port_types.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
7 Oracle and Java are registered trademarks of Oracle and/or its affiliates.
8 Other names may be trademarks of their respective owners.
10 The contents of this file are subject to the terms of either the GNU
11 General Public License Version 2 only ("GPL") or the Common
12 Development and Distribution License("CDDL") (collectively, the
13 "License"). You may not use this file except in compliance with the
14 License. You can obtain a copy of the License at
15 http://www.netbeans.org/cddl-gplv2.html
16 or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
17 specific language governing permissions and limitations under the
18 License. When distributing the software, include this License Header
19 Notice in each file and include the License file at
20 nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
21 particular file as subject to the "Classpath" exception as provided
22 by Oracle in the GPL Version 2 section of the License file that
23 accompanied this code. If applicable, add the following below the
24 License Header, with the fields enclosed by brackets [] replaced by
25 your own identifying information:
26 "Portions Copyrighted [year] [name of copyright owner]"
30 The Original Software is NetBeans. The Initial Developer of the Original
31 Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
32 Microsystems, Inc. All Rights Reserved.
34 If you wish your version of this file to be governed by only the CDDL
35 or only the GPL Version 2, indicate your decision by adding
36 "[Contributor] elects to include this software in this distribution
37 under the [CDDL or GPL Version 2] license." If you do not indicate a
38 single choice of license, a recipient has the option to distribute
39 your version of this file under either the CDDL, the GPL Version 2 or
40 to extend the choice of license to its licensees as provided above.
41 However, if you add GPL Version 2 code and therefore, elected the GPL
42 Version 2 license, then the option applies only if the new code is
43 made subject to such option by the copyright holder.
49 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
50 <title>Configuring Port Types Using the WSDL View</title>
51 <link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
56 <h2>Configuring Port Types Using the WSDL View</h2>
57 <p><small><a href="#seealso">See Also</a></small></p>
59 <p>You can use the WSDL Editor to create, edit, and delete port types.</p>
61 <p>In a WSDL file, a <i>port type</i> contains one or more related operations that the web service can perform.
62 An example of an operation is <tt>GetQuote</tt>.</p>
64 <p>The WSDL Editor supports the following categories of operations:</p>
67 <li><b>Request-response</b>. The operation receives a message as input, and sends a message as output.</li>
68 <li><b>One-way</b>. The operation receives a message as input.</li>
71 <p>Each message contains one or more logical parts.
72 For each part, you must specify the name and the type of content.</p>
74 <p>If you change the name of a port type or operation,
75 then the WSDL Editor renames all occurrences in the same file.
76 To rename all occurrences in associated XSD, WSDL, and BPEL files as well,
77 right-click the component node and choose Refactor > Rename.</p>
81 <p><b>To create a port type:</b></p>
84 <li>In the WSDL view, right-click the Port Types node and choose Add Port Type. <br>
85 The Create New Port Type dialog box appears.</li>
86 <li>Enter a name for the port type.</li>
87 <li>Enter a name for the operation.</li>
88 <li>Select the category of operation.</li>
89 <li>Define the message that the operation receives as input.
90 You can create a message from scratch by entering a new message name in the drop-down list, or you can select an existing message from the drop-down list.
91 For a new message, the Add and Remove buttons enable you to add and remove message parts.</li>
92 <li>If the operation is a request-response operation, then define the message that the operation sends as output.</li>
93 <li>(Optional) If the operation is a request-response operation, then you can define a message that the operation sends as a fault.</li>
95 A port type node appears. The port type node contains an operation node.
96 If you created one or more messages, then the message nodes appear.
97 In addition, a partner link type is automatically created.</li>
100 <p><b>To add an operation to an existing port type:</b></p>
103 <li>In the WSDL view, right-click the port type node and choose Add > Operation. <br>
104 The Create New Operation dialog box appears.</li>
105 <li>Enter a name for the operation.</li>
106 <li>Select the category of operation.</li>
107 <li>Define the message that the operation receives as input.
108 You can create a message from scratch by entering a new message name in the drop-down list, or you can select an existing message from the drop-down list.
109 For a new message, the Add and Remove buttons enable you to add and remove message parts.</li>
110 <li>If the operation is a request-response operation, then define the message that the operation sends as output.</li>
111 <li>(Optional) If the operation is a request-response operation, then you can define a message that the operation sends as a fault.</li>
113 An operation node appears.
114 If you created one or more messages, then the message nodes appear.</li>
117 <p><b>To add a fault to a request-response operation:</b></p>
120 <li>If the Properties window is not visible, choose Window > Properties.</li>
121 <li>Right-click the operation node and choose Add > Fault. <br>
122 The fault node appears.</li>
123 <li>Set the Message property to the fault message.</li>
128 <p><b>To change the name of a port type or operation:</b></p>
131 <li>If the Properties window is not visible, choose Window > Properties.</li>
132 <li>Select the port type or operation node.</li>
133 <li>Set the Name property to the new name.</li>
136 <p><b>To change the parameter order of an operation:</b></p>
139 <li>The parameter order is intended for use with RPC bindings.</li>
143 <li>If the Properties window is not visible, choose Window > Properties.</li>
144 <li>Select the operation node.</li>
145 <li>Click the ellipsis (...) button for the Parameter Order property. <br>
146 The Parameter Order dialog box appears.</li>
147 <li>Move message parts from the Available Parameters list to the Current Parameters list.</li>
148 <li>Arrange the parts in the desired order.</li>
152 <p><b>To delete a port type or operation:</b></p>
155 <li>Select the port type or operation node.</li>
156 <li>Press Delete.</li>
160 <dt><a name="seealso">See Also</a></dt>
161 <dd><a href="wsdl_editor_views.html" title="About the WSDL View">About the WSDL View</a></dd>
162 <dd><a href="wsdl_editor_messages.html" title="Configuring Messages Using the WSDL View">Configuring Messages Using the WSDL View</a></dd>
163 <dd><a href="wsdl_editor_bpel_ext.html" title="Configuring Partner Link Types Using the WSDL View">Configuring Partner Link Types Using the WSDL View</a></dd>
167 <a href="credits.html">Legal Notices</a></small>
168 <table border="0" cellpadding="150">
169 <tr><td> </td></tr>
170 <tr><td> </td></tr>
171 <tr><td> </td></tr>