xml.wsdlui/javahelp/org/netbeans/modules/xml/wsdlui/docs/wsdl_editor_config.html
author Milutin Kristofic <mkristofic@netbeans.org>
Tue, 31 Jan 2017 14:20:36 +0100
changeset 1584 ddcac47bfed1
parent 1241 f7c3471c4a3f
permissions -rw-r--r--
Added Missing license terms
abadea@61
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
abadea@61
     2
<!--
mkristofic@1584
     3
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
mkristofic@1584
     4
mkristofic@1584
     5
Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
mkristofic@1584
     6
mkristofic@1584
     7
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
mkristofic@1584
     8
Other names may be trademarks of their respective owners.
mkristofic@1584
     9
mkristofic@1584
    10
The contents of this file are subject to the terms of either the GNU
mkristofic@1584
    11
General Public License Version 2 only ("GPL") or the Common
mkristofic@1584
    12
Development and Distribution License("CDDL") (collectively, the
mkristofic@1584
    13
"License"). You may not use this file except in compliance with the
mkristofic@1584
    14
License. You can obtain a copy of the License at
mkristofic@1584
    15
http://www.netbeans.org/cddl-gplv2.html
mkristofic@1584
    16
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
mkristofic@1584
    17
specific language governing permissions and limitations under the
mkristofic@1584
    18
License.  When distributing the software, include this License Header
mkristofic@1584
    19
Notice in each file and include the License file at
mkristofic@1584
    20
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
mkristofic@1584
    21
particular file as subject to the "Classpath" exception as provided
mkristofic@1584
    22
by Oracle in the GPL Version 2 section of the License file that
mkristofic@1584
    23
accompanied this code. If applicable, add the following below the
mkristofic@1584
    24
License Header, with the fields enclosed by brackets [] replaced by
mkristofic@1584
    25
your own identifying information:
mkristofic@1584
    26
"Portions Copyrighted [year] [name of copyright owner]"
mkristofic@1584
    27
mkristofic@1584
    28
Contributor(s):
mkristofic@1584
    29
mkristofic@1584
    30
The Original Software is NetBeans. The Initial Developer of the Original
mkristofic@1584
    31
Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
mkristofic@1584
    32
Microsystems, Inc. All Rights Reserved.
mkristofic@1584
    33
mkristofic@1584
    34
If you wish your version of this file to be governed by only the CDDL
mkristofic@1584
    35
or only the GPL Version 2, indicate your decision by adding
mkristofic@1584
    36
"[Contributor] elects to include this software in this distribution
mkristofic@1584
    37
under the [CDDL or GPL Version 2] license." If you do not indicate a
mkristofic@1584
    38
single choice of license, a recipient has the option to distribute
mkristofic@1584
    39
your version of this file under either the CDDL, the GPL Version 2 or
mkristofic@1584
    40
to extend the choice of license to its licensees as provided above.
mkristofic@1584
    41
However, if you add GPL Version 2 code and therefore, elected the GPL
mkristofic@1584
    42
Version 2 license, then the option applies only if the new code is
mkristofic@1584
    43
made subject to such option by the copyright holder.
abadea@61
    44
-->
abadea@61
    45
<html>
abadea@61
    46
<head>
psmejkal@1108
    47
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
abadea@61
    48
<title>Configuring WSDL File Components</title>
abadea@61
    49
<link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
abadea@61
    50
</head>
abadea@61
    51
<body>
abadea@61
    52
<h2>Configuring WSDL File Components</h2>
abadea@61
    53
<p><small><a href="#seealso">See Also</a></small></p>
abadea@61
    54
<p>This topic describes how to configure the <a href="#rootelement">root element</a> of the WSDL file, 
abadea@61
    55
how to add <a href="#documentation">documentation</a> to any element, 
abadea@61
    56
and how to <a href="#importing">import</a> XML schemas and WSDL files.</p>
abadea@61
    57
<ul class="note">
abadea@61
    58
  <li>If you add <tt>import</tt> statements using the Source view, or if you copy files with URL references 
abadea@61
    59
    into your project, the referenced WSDL file may only be accessible through a URL. 
abadea@61
    60
    
abadea@61
    61
    In this case, your project may not contain the true closure of all the documents. 
abadea@61
    62
    
abadea@61
    63
    Since the WSDL files are referenced, the IDE will perform the same logic that is used when retrieving 
abadea@61
    64
    WSDL resources using the External WSDL Document(s) wizard and transparently fetch the documents and store 
abadea@61
    65
    them in a non-version controlled area. 
abadea@61
    66
    
abadea@61
    67
    This may cause a delay the first time these documents are accessed on your machine, because the referenced 
abadea@61
    68
    documents are not local. Subsequent accesses will be faster.</li>
