| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2015-07-03 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20150703" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Axis – Reference Guide</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <h2>Axis</h2> |
| </div> |
| </div> |
| <div class="pull-right"> <a href="./" id="bannerRight"> |
| <img src="images/axis-small.png" alt="Apache Axis"/> |
| </a> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="http://www.apache.org/" class="externalLink" title="Apache"> |
| Apache</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class=""> |
| <a href="../../" title="Axis"> |
| Axis</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class=""> |
| <a href="../" title="Axis 1.x"> |
| Axis 1.x</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class=""> |
| <a href="./" title="Java"> |
| Java</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">Reference Guide</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2015-07-03</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 1.4.1-SNAPSHOT</li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span3"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">About</li> |
| |
| <li> |
| |
| <a href="index.html" title="Introduction"> |
| <i class="none"></i> |
| Introduction</a> |
| </li> |
| |
| <li> |
| |
| <a href="issue-tracking.html" title="Issue Tracking"> |
| <i class="none"></i> |
| Issue Tracking</a> |
| </li> |
| |
| <li> |
| |
| <a href="mail-lists.html" title="Mailing Lists"> |
| <i class="none"></i> |
| Mailing Lists</a> |
| </li> |
| |
| <li> |
| |
| <a href="source-repository.html" title="Source Repository"> |
| <i class="none"></i> |
| Source Repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="artifacts.html" title="Artifacts & Dependencies"> |
| <i class="none"></i> |
| Artifacts & Dependencies</a> |
| </li> |
| |
| <li> |
| |
| <a href="apiDocs/index.html" title="Javadocs"> |
| <i class="none"></i> |
| Javadocs</a> |
| </li> |
| <li class="nav-header">Downloads</li> |
| |
| <li> |
| |
| <a href="releases.html" title="Releases"> |
| <i class="none"></i> |
| Releases</a> |
| </li> |
| |
| <li> |
| |
| <a href="changelog.html" title="Changelogs"> |
| <i class="icon-chevron-right"></i> |
| Changelogs</a> |
| </li> |
| |
| <li> |
| |
| <a href="snapshots.html" title="Snapshots"> |
| <i class="none"></i> |
| Snapshots</a> |
| </li> |
| <li class="nav-header">Documentation</li> |
| |
| <li> |
| |
| <a href="overview.html" title="Overview"> |
| <i class="none"></i> |
| Overview</a> |
| </li> |
| |
| <li> |
| |
| <a href="install.html" title="Installation"> |
| <i class="none"></i> |
| Installation</a> |
| </li> |
| |
| <li> |
| |
| <a href="user-guide.html" title="User's Guide"> |
| <i class="none"></i> |
| User's Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="developers-guide.html" title="Developer's Guide"> |
| <i class="none"></i> |
| Developer's Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="integration-guide.html" title="Integration Guide"> |
| <i class="none"></i> |
| Integration Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="architecture-guide.html" title="Architecture Guide"> |
| <i class="none"></i> |
| Architecture Guide</a> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="none"></i>Reference Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="reading.html" title="Reading Guide"> |
| <i class="none"></i> |
| Reading Guide</a> |
| </li> |
| <li class="nav-header">More...</li> |
| |
| <li> |
| |
| <a href="ant/ant.html" title="Ant Tasks"> |
| <i class="none"></i> |
| Ant Tasks</a> |
| </li> |
| |
| <li> |
| |
| <a href="maven/index.html" title="Maven Plugins"> |
| <i class="none"></i> |
| Maven Plugins</a> |
| </li> |
| |
| <li> |
| |
| <a href="castor/index.html" title="Castor Databinding"> |
| <i class="none"></i> |
| Castor Databinding</a> |
| </li> |
| |
| <li> |
| |
| <a href="xmlbeans/index.html" title="XmlBeans Databinding"> |
| <i class="none"></i> |
| XmlBeans Databinding</a> |
| </li> |
| |
| <li> |
| |
| <a href="transports/jms/index.html" title="JMS Transport"> |
| <i class="none"></i> |
| JMS Transport</a> |
| </li> |
| |
| <li> |
| |
| <a href="transports/http-hc3/index.html" title="HttpClient 3 Transport"> |
| <i class="none"></i> |
| HttpClient 3 Transport</a> |
| </li> |
| |
| <li> |
| |
| <a href="transports/http-javanet/index.html" title="java.net HTTP Transport"> |
| <i class="none"></i> |
| java.net HTTP Transport</a> |
| </li> |
| |
| <li> |
| |
| <a href="standalone-server/index.html" title="Stand-alone Server"> |
| <i class="none"></i> |
| Stand-alone Server</a> |
| </li> |
| <li class="nav-header">Apache</li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License"> |
| <i class="none"></i> |
| License</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"> |
| <i class="none"></i> |
| Sponsorship</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> |
| <i class="none"></i> |
| Thanks</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/security/" class="externalLink" title="Security"> |
| <i class="none"></i> |
| Security</a> |
| </li> |
| </ul> |
| |
| |
| <form id="search-form" action="http://www.google.com/search" method="get" > |
| |
| <input value="ws.apache.org/axis/java" name="sitesearch" type="hidden"/> |
| <input class="search-query" name="q" id="query" type="text" /> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script> |
| |
| <hr class="divider" /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span9" > |
| |
| <!-- ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. --> |
| |
| |
| <div class="section"> |
| <h2><a name="Table_of_Contents"></a>Table of Contents</h2> |
| |
| |
| <ul> |
| <li><a href="#Table_of_Contents">Table of Contents</a></li> |
| <li><a href="#Tools_Reference">Tools Reference</a> |
| <ul> |
| <li><a href="#WSDL2Java_Reference">WSDL2Java Reference</a></li> |
| <li><a href="#Java2WSDL_Reference">Java2WSDL Reference</a></li></ul></li> |
| <li><a href="#Deployment_WSDD_Reference">Deployment (WSDD) Reference</a></li> |
| <li><a href="#Global_Axis_Configuration">Global Axis Configuration</a></li> |
| <li><a href="#AxisServlet_configuration">AxisServlet configuration</a></li> |
| <li><a href="#Individual_Service_Configuration">Individual Service Configuration</a> |
| <ul> |
| <li><a href="#Service_Element_Attributes">Service Element Attributes</a></li> |
| <li><a href="#Elements_allowed_in_the_Service_element">Elements allowed in the Service element</a></li> |
| <li><a href="#Service_Level_Parameters">Service Level Parameters</a></li></ul></li> |
| <li><a href="#Individual_Operation_Configuration">Individual Operation Configuration</a> |
| <ul> |
| <li><a href="#Operation_Attributes">Operation Attributes</a></li> |
| <li><a href="#Elements_allowed_in_the_Operation_Element">Elements allowed in the Operation Element</a></li></ul></li> |
| <li><a href="#Axis_Logging_Configuration">Axis Logging Configuration</a> |
| <ul> |
| <li><a href="#Log_Categories">Log Categories</a></li></ul></li> |
| <li><a href="#Pre-Configured_Axis_Components_Reference">Pre-Configured Axis Components Reference</a> |
| <ul> |
| <li><a href="#On_the_server">On the server</a></li> |
| <li><a href="#On_the_client">On the client</a></li></ul></li></ul> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Tools_Reference"></a>Tools Reference</h2> |
| |
| |
| <div class="section"> |
| <h3><a name="WSDL2Java_Reference"></a>WSDL2Java Reference</h3> |
| |
| |
| <div class="source"> |
| <pre>Usage: java org.apache.axis.wsdl.WSDL2Java [options] WSDL-URI |
| Options: |
| |
| -h, --help |
| print this message and exit |
| -v, --verbose |
| print informational messages |
| -n, --noImports |
| only generate code for the immediate WSDL document |
| -O, --timeout <argument> |
| timeout in seconds (default is 45, specify -1 to disable) |
| -D, --Debug |
| print debug information |
| -W, --noWrapped |
| turn off support for "wrapped" document/literal |
| -s, --server-side |
| emit server-side bindings for web service |
| -S, --skeletonDeploy <argument> |
| deploy skeleton (true) or implementation (false) in |
| deploy.wsdd. |
| Default is false. Assumes --server-side. |
| -N, --NStoPkg <argument>=<value> |
| mapping of namespace to package |
| -f, --fileNStoPkg <argument> |
| file of NStoPkg mappings (default NStoPkg.properties) |
| -p, --package <argument> |
| override all namespace to package mappings, use this package |
| name instead |
| -o, --output <argument> |
| output directory for emitted files |
| -d, --deployScope <argument> |
| add scope to deploy.xml: "Application", "Request", "Session" |
| -t, --testCase |
| emit junit testcase class for web service |
| -a, --all |
| generate code for all elements, even unreferenced ones |
| -T, --typeMappingVersion |
| indicate 1.1 or 1.2. The default is 1.1 (SOAP 1.1 JAX-RPC compliant. |
| 1.2 indicates SOAP 1.1 encoded.) |
| -F, --factory <argument> |
| name of a custom class that implements GeneratorFactory interface |
| (for extending Java generation functions) |
| -i, --nsInclude <namespace> |
| namescape to specifically include in the generated code (defaults to |
| all namespaces unless specifically excluded with the -x option) |
| -x, --nsExclude <namespace> |
| namespace to specifically exclude from the generated code (defaults to |
| none excluded until first namespace included with -i option) |
| -p, --property <name>=<value> |
| name and value of a property for use by the custom GeneratorFactory |
| -H, --helperGen |
| emits separate Helper classes for meta data |
| -U, --user <argument> |
| username to access the WSDL-URI |
| -P, --password <argument> |
| password to access the WSDL-URI |
| -c, --implementationClassName <argument> |
| use this as the implementation class |
| -w, --wrapArrays |
| Prefer generating JavaBean classes like "ArrayOfString" for certain schema array patterns (default is to use String []) |
| </pre></div> |
| |
| |
| <dl> |
| |
| |
| <dt>-h, --help</dt> |
| |
| <dd>Print the usage statement and exit</dd> |
| |
| |
| <dt>-v, --verbose</dt> |
| |
| <dd>See what the tool is generating as it is generating it.</dd> |
| |
| |
| <dt>-n, --noImports</dt> |
| |
| <dd>Only generate code for the WSDL document that appears on the command line. The default behaviour is to generate files for all WSDL documents, the immediate one and all imported ones.</dd> |
| |
| |
| <dt>-O, --timeout</dt> |
| |
| <dd>Timeout in seconds. The default is 45. Use -1 to disable the timeout.</dd> |
| |
| |
| <dt>-D, --Debug</dt> |
| |
| <dd>Print debug information, which currently is WSDL2Java's symbol table. Note that this is only printed after the symbol table is complete, ie., after the WSDL is parsed successfully.</dd> |
| |
| |
| <dt>-W, --noWrapped</dt> |
| |
| <dd>This turns off the special treatment of what is called "wrapped" document/literal style operations. By default, WSDL2Java will recognize the following conditions: |
| |
| <ul> |
| |
| <li>If an input message has is a single part.</li> |
| |
| <li>The part is an element.</li> |
| |
| <li>The element has the same name as the operation</li> |
| |
| <li>The element's complex type has no attributes<br /></li> |
| </ul> |
| When it sees this, WSDL2Java will 'unwrap' the top level element, and treat each of the components of the element as arguments to the operation. This type of WSDL is the default for Microsoft .NET web services, which wrap up RPC style arguments in this top level schema element.</dd> |
| |
| |
| <dt>-s, --server-side</dt> |
| |
| <dd>Emit the server-side bindings for the web service: |
| |
| <ul> |
| |
| <li>a skeleton class named <bindingName>Skeleton. This may or may not be emitted (see -S, --skeletonDeploy).</li> |
| |
| <li>an implementation template class named <bindingName>Impl. Note that, if this class already exists, then it is not emitted.</li> |
| |
| <li>deploy.wsdd</li> |
| |
| <li>undeploy.wsdd</li> |
| </ul> |
| </dd> |
| |
| |
| <dt>-S, --skeletonDeploy <argument></dt> |
| |
| <dd>Deploy either the skeleton (true) or the implementation (false) in deploy.wsdd. In other words, for "true" the service clause in the deploy.wsdd file will look something like: |
| |
| <div class="source"> |
| <pre><service name="AddressBook" provider="java:RPC"> |
| <parameter name="className" value="samples.addr.AddressBookSOAPBindingSkeleton"/> |
| ... |
| </service></pre></div> |
| and for "false" it would look like: |
| |
| <div class="source"> |
| <pre><service name="AddressBook" provider="java:RPC"> |
| <parameter name="className" value="samples.addr.AddressBookSOAPBindingImpl"/> |
| ... |
| </service></pre></div> |
| The default for this option is false. When you use this option, the --server-side option is assumed, so you don't have to explicitly specify --server-side as well.</dd> |
| |
| |
| <dt>-N, --NStoPkg <argument>=<value></dt> |
| |
| <dd>By default, package names are generated from the namespace strings in the WSDL document in a magical manner (typically, if the namespace is of the form "http://x.y.com" or "urn:x.y.com" the corresponding package will be "com.y.x"). If this magic is not what you want, you can provide your own mapping using the --NStoPkg argument, which can be repeated as often as necessary, once for each unique namespace mapping. For example, if there is a namespace in the WSDL document called "urn:AddressFetcher2", and you want files generated from the objects within this namespace to reside in the package samples.addr, you would provide the following option to WSDL2Java: |
| |
| <div class="source"> |
| <pre>--NStoPkg urn:AddressFetcher2=samples.addr</pre></div> |
| (Note that if you use the short option tag, "-N", then there must not be a space between "-N" and the namespace.)</dd> |
| |
| |
| <dt>-f, --fileNStoPkg <argument></dt> |
| |
| <dd>If there are a number of namespaces in the WSDL document, listing a mapping for them all could become tedious. To help keep the command line terse, WSDL2Java will also look for mappings in a properties file. By default, this file is named "NStoPkg.properties" and it must reside in the default package (ie., no package). But you can explicitly provide your own file using the --fileNStoPkg option.<br /><br /> |
| The entries in this file are of the same form as the arguments to the --NStoPkg command line option. For example, instead of providing the command line option as above, we could provide the same information in NStoPkg.properties: |
| |
| <div class="source"> |
| <pre>urn\:AddressFetcher2=samples.addr</pre></div> |
| (Note that the colon must be escaped in the properties file.)<br /><br /> |
| If an entry for a given mapping exists both on the command line and in the properties file, the command line entry takes precedence.</dd> |
| |
| |
| <dt>-p, --package <argument></dt> |
| |
| <dd>This is a shorthand option to map all namespaces in a WSDL document to the same Java package name. This can be useful, but dangerous. You must make sure that you understand the effects of doing this. For instance there may be multiple types with the same name in different namespaces. It is an error to use the --NStoPkg switch and --package at the same time.</dd> |
| |
| |
| <dt>-o, --output <argument></dt> |
| |
| <dd>The root directory for all emitted files.</dd> |
| |
| |
| <dt>-d, --deployScope <argument></dt> |
| |
| <dd>Add scope to deploy.wsdd: "Application", "Request", or "Session". If this option does not appear, no scope tag appears in deploy.wsdd, which the Axis runtime defaults to "Request".</dd> |
| |
| |
| <dt>-t, --testCase</dt> |
| |
| <dd>Generate a client-side JUnit test case. This test case can stand on its own, but it doesn't really do anything except pass default values (null for objects, 0 or false for primitive types). Like the generated implementation file, the generated test case file could be considered a template that you may fill in.</dd> |
| |
| |
| <dt>-a, --all</dt> |
| |
| <dd>Generate code for all elements, even unreferenced ones. By default, WSDL2Java only generates code for those elements in the WSDL file that are referenced.<br /><br /> |
| A note about what it means to be referenced. We cannot simply say: start with the services, generate all bindings referenced by the service, generate all portTypes referenced by the referenced bindings, etc. What if we're generating code from a WSDL file that only contains portTypes, messages, and types? If WSDL2Java used service as an anchor, and there's no service in the file, then nothing will be generated. So the anchor is the lowest element that exists in the WSDL file in the order: |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li>types</li> |
| |
| <li>portTypes</li> |
| |
| <li>bindings</li> |
| |
| <li>services</li> |
| </ol> |
| For example, if a WSDL file only contained types, then all the listed types would be generated. But if a WSDL file contained types and a portType, then that portType will be generated and only those types that are referenced by that portType.<br /><br /> |
| Note that the anchor is searched for in the WSDL file appearing on the command line, <b>not</b> in imported WSDL files. This allows one WSDL file to import constructs defined in another WSDL file without the nuisance of having all the imported WSDL file's constructs generated.</dd> |
| |
| |
| <dt>-T, --typeMappingVersion <argument></dt> |
| |
| <dd>Indicate 1.1 or 1.2. The default is 1.2 (SOAP 1.2 JAX-RPC compliant).</dd> |
| |
| |
| <dt>-F, --factory <argument></dt> |
| |
| <dd>Used to extend the functionality of the WSDL2Java emitter. The argument is the name of a class which extends JavaWriterFactory.</dd> |
| |
| |
| <dt>-H, --helperGen</dt> |
| |
| <dd>Emits separate Helper classes for meta data.</dd> |
| |
| |
| <dt>-U, --user <argument></dt> |
| |
| <dd>This username is used in resolving the WSDL-URI provided as the input to WSDL2Java. If the URI contains a username, this will override the command line switch. An example of a URL with a username and password is: <tt>http://user:password@hostname:port/path/to/service?WSDL</tt></dd> |
| |
| |
| <dt>-P, --password <argument></dt> |
| |
| <dd>This password is used in resolving the WSDL-URI provided as the input to WSDL2Java. If the URI contains a password, this will override the command line switch.</dd> |
| |
| |
| <dt> -c, --implementationClassName <argument></dt> |
| |
| <dd>Set the name of the implementation class.Especially useful when exporting an existing class as a web service using java2wsdl followed by wsdl2java. If you are using the skeleton deploy option you must make sure, after generation, that your implementation class implements the port type name interface generated by wsdl2java. You should also make sure that all your exported methods throws java.lang.RemoteException.</dd> |
| |
| |
| <dt>-w, --wrapArrays</dt> |
| |
| <dd>When processing a schema like this: |
| |
| <div class="source"> |
| <pre> |
| <element name="array"> |
| <complexType> |
| <sequence> |
| <element name="item" type="xs:string"/> |
| </sequence> |
| </complexType> |
| </element> |
| </pre></div> |
| The default behavior (as of Axis 1.2 final) is to map this XML construct to a Java String array (String[]). If you would rather a specific JavaBean class (i.e. ArrayOfString) be generated for these types of schemas, you may specify the -w or --wrapArrays option.</dd> |
| |
| </dl> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h3><a name="Java2WSDL_Reference"></a>Java2WSDL Reference</h3> |
| |
| |
| <p>Here is the help message generated from the current tool:</p> |
| |
| <div class="source"> |
| <pre> |
| Java2WSDL emitter |
| Usage: java org.apache.axis.wsdl.Java2WSDL [options] class-of-portType |
| Options: |
| -h, --help |
| print this message and exit |
| -I, --input <argument> |
| input WSDL filename |
| -o, --output <argument> |
| output WSDL filename |
| -l, --location <argument> |
| service location url |
| -P, --portTypeName <argument> |
| portType name (obtained from class-of-portType if not specified) |
| -b, --bindingName <argument> |
| binding name (--servicePortName value + "SOAPBinding" if not specified) |
| -S, --serviceElementName <argument> |
| service element name (defaults to --servicePortName value + "Service") |
| -s, --servicePortName <argument> |
| service port name (obtained from --location if not specified) |
| -n, --namespace <argument> |
| target namespace |
| -p, --PkgtoNS <argument>=<value> |
| package=namespace, name value pairs |
| -m, --methods <argument> |
| space or comma separated list of methods to export |
| -a, --all |
| look for allowed methods in inherited class |
| -w, --outputWsdlMode <argument> |
| output WSDL mode: All, Interface, Implementation |
| -L, --locationImport <argument> |
| location of interface wsdl |
| -N, --namespaceImpl <argument> |
| target namespace for implementation wsdl |
| -O, --outputImpl <argument> |
| output Implementation WSDL filename, setting this causes |
| --outputWsdlMode to be ignored |
| -i, --implClass <argument> |
| optional class that contains implementation of methods in class-of-portType. |
| The debug information in the class is used |
| to obtain the method parameter names, which are used to set |
| the WSDL part names. |
| -x, --exclude <argument> |
| space or comma separated list of methods not to export |
| -c, --stopClasses <argument> |
| space or comma separated list of class names which will stop |
| inheritance search if --all switch is given |
| -T, --typeMappingVersion <argument> |
| indicate 1.1 or 1.2. The default is 1.1 (SOAP 1.1 JAX-RPC |
| compliant 1.2 indicates SOAP 1.1 encoded.) |
| -A, --soapAction <argument> |
| value of the operation's soapAction field. Values are DEFAULT, |
| OPERATION or NONE. OPERATION forces soapAction to the name |
| of the operation. DEFAULT causes the soapAction to be set |
| according to the operation's meta data (usually ""). NONE forces |
| the soapAction to "". The default is DEFAULT. |
| -y, --style <argument> |
| The style of binding in the WSDL, either DOCUMENT, RPC, or WRAPPED. |
| -u, --use <argument> |
| The use of items in the binding, either LITERAL or ENCODED |
| -e, --extraClasses <argument> |
| A space or comma separated list of class names to be added to |
| the type section. |
| -C, --importSchema |
| A file or URL to an XML Schema that should be physically |
| imported into the generated WSDL |
| -X, --classpath |
| additional classpath elements |
| Details: |
| portType element name= <--portTypeName value> OR <class-of-portType name> |
| binding element name= <--bindingName value> OR <--servicePortName value> |
| Soap Binding |
| service element name= <--serviceElementName value> OR <--portTypeName value> |
| Service |
| port element name= <--servicePortName value> |
| address location = <--location value> |
| </pre></div> |
| |
| |
| <dl> |
| |
| |
| <dt>-h , --help</dt> |
| |
| <dd>Prints the help message.</dd> |
| |
| |
| <dt>-I, --input <WSDL file></dt> |
| |
| <dd>Optional parameter that indicates the name of the input wsdl file. The output wsdl file will contain everything from the input wsdl file plus the new constructs. If a new construct is already present in the input wsdl file, it is not added. This option is useful for constructing a wsdl file with multiple ports, bindings, or portTypes.</dd> |
| |
| |
| <dt>-o, --output <WSDL file></dt> |
| |
| <dd>Indicates the name of the output WSDL file. If not specified, a suitable default WSDL file is written into the current directory.</dd> |
| |
| |
| <dt>-l, --location <location></dt> |
| |
| <dd>Indicates the url of the location of the service. The name after the last slash or backslash is the name of the service port (unless overridden by the -s option). The service port address location attribute is assigned the specified value.</dd> |
| |
| |
| <dt>-P, --portTypeName <name></dt> |
| |
| <dd>Indicates the name to use for the portType element. If not specified, the class-of-portType name is used.</dd> |
| |
| |
| <dt>-b, --bindingName <name></dt> |
| |
| <dd>Indicates the name to use for the binding element. If not specified, the value of the --servicePortName + "SoapBinding" is used.</dd> |
| |
| |
| <dt>-S, --serviceElementName <name></dt> |
| |
| <dd>Indicates the name of the service element. If not specified, the service element is the <portTypeName>Service. </dd> |
| |
| |
| <dt>-s, --servicePortName <name></dt> |
| |
| <dd>Indicates the name of the service port. If not specified, the service port name is derived from the --location value. </dd> |
| |
| |
| <dt>-n, --namespace <target namespace></dt> |
| |
| <dd>Indicates the name of the target namespace of the WSDL.</dd> |
| |
| |
| <dt>-p, --PkgToNS <package> <namespace></dt> |
| |
| <dd>Indicates the mapping of a package to a namespace. If a package is encountered that does not have a namespace, the Java2WSDL emitter will generate a suitable namespace name. This option may be specified multiple times.</dd> |
| |
| |
| <dt>-m, --methods <arguments></dt> |
| |
| <dd>If this option is specified, only the indicated methods in your interface class will be exported into the WSDL file. The methods list must be comma separated. If not specified, all methods declared in the interface class will be exported into the WSDL file.</dd> |
| |
| |
| <dt>-a, --all</dt> |
| |
| <dd>If this option is specified, the Java2WSDL parser will look into extended classes to determine the list of methods to export into the WSDL file.</dd> |
| |
| |
| <dt>-w, --outputWSDLMode <mode></dt> |
| |
| <dd>Indicates the kind of WSDL to generate. Accepted values are: |
| |
| <ul> |
| |
| <li>All --- (default) Generates wsdl containing both interface and implementation WSDL constructs.</li> |
| |
| <li>Interface --- Generates a WSDL containing the interface constructs (no service element).</li> |
| |
| <li>Implementation -- Generates a WSDL containing the implementation. The interface WSDL is imported via the -L option.</li> |
| </ul> |
| </dd> |
| |
| |
| <dt>-L, --locationImport <url></dt> |
| |
| <dd>Used to indicate the location of the interface WSDL when generating an implementation WSDL.</dd> |
| |
| |
| <dt>-N, --namespaceImpl <namespace></dt> |
| |
| <dd>Namespace of the implementation WSDL.</dd> |
| |
| |
| <dt>-O, --outputImpl <WSDL file></dt> |
| |
| <dd>Use this option to indicate the name of the output implementation WSDL file. If specified, Java2WSDL will produce interface and implementation WSDL files. If this option is used, the -w option is ignored.</dd> |
| |
| |
| <dt>-i, --implClass <impl-class></dt> |
| |
| <dd>Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class.</dd> |
| |
| |
| <dt>-x, --exclude <list></dt> |
| |
| <dd>List of methods to not exclude from the wsdl file.</dd> |
| |
| |
| <dt>-c, --stopClasses <list></dt> |
| |
| <dd>List of classes which stop the Java2WSDL inheritance search.</dd> |
| |
| |
| <dt>-T, --typeMappingVersion <version></dt> |
| |
| <dd>Choose the default type mapping registry to use. Either 1.1 or 1.2.</dd> |
| |
| |
| <dt>-A, --soapAction <argument></dt> |
| |
| <dd>The value of the operations soapAction field. Values are DEFAULT, OPERATION or NONE. OPERATION forces soapAction to the name of the operation. DEFAULT causes the soapAction to be set according to the operation's meta data (usually ""). NONE forces the soapAction to "". The default is DEFAULT.</dd> |
| |
| |
| <dt>-y, --style <argument></dt> |
| |
| <dd>The style of the WSDL document: RPC, DOCUMENT or WRAPPED. The default is RPC. If RPC is specified, an rpc wsdl is generated. If DOCUMENT is specified, a document wsdl is generated. If WRAPPED is specified, a document/literal wsdl is generated using the wrapped approach. Wrapped style forces the use attribute to be literal.</dd> |
| |
| |
| <dt>-u, --use <argument></dt> |
| |
| <dd>The use of the WSDL document: LITERAL or ENCODED. If LITERAL is specified, the XML Schema defines the representation of the XML for the request. If ENCODED is specified, SOAP encoding is specified in the generated WSDL.</dd> |
| |
| |
| <dt>-e, --extraClasses <argument></dt> |
| |
| <dd>Specify a space or comma seperated list of class names which should be included in the <b>types</b> section of the WSDL document. This is useful in the case where your service interface references a base class and you would like your WSDL to contain XML Schema type defintions for these other classes. The --extraClasses option can be specified duplicate times. Each specification results in the additional classes being added to the list.</dd> |
| |
| |
| <dt>-C, --importSchema</dt> |
| |
| <dd>A file or URL to an XML Schema that should be physically imported into the generated WSDL</dd> |
| |
| |
| <dt>-X, --classpath</dt> |
| |
| <dd>Additional classpath elements</dd> |
| |
| </dl> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Deployment_WSDD_Reference"></a>Deployment (WSDD) Reference</h2> |
| |
| |
| <p>Note : all the elements referred to in this section are in the WSDD namespace, namely "http://xml.apache.org/axis/wsdd/".</p> |
| |
| |
| <dl> |
| |
| |
| <dt><deployment></dt> |
| |
| <dd>The root element of the deployment document which tells the Axis engine that this is a deployment. A deployment document may represent EITHER a complete engine configuration OR a set of components to deploy into an active engine.</dd> |
| |
| |
| <dt><GlobalConfiguration></dt> |
| |
| <dd>This element is used to control the engine-wide configuration of Axis. It may contain several subelements: |
| |
| <ul> |
| |
| <li><b><parameter></b> : This is used to set options on the Axis engine - see the <a href="#GlobalAxisConfiguration">Global Axis Configuration</a> section below for more details. Any number of <b><parameter></b> elements may appear.</li> |
| |
| <li><b><role></b> : This is used to set a SOAP actor/role URI which the engine will recognize. This allows SOAP headers targeted at that role to be successfully processed by the engine. Any number of <b><role></b> elements may appear.</li> |
| |
| <li><b><requestFlow></b> : This is used to configure global request Handlers, which will be invoked before the actual service on every request.</li> |
| |
| <li><b><responseFlow></b> : This is used to configure global response Handlers, which will be invoked after the actual service on every request.</li> |
| </ul> |
| </dd> |
| |
| |
| <dt><requestFlow [name="<i>name</i>"] [type="<i>type</i>"] ></dt> |
| |
| <dd>This is used to configure handlers in request flow. You may put any number of <b><handler></b> or |
| <b><chain></b> elements (see below) inside the <b><requestFlow></b>, |
| but there may only be one <b><requestFlow></b>.</dd> |
| |
| |
| <dt><responseFlow [name="<i>name</i>"] [type="<i>type</i>"] ></dt> |
| |
| <dd>This is used to configure handlers in response flow. You may put any number of <b><handler></b> or |
| <b><chain></b> elements (see below) inside the <b><responseFlow></b>, |
| but there may only be one <b><responseFlow></b>.</dd> |
| |
| |
| <dt><undeployment></dt> |
| |
| <dd>The root element of the deployment document which tells Axis that this is an undeployment.</dd> |
| |
| |
| <dt><handler [name="<i>name</i>"] type="<i>type</i>"></dt> |
| |
| <dd>Belongs at the top level inside a <b><deployment></b> or <b><undeployment></b>, or inside a <b><chain></b>, <b><requestFlow></b>, or <b><responseFlow></b>. Defines a Handler, and indicates the type of the handler. "Type" is either the name of another previously defined Handler, or a QName of the form "<b>java:<i>class.name</i></b>". The optional "name" attribute allows you to refer to this Handler definition in other parts of the deployment. May contain an arbitrary number of <b><parameter name="<i>name</i>" value="<i>value</i>"></b> elements, each of which will supply a parameter to the deployed Handler.</dd> |
| |
| |
| <dt><service name="<i>name</i>" provider="<i>provider</i>" ></dt> |
| |
| <dd>Deploys/undeploys an Axis Service. This is the most complex WSDD tag, so we're going to spend a little time on it.<br /><br /> |
| <b>Options</b> may be specified as follows : <tt><b><parameter name="</b>name<b>" value="</b>value<b>"/></b></tt>, and common ones include: |
| |
| <ul> |
| |
| <li><b>className</b> : the backend implementation class</li> |
| |
| <li><b>allowedMethods</b> : Each provider can determine which methods are allowed to be exposed as web services.<br /> |
| To summaries for Axis supplied providers: |
| |
| <p><u>Java RPC Provider</u> (provider="java:RPC") by default all public methods specified by the class in the className option, including any inherited methods are available as web services.<br /> |
| For more details regarding the Java Provider please see <b>WHERE???</b>.</p> |
| |
| <p><u>Java MsgProvder</u> (provider="java:MSG") <!-- Glen to provide details --></p> |
| |
| <p>In order to further restrict the above methods, the <b>allowedMethods</b> option may be used to specify in a space delimited list the names of only those methods which are allowed as web services. It is also possible to specify for this option the value <b>"*"</b> which is functionally equivalent to not specify the option at all. Also, it is worth mentioning that the <b>operation</b> element is used to further define the methods being offered, but it does not affect which methods are made available.</p> |
| |
| <p><i>Note, while this is true for Axis supplied providers, it is implementation dependent on each individual provider. Please review your providers |
| documentation on how or if it supports this option.</i></p> |
| |
| <p><b><u>Note, Exposing any web service has security implications.</u></b><br />As a best practices guide it is <u>highly</u> recommend when offering a web service in unsecure environment to restrict allowed methods to only those required for the service being offered. And, for those that are made available, to <b>fully</b> understand their function and how they may access and expose your systems's resources.</p> |
| </li> |
| |
| <li><b>allowedRoles</b> : comma-separated list of roles allowed to access this service. (Note that these are security roles, as opposed to SOAP roles. Security roles control access, SOAP roles control which SOAP headers are processed.)</li> |
| |
| <li><b>extraClasses</b> : Specify a space or comma seperated list of class names which should be included in the <b>types</b> section of the WSDL document. This is useful in the case where your service interface references a base class and you would like your WSDL to contain XML Schema type defintions for these other classes.</li> |
| </ul> |
| If you wish to define handlers which should be invoked either before or after the service's provider, you may do so with the <b><requestFlow></b> and the <b><responseFlow></b> subelements. Either of those elements may be specified inside the <b><service></b> element, and their semantics are identical to the <b><chain></b> element described below - in other words, they may contain <b><handler></b> and <b><chain</b>> elements which will be invoked in the order they are specified.<br /> |
| To control the <a class="externalLink" href="http://www.w3.org/TR/2003/REC-soap12-part1-20030624/#soaproles">roles</a> that should be recognized by your service Handlers, you can specify any number of <b><role></b> elements inside the service declaration.<br /> |
| Example:<br /> |
| |
| <div class="source"> |
| <pre><service name="test"> |
| <parameter name="className" value="test.Implementation"/> |
| <parameter name="allowedMethods" value="*"/> |
| <namespace>http://testservice/</namespace> |
| <role>http://testservice/MyRole</role> |
| <requestFlow> <!-- Run these before processing the request --> |
| <handler type="java:MyHandlerClass"/> |
| <handler type="somethingIDefinedPreviously"/> |
| </requestFlow> |
| </service> |
| </pre></div> |
| Metadata may be specified about particular operations in your service by using the <operation> tag inside a service. This enables you to map the java parameter names of a method to particular XML names, to specify the parameter modes for your parameters, and to map particular XML names to particular operations.<br /><br /> |
| |
| <div class="source"> |
| <pre><operation name="method"> |
| </operation></pre></div> |
| </dd> |
| |
| |
| <dt><chain name="<i>name</i>"> <<i>subelement</i>/>... </chain></dt> |
| |
| <dd>Defines a chain. Each <i>handler</i> (i.e. deployed handler name) in the list will be invoked() in turn when the chain is invoked. This enables you to build up "modules" of commonly used functionality. The subelements inside chains may be <<b>handler</b>>s or <<b>chain</b>>s. <handler>s inside a <chain> may either be defined in terms of their Java class: |
| |
| <div class="source"> |
| <pre><chain name="myChain"> |
| <handler type="java:org.apache.axis.handlers.LogHandler"/> |
| </chain> |
| </pre></div> |
| or may refer to previously defined <handlers>, with the "type" of the handler referring to the name of the other handler definition: |
| |
| <div class="source"> |
| <pre><handler name="logger" type="java:org.apache.axis.handlers.LogHandler"/> |
| <chain name="myChain"/> |
| <handler type="logger"/> |
| </chain></pre></div> |
| </dd> |
| |
| |
| <dt><transport name="<i>name</i>"></dt> |
| |
| <dd>Defines a transport on the server side. Server transports are invoked when an incoming request arrives. A server transport may define <b><requestFlow></b> and/or <b><responseFlow></b> elements to specify handlers/chains which should be invoked during the request (i.e. incoming message) or response (i.e. outgoing message) portion of processing (this function works just like the <b><service></b> element above). Typically handlers in the transport request/response flows implement transport-specific functionality, such as parsing protocol headers, etc.<br /><br /> |
| For any kind of transport (though usually this relates to HTTP transports), users may allow Axis servlets to perform arbitrary actions (by means of a "plug-in") when specific query strings are passed to the servlet (see the section <a href="developers-guide.html#AxisServletQueryStringPlug-ins"> Axis Servlet Query String Plug-ins</a> in the <a href="developers-guide.html">Axis Developer's Guide</a> for more information on what this means and how to create a plug-in). When the name of a query string handler class is known, users can enable it by adding an appropriate <b><parameter></b> element in the Axis server configuration's <b><transport></b> element. An example configuration might look like the following: |
| |
| <div class="source"> |
| <pre><transport name="http"> |
| <parameter name="useDefaultQueryStrings" value="false" /> |
| <parameter name="qs.name" value="class.name" /> |
| </transport></pre></div> |
| In this example, the query string that the Axis servlet should respond to is <i>?name</i> and the class that it should invoke when this query string is encountered is named <tt>class.name</tt>. The <tt>name</tt> attribute of the <b><parameter></b> element must start with the string |
| "qs." to indicate that this <b><parameter></b> element defines a query string handler. The <tt>value</tt> attribute must point to the name of a class implementing the <tt>org.apache.axis.transport.http.QSHandler</tt> interface. By default, Axis provides for three Axis servlet query string handlers (<i>?list</i>, <i>?method</i>, and <i>?wsdl</i>). See the Axis server configuration file for their definitions. If the user wishes not to use these default query string handlers (as in the example), a <b><parameter></b> element with a <tt>name</tt> attribute equal to |
| "useDefaultQueryStrings" should have its <tt>value</tt> attribute set to <tt>false</tt>. By default it is set to <tt>true</tt> and the element is not necessary if the user wishes to have this default behavior.</dd> |
| |
| |
| <dt><transport name="<i>name</i>" pivot="<i>handler type</i>"></dt> |
| |
| |
| <dd>Defines a transport on the client side, which is invoked when sending a SOAP message. The "pivot" attribute specifies a Handler to be used as the actual sender for this transport (for example, the HTTPSender). Request and response flows may be specified as in server-side transports to do processing on the request (i.e. outgoing message) or response (i.e. incoming message).</dd> |
| |
| |
| <dt><typeMapping qname="<i>ns:localName</i>" type="<i>java:classname</i>" serializer="<i>classname</i>" deserializer="<i>classname</i>"/></dt> |
| |
| |
| <dd>Each typeMapping maps an XML qualified name to/from a Java class, using a specified Serializer and Deserializer.</dd> |
| |
| |
| <dt><beanMapping qname="<i>ns:localName</i>" type="<i>java:classname</i>"></dt> |
| |
| <dd>A simplified type mapping, which uses pre-defined serializers/deserializers to encode/decode JavaBeans. The class named by "classname" must follow the JavaBean standard pattern of get/set accessors.</dd> |
| |
| |
| <dt><arrayMapping qname="<i>ns:localName</i>" type="<i>java:classname</i>" innerType="<i>ns:innerTypeQName</i>"></dt> |
| |
| <dd>A specialized type mapping, which uses pre-defined serializers/deserializers to encode/decode Arrays. The class named by "classname" must be an array type (ie name ending with "[]").</dd> |
| |
| |
| <dt><documentation></dt> |
| |
| <dd>Can be used inside a <b><service></b>, an <b><operation></b> or an operation <b><parameter></b>. The content of the element is arbitrary text which will be put in the generated wsdl inside a wsdl:document element.<br /><br /> |
| Example: |
| |
| <div class="source"> |
| <pre><operation name="echoString" > |
| <documentation>This operation echoes a string</documentation> |
| <parameter name="param"> |
| <documentation>a string</documentation> |
| </parameter> |
| </operation> </pre></div> |
| </dd> |
| |
| </dl> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Global_Axis_Configuration"></a>Global Axis Configuration</h2> |
| |
| |
| <p>The server is configured (by default) by values in the server-config.wsdd file, though a dedicated Axis user can write their own configuration handler, and so store configuration data in an LDAP server, database, remote web service, etc. Consult the source on details as to how to do that. You can also add options to the web.xml file and have them picked up automatically. We don't encourage that as it is nice to keep configuration stuff in one place.</p> |
| |
| |
| <p>In the server-config file, there is a global configuration section, which supports parameter name/value pairs as nested elements. Here are the options that we currently document, though there may be more (consult the source, as usual).</p> |
| |
| |
| <div class="source"> |
| <pre><globalConfiguration> |
| <parameter name="adminPassword" value="admin"/> |
| <parameter name="axis.servicesPath" value="/services/"/> |
| <parameter name="attachments.Directory" value="c:\temp\attachments"/> |
| <parameter name="sendMultiRefs" value="true"/> |
| <parameter name="sendXsiTypes" value="true"/> |
| <parameter name="attachments.implementation" |
| value="org.apache.axis.attachments.AttachmentsImpl"/> |
| <parameter name="sendXMLDeclaration" value="true"/> |
| <parameter name="enable2DArrayEncoding" value="true"/> |
| <parameter name="dotNetSoapEncFix" value="false"/> |
| </globalConfiguration> |
| </pre></div> |
| |
| |
| <table border="0" class="table table-striped"> |
| <tbody> |
| |
| <tr class="a"> |
| |
| <td><b>adminPassword</b></td> |
| |
| <td>Adminstrator password, as used by AdminService.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>attachments.Directory</b></td> |
| |
| <td>The directory where attachments end up. This should be in the syntax appropriate for the target platform.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>attachments.implementation</b></td> |
| |
| <td>Name of class that implements attachments support. Default is <tt>org.apache.axis.attachments.AttachmentsImpl</tt></td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>axis.enableListQuery</b></td> |
| |
| <td>Flag to enable the "list the WSDD" feature. Set to false by default, because listing the current system config can expose information (such as the adminservice password) that one does not want widely avaialable.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>axis.disableServiceList</b></td> |
| |
| <td>Flag to disable the list of services feature. Set to false by default, which enables the list of services by the AxisServlet when a GET request is performed on the servlet root.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>axis.servicesPath</b></td> |
| |
| <td>Path to the Axis servlet. This should be the same as the services servlet-mapping defined in web.xml. Used for displaying the list of services. Default is "/services/".</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>axis.Compiler</b></td> |
| |
| <td>Compiler adapter classname for JWS compilation. Default is <tt>org.apache.axis.components.compiler.Javac</tt>; change this to <tt>org.apache.axis.components.compiler.Jikes</tt> to invoke jikes instead.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>axis.development.system</b></td> |
| |
| <td>Flag to switch the system from <i>production</i> (false) to <i>development</i> (true). A development system gives out stack traces and other information that production boxes should not.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>axis.xmlEncoding</b></td> |
| |
| <td>Encoding used for XML messages -either UTF-8 (default) or UTF-16</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>axis.engineConfigClass</b></td> |
| |
| <td>Name of a class that provides Axis configuration. Implement a new class implementing <tt>EngineConfiguration</tt> and name it here to use |
| alternate configuration mechanisms.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>axis.sendMinimizedElements</b></td> |
| |
| <td>Flag to turn on support for a when .NET1.0 can't correctly handle some bits of XML <a class="externalLink" href="http://issues.apache.org/jira/secure/ViewIssue.jspa?key=AXIS-667">that it should.</a> The flag defaults to true; if some .NET clients are failing to handle a Web Service returning an empty array inside another object, set this flag to <i>false</i>.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>enable2DArrayEncoding</b></td> |
| |
| <td>Set this to "true" to turn 2D array encoding on; this encoding is incompatible with .NET 1.0: default="false".</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>sendMultiRefs</b></td> |
| |
| <td>true/false flag to control whether multirefs are sent or not.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>sendXMLDeclaration</b></td> |
| |
| <td>true/false flag to control whether the <?xml?> declaration is sent in messages</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>sendXsiTypes</b></td> |
| |
| <td>true/false flag to enable/disable sending the type of every value sent over the wire. Defaults to true.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>SingleSOAPVersion</b></td> |
| |
| <td>When set to either "1.1" or "1.2", this configures the engine to only accept the specified SOAP version. Attempts to connect to the engine using another version will result in a fault.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>use-servlet-security</b></td> |
| |
| <td>Set this flag to hand authentication off to the servlet container.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>dotNetSoapEncFix</b></td> |
| |
| <td>Set this flag to true to turn on a preference for the XML Schema (xsd) types in the |
| Axis engine. This improved interop with .NET. In particular, .NET seems to have problems |
| accepting SOAP encoded types (soapenc) in arrays. Due to bugs in the Axis 1.1 type mapping |
| system, Axis generally perferred the schema types. Axis 1.2 now correctly uses the SOAP |
| encoded types when it is using SOAP encoding for a service. See JAX-RPC 1.1, section 4.2.1. |
| Note: You can also set this flag by setting the static property on the TypeMappingImpl class: |
| |
| <p> |
| </p> |
| <div class="source"> |
| <pre>TypeMappingImpl.dotnet_soapenc_bugfix = true;</pre></div> |
| |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="AxisServlet_configuration"></a>AxisServlet configuration</h2> |
| |
| |
| <p>The following properties are recognized by AxisServlet. They may be specified as servlet parameters, |
| context parameters or system properties:</p> |
| |
| |
| <table border="0" class="table table-striped"> |
| |
| <tr class="a"> |
| |
| <td><b>axis.jws.servletClassDir</b></td> |
| |
| <td>Path to where compiled JWS pages are placed. This may be an absolute path or a path relative |
| to the web application root.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b>axis.attachments.Directory</b></td> |
| |
| <td>The directory where temporary files for attachments are stored. Defaults to the WEB-INF/attachments |
| directory for exploded WARs.</td> |
| </tr> |
| </table> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Individual_Service_Configuration"></a>Individual Service Configuration</h2> |
| |
| |
| <p>Here is a service element with examples of the current set of options you can set. More may exists (consult the source, as usual).</p> |
| |
| <div class="source"> |
| <pre> |
| <service name="MyServiceName" |
| provider="java:RPC" |
| style="rpc|document|wrapped" |
| use="encoded|literal" |
| streaming="off|on" |
| attachment="MIME|DIME|NONE"> |
| |
| <parameter name="className" value="org.apache.mystuff.MyService"/> |
| <parameter name="allowedMethods" value="method1 method2 method3"/> |
| <parameter name="wsdlTargetNamespace" value="http://mystuff.apache.org/MyService"/> |
| <parameter name="wsdlServiceElement" value="MyService"/> |
| <parameter name="wsdlServicePort" value="MyServicePort"/> |
| <parameter name="wsdlPortType" value="MyPort"/> |
| <parameter name="wsdlSoapActionMode" value="NONE|DEFAULT|OPERATION"/> |
| |
| <parameter name="SingleSOAPVersion" value="1.1|1.2/> |
| |
| <documentation>Service level info</documentation> |
| <endpointURL>http://example.com:5050/my/custom/url/to/service</endpointURL> |
| <wsdlFile>/path/to/wsdl/file</wsdlFile> |
| <namespace>http://my.namespace.com/myservice</namespace> |
| <handlerInfoChain>handlerChainName</handlerInfoChain> |
| |
| <operation ... /> |
| |
| <typeMapping ... /> |
| |
| <beanMapping ... /> |
| |
| </service></pre></div> |
| |
| |
| <div class="section"> |
| <h3><a name="Service_Element_Attributes"></a>Service Element Attributes</h3> |
| |
| |
| <dl> |
| |
| <dt>name</dt> |
| |
| <dd>The name of the service.</dd> |
| |
| |
| <dt>provider</dt> |
| |
| <dd>The provider for the service. The recognized providers are: java:RPC, java:MSG, |
| java:EJB, java:COM, java:BSF, java:CORBA, java:RMI and "Handler" |
| where <tt>xmlns:java="http://xml.apache.org/axis/wsdd/providers/java"</tt>. The RPC provider supports |
| both rpc/encoded, document/literal and wrapped/literal services. the MSG provider supports the |
| 'fixed signature' service which takes XML in and returns XML our directly. The other providers must be |
| built in to Axis. See the code in org.apache.axis.providers.</dd> |
| |
| |
| <dt>style</dt> |
| |
| <dd>The style of the service. |
| "rpc" uses the RPC style of wrapping the parts of the message an element that has the same name |
| as the operation. |
| "document" style means the messages in and out of the service are exactly as |
| they are describe by the XML Schema in the WSDL. |
| "wrapped" is a subset of the document style. The arguments to the operation are wrapped up in and |
| element that has the same name as the operation. This is the style of service .NET generates by |
| default. The generated WSDL specifies document style (and literal use) but Axis will 'unwrapped' |
| the parts of the message for the Axis service at the back end.</dd> |
| |
| |
| <dt>use</dt> |
| |
| <dd>This can be either "encoded" or "literal". Encoded means the SOAP 1.1 "Section 5 Encoding" is used to |
| encode the data structures returned by the service and incoming XML is decoded using the same rules. |
| Literal use means no such encoding is performed.</dd> |
| |
| |
| <dt>streaming</dt> |
| |
| <dd>Valid values are "on" or "off". This turns on or off the streaming mode of the XML deserializer. |
| The default is currently off. Certain Axis functionality may not function properly if this is turned |
| on. Use with caution.</dd> |
| |
| |
| <dt>attachment</dt> |
| |
| <dd>Valied values are "MIME" for SOAP with attachements (SwA), "DIME" for DIME support and "NONE" for no attachement |
| support at all. The default mode of Axis is to use MIME attachements (SwA).</dd> |
| |
| </dl> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h3><a name="Elements_allowed_in_the_Service_element"></a>Elements allowed in the Service element</h3> |
| |
| |
| <dl> |
| |
| <dt><wsdlFile></dt> |
| |
| <dd>The path to a WSDL File; can be an absolute path or a |
| resource that axis.jar can load. Useful to export your custom WSDL |
| file. When specify a path to a resource, place a forward slash to start |
| at the beginning of the classpath (e.g "/org/someone/res/mywsdl.wsdl"). |
| How does Axis know whether to return a file or resource? It looks for a |
| file first, if that is missing a resource is returned. </dd> |
| |
| |
| <dt><documentation></dt> |
| |
| <dd>Documentation text that will get inserted in to the document element of the WSDL for the service</dd> |
| |
| |
| <dt><endpointURL></dt> |
| |
| <dd>Specify the endpoint URL of the service, which will override the transport level URL |
| created by the Axis servlet. This is usefull if you have a proxy handling requests |
| and you need the endpoint URL to reflect a different hostname than the one Axis is |
| executing on.</dd> |
| |
| |
| <dt><namespace></dt> |
| |
| <dd>Specify the default namespace for the service.</dd> |
| |
| |
| <dt><handlerInfoChain></dt> |
| |
| <dd>Specify the JAX RPC handler chain for this service.</dd> |
| </dl> |
| |
| |
| <p>In addition, as described above, the <b><requestFlow></b> and/or <b><responseFlow></b> elements are also allowed in the service element.</p> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h3><a name="Service_Level_Parameters"></a>Service Level Parameters</h3> |
| |
| |
| <p>The following parameters can be set on a service wide basis using the <parameter> tag. There may be more than those documented here, but this list should be almost complete.</p> |
| |
| |
| <table border="0" class="table table-striped"> |
| |
| |
| <tr class="a"> |
| |
| <td><b>className</b></td> |
| |
| <td>The fully qualified name of the implemenation class of the service.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>allowedMethods</b></td> |
| |
| <td>A space or comma seperated list of method names, or "*" for all methods in the service class. |
| If this parameter isn't specified, all methods ("*") is the default. |
| </td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>wsdlPortType</b></td> |
| |
| <td>The name of the portType element in the generated WSDL for the service.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>wsdlServiceElement</b></td> |
| |
| <td>The name of the Service element in the generated WSDL for the service.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>wsdlServicePort</b></td> |
| |
| <td>The name of the port in the generated WSDL for the service.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>wsdlTargetNamespace</b></td> |
| |
| <td>The target namespace in the generated WSDL for the service.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>wsdlInputSchema</b></td> |
| |
| <td>A comma separated list of of input Schema for the generated WSDL for the service.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><b>wsdlSoapActionMode</b></td> |
| |
| <td>Values are DEFAULT, OPERATION or NONE. |
| OPERATION forces soapAction to the name of the operation. |
| DEFAULT causes the soapAction to be set according to the |
| operations meta data, specifically the soapAction attribute of the operation |
| in the deployment information. |
| NONE forces the soapAction to "". The default is DEFAULT.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td><b>SingleSOAPVersion</b></td> |
| |
| <td>When set to either "1.1" or "1.2", this configures a service to only accept the specified SOAP version. Attempts to connect to the service using another version will result in a fault.</td> |
| </tr> |
| |
| </table> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Individual_Operation_Configuration"></a>Individual Operation Configuration</h2> |
| |
| |
| <p>Here is an <tt><operation></tt> element with examples of the current set of options you can set. More may exists (consult the source, as usual).</p> |
| |
| <div class="source"> |
| <pre> |
| <operation name="GetQuote" |
| qname="operNS:GetQuote" |
| returnQName="GetQuoteResult" |
| returnType="xsd:float" |
| soapAction="" |
| returnHeader="true|false"> |
| |
| <documentation>Operation level documentation here</documentation> |
| |
| <parameter name="ticker" type="tns:string"/> |
| |
| <fault name="InvalidTickerFaultMessage" |
| qname="tickerSymbol" |
| class="test.wsdl.faults.InvalidTickerFaultMessage" |
| type="xsd:string"/> |
| </operation> |
| </pre></div> |
| |
| |
| <p>The example above omits the XML Namespace declarations (xmlns:foo="http://my.namespace/") that could appear |
| in each of the elements for the namespaces used.</p> |
| |
| |
| <div class="section"> |
| <h3><a name="Operation_Attributes"></a>Operation Attributes</h3> |
| |
| |
| <dl> |
| |
| <dt>name</dt> |
| |
| <dd>The name of the operation. This would generally match the name of the function in your service implementation.</dd> |
| |
| |
| <dt>qname</dt> |
| |
| <dd>The Qualified Name of the top level element for this operation. This is how Axis maps operations for document/literal services, |
| which do not have the operation name in the QName of the XML element on the wire.</dd> |
| |
| |
| <dt>returnQName</dt> |
| |
| <dd>The Qualified Name of the XML element that is returned from this operation.</dd> |
| |
| |
| <dt>returnType</dt> |
| |
| <dd>The Qualified Name of the return type.</dd> |
| |
| |
| <dt>returnHeader</dt> |
| |
| <dd>If true, the return value of the operation is contained in a header.</dd> |
| |
| |
| <dt>soapAction</dt> |
| |
| <dd>The value of the SOAPAction attribute for this operation in the WSDL generated for this service.</dd> |
| </dl> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h3><a name="Elements_allowed_in_the_Operation_Element"></a>Elements allowed in the Operation Element</h3> |
| |
| |
| <dl> |
| |
| <dt><documentation></dt> |
| |
| <dd>Documentation text that will get inserted in to the document element of the WSDL for the operation.</dd> |
| |
| |
| <dt><parameter></dt> |
| |
| <dd> |
| |
| <p>Defines a parameter for the operation. Valid attributes are:</p> |
| |
| <table border="0" class="table table-striped"> |
| |
| <tr class="a"> |
| <td><b>name</b></td> |
| |
| <td>The name of the parameter.</td></tr> |
| |
| <tr class="b"> |
| <td><b>qname</b></td> |
| |
| <td>The QName of the parameter, used in preference to name.</td> |
| </tr> |
| |
| <tr class="a"> |
| <td><b>mode</b></td> |
| |
| <td>The mode of the parameter. One of "in", "out" or "inout".</td></tr> |
| |
| <tr class="b"> |
| <td><b>inHeader</b></td> |
| |
| <td>If "true", this parameter is an input header.</td></tr> |
| |
| <tr class="a"> |
| <td><b>outHeader</b></td> |
| |
| <td>If "true", this parameter is an output header.</td></tr> |
| |
| <tr class="b"> |
| <td><b>type</b></td> |
| |
| <td>The QName of the type of the parameter.</td></tr> |
| </table> |
| |
| <p> |
| <b>NOTE:</b> A <tt><documentation></tt> element may appear as a child of parameter. |
| </p> |
| </dd> |
| |
| |
| <dt><fault></dt> |
| |
| <dd> |
| |
| <p>Defines the type information for each fault that the operation may throw. |
| Valid attributes are:</p> |
| |
| <table border="0" class="table table-striped"> |
| |
| <tr class="a"> |
| <td><b>name</b></td> |
| |
| <td>The name of the fault.</td></tr> |
| |
| <tr class="b"> |
| <td><b>qname</b></td> |
| |
| <td>The QName of the fault.</td> |
| </tr> |
| |
| <tr class="a"> |
| <td><b>class</b></td> |
| |
| <td>The Java class that represents this fault.</td></tr> |
| |
| <tr class="b"> |
| |
| <td><b>type</b></td> |
| |
| <td>The QName of the type that represents the data for this fault.</td> |
| </tr> |
| </table> |
| |
| </dd> |
| |
| </dl> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Axis_Logging_Configuration"></a>Axis Logging Configuration</h2> |
| |
| |
| <p>Axis uses the Jakarta Projects's <a class="externalLink" href="http://jakarta.apache.org/commons/logging/">commons-logging API</a>, as implemented in <tt>commons-logging.jar</tt> to implement logging throughout the code. Normally this library routes the logging to the Log4j library, provided that an implementation of log4j is on the classpath of the server or client. The commons-logging API can also bind to Avalon, <tt>System.out</tt> or the Java1.4 logger. The JavaDocs for the library explain the process for selecting a logger, which can be done via a system property or a properties file in the classpath.</p> |
| |
| |
| <p>Log4J can be configured using the file log4j.properties in the classpath; later versions also support an XML configuration.</p> |
| |
| |
| <div class="section"> |
| <h3><a name="Log_Categories"></a>Log Categories</h3> |
| |
| |
| <p>Axis classes that log information create their own per-class log, each of which may output information at different levels. For example, the main entry point servlet has a log called <tt>org.apache.axis.transport.http.AxisServlet</tt>, the AxisEngine is <tt>org.apache.axis.AxisEngine</tt>, and so on. There are also special logs for special categories.</p> |
| |
| |
| <table border="0" class="table table-striped"> |
| |
| |
| <tr class="a"> |
| |
| <td valign="top"><tt>org.apache.axis.TIME</tt></td> |
| |
| <td>A log that records the time to execute incoming messages, splitting up into preamble, invoke, post and send times. These are only logged at debug level.</td> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td valign="top"><tt>org.apache.axis.EXCEPTIONS</tt></td> |
| |
| <td>Exceptions that are sent back over the wire. AxisFaults, which are normally created in 'healthy' operation, are logged at debug level. Other Exceptions are logged at the Info level, as they are more indicative of server side trouble.</td> |
| </tr> |
| |
| |
| <tr class="a"> |
| |
| <td valign="top"><tt>org.apache.axis.enterprise</tt></td> |
| |
| <td>''Enterprise'' level stuff, which generally means stuff that an enterprise product might want to track, but in a simple environment (like the Axis build) would be nothing more than a nuisance.</td> |
| </tr> |
| |
| </table> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h2><a name="Pre-Configured_Axis_Components_Reference"></a>Pre-Configured Axis Components Reference</h2> |
| |
| |
| <div class="section"> |
| <h3><a name="On_the_server"></a>On the server</h3> |
| |
| |
| <dl> |
| |
| |
| <dt>SimpleSessionHandler</dt> |
| |
| <dd>uses SOAP headers to do simple session management</dd> |
| |
| |
| <dt>LogHandler</dt> |
| |
| <dd>The LogHandler will simply log a message to a logger when it gets invoked.</dd> |
| |
| |
| <dt>SoapMonitorHandler</dt> |
| |
| <dd>Provides the hook into the message pipeline sending the SOAP request and response messages to the SoapMonitor utility.</dd> |
| |
| |
| <dt>DebugHandler</dt> |
| |
| <dd>Example handler that demonstrates dynamically setting the debug level based on a the value of a soap header element.</dd> |
| |
| |
| <dt>ErrorHandler</dt> |
| |
| <dd>Example handler that throws an AxisFault to stop request/response flow processing.</dd> |
| |
| |
| <dt>EchoHandler</dt> |
| |
| <dd>The EchoHandler copies the request message into the response message.</dd> |
| |
| |
| <dt>HTTPAuth</dt> |
| |
| <dd>The HTTPAuthHandler takes HTTP-specific authentication information (right now, just Basic authentication) and turns it into generic MessageContext properties for username and password</dd> |
| |
| |
| <dt>SimpleAuthenticationHandler</dt> |
| |
| <dd>The SimpleAuthentication handler passes a MessageContext to a SecurityProvider (see org.apache.axis.security) to authenticate the user using whatever information the SecurityProvider wants (right now, just the username and password).</dd> |
| |
| |
| <dt>SimpleAuthorizationHandler</dt> |
| |
| <dd>This handler, typically deployed alongside the SimpleAuthenticationHandler (a chain called "authChecks" is predefined for just this combination), checks to make sure that the currently authenticated user satisfies one of the allowed roles for the target service. Throws a Fault if access is denied.</dd> |
| |
| |
| <dt>MD5AttachHandler</dt> |
| |
| <dd>Undocumented, uncalled, untested handler that generates an MD5 hash of attachment information and adds the value as an attribute in the soap body.</dd> |
| |
| |
| <dt>URLMapper</dt> |
| |
| <dd>The URLMapper, an HTTP-specific handler, usually goes on HTTP transport chains (it is deployed by default). It serves to do service dispatch based on URL - for instance, this is the Handler which allows URLs like http://localhost:8080/axis/services/MyService?wsdl to work.</dd> |
| |
| |
| <dt>RPCProvider</dt> |
| |
| <dd>The RPCProvider is the pivot point for all RPC services. It accepts the following options:<br /> |
| <b><i>className</i></b> = the class of the backend object to invoke<br /> |
| <b><i>methodName</i></b> = a space-separated list of methods which are exported as web services. The special value "*" matches all public methods in the class.</dd> |
| |
| |
| <dt>MsgProvider</dt> |
| |
| <dd>The MsgProvider is the pivot point for all messaging services. It accepts the following options:<br /> |
| <b><i>className</i></b> = the class of the backend object to invoke<br /> |
| <b><i>methodName</i></b> = a space-separated list of methods which are exported as web services. The special value "*" matches all public methods in the class.</dd> |
| |
| |
| <dt>JWSHandler</dt> |
| |
| <dd>Performs drop-in deployment magic.</dd> |
| |
| |
| <dt>JAXRPCHandler</dt> |
| |
| <dd>Wrapper around JAX-RPC compliant handlers that exposes an Axis handler interface to the engine.</dd> |
| |
| |
| <dt>LocalResponder</dt> |
| |
| <dd>The LocalResponder is a Handler whose job in life is to serialize the response message coming back from a local invocation into a String. It is by default on the server's local transport response chain, and it ensures that serializing the message into String form happens in the context of the server's type mappings.</dd> |
| |
| </dl> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h3><a name="On_the_client"></a>On the client</h3> |
| |
| |
| <dl> |
| |
| |
| <dt>SimpleSessionHandler</dt> |
| |
| <dd>uses SOAP headers to do simple session management</dd> |
| |
| |
| <dt>JAXRPCHandler</dt> |
| |
| <dd>Wrapper around JAX-RPC compliant handlers that exposes an Axis handler interface to the engine.</dd> |
| |
| |
| <dt>HTTPSender</dt> |
| |
| <dd>A Handler which sends the request message to a remote server via HTTP, and collects the response message.</dd> |
| |
| |
| <dt>LocalSender</dt> |
| |
| <dd>A Handler which sends the request message to a "local" AxisServer, which will process it and return a response message. This is extremely useful for testing, and is by default mapped to the "local:" transport. So, for instance, you can test the AdminClient by doing something like this: |
| |
| <div class="source"> |
| <pre>% java org.apache.axis.client.AdminClient -llocal:// list</pre></div> |
| </dd> |
| |
| </dl> |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row span12">Copyright © 2000-2015 |
| <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