abadea@61
    69
</ul>
abadea@61
    70
<h3><a name="rootelement"></a>Configuring the Root Element</h3>
abadea@61
    71
<p>The root element contains properties for the name of the WSDL file, 
abadea@61
    72
the target namespace, the default namespace, and namespace prefixes.</p>
abadea@61
    73
<p><b>To configure the root element:</b></p>
abadea@61
    74
<ol>
abadea@61
    75
  <li>In the WSDL view, select the root node.</li>
abadea@61
    76
  <li>If the Properties window is not visible, choose Window &gt; Properties.</li>
abadea@61
    77
  <li>Edit the name, target namespace, and default namespace as necessary.</li>
abadea@61
    78
  <li>Edit the values of the namespace prefixes as necessary.</li>
abadea@61
    79
</ol>
abadea@61
    80
<h3><a name="documentation"></a>Adding Documentation</h3>
abadea@61
    81
<p>You can add documentation to any element in the WSDL file.</p>
abadea@61
    82
<p><b>To add documentation:</b></p>
abadea@61
    83
<ol>
abadea@61
    84
  <li>In the WSDL view, right-click an element and choose Add &gt; Documentation. <br>
abadea@61
    85
    A documentation node appears.</li>
abadea@61
    86
  <li>Select the documentation node.</li>
abadea@61
    87
  <li>If the Properties window is not visible, choose Window &gt; Properties.</li>
abadea@61
    88
  <li>Enter the documentation text.</li>
abadea@61
    89
</ol>
abadea@61
    90
<h3><a name="importing"></a>Importing XML Schemas and WSDL Files</h3>
abadea@61
    91
<p>You can use the WSDL Editor to import an XML schema file or another WSDL file that is part of your project.</p>
abadea@61
    92
<p><b>To import an XML schema:</b></p>
abadea@61
    93
<ol>
abadea@61
    94
  <li>In the WSDL view, right-click the root node and choose Add &gt; Import Schema.<br>
abadea@61
    95
    The Import Customizer dialog box opens.</li>
abadea@61
    96
  <li>In the Location list, expand the <tt>By File</tt> or <tt>By Namespace</tt> nodes to navigate to and select the XML schema file.<br>
abadea@61
    97
    The Namespace field below the Location list is filled in by the IDE.</li>
abadea@61
    98
  <li>(Optional) In the New Prefix field, type the prefix that you want to use.
abadea@61
    99
  <li>Click OK.</li>
abadea@61
   100
</ol>
abadea@61
   101
<p><b>To import another WSDL file:</b></p>
abadea@61
   102
<ol>
abadea@61
   103
  <li>In the WSDL view, right-click the root node and choose Add &gt; Import WSDL.<br>
abadea@61
   104
    The Import Customizer dialog box opens.</li>
abadea@61
   105
  <li>In the Location list, expand the <tt>By File</tt> or <tt>By Namespace</tt> nodes to navigate to and select the WSDL file.<br>
abadea@61
   106
    The Namespace field below the Location list is filled in by the IDE.</li>
abadea@61
   107
  <li>(Optional) In the New Prefix field, type the prefix that you want to use.
abadea@61
   108
  <li>Click OK.</li>
abadea@61
   109
</ol>
abadea@61
   110
<dl>
abadea@61
   111
<dt><a name="seealso">See Also</a></dt>
abadea@61
   112
<dd><a href="nbdocs://org.netbeans.modules.xml.schema.core/org/netbeans/modules/xml/schema/core/tasks/referencingextschemas.html" title="Referencing External Schemas">Referencing External Schemas</a></dd> 
abadea@61
   113
<dd><a href="wsdl_editor_messages.html" title="Configuring WSDL Messages">Configuring WSDL Messages</a></dd>
abadea@61
   114
<dd><a href="wsdl_editor_port_types.html" title="Configuring WSDL Port Types">Configuring WSDL Port Types</a></dd>
abadea@61
   115
<dd><a href="wsdl_editor_bindings.html" title="Configuring WSDL Bindings">Configuring WSDL Bindings</a></dd>
abadea@61
   116
  <dd><a href="wsdl_editor_services.html" title="Configuring WSDL Services">Configuring WSDL Service</a></dd>
abadea@61
   117
</dl>
abadea@61
   118
<hr>
abadea@61
   119
<small>  
abadea@61
   120
<a href="credits.html">Legal Notices</a></small>
abadea@61
   121
<table border="0" cellpadding="150">
abadea@61
   122
<tr><td>&nbsp;</td></tr>
abadea@61
   123
<tr><td>&nbsp;</td></tr>
abadea@61
   124
<tr><td>&nbsp;</td></tr>
abadea@61
   125
</table>
abadea@61
   126
</body>
abadea@61
   127
</html>