You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by to...@apache.org on 2005/01/27 10:42:59 UTC
cvs commit: ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant ant.xml axis-admin.xml axis-java2wsdl.xml axis-wsdl2java.xml foreach.xml runaxisfunctionaltests.xml
toshi 2005/01/27 01:42:59
Added: site/src4forrest-060/java/src/documentation/content/xdocs/java/ant
ant.xml axis-admin.xml axis-java2wsdl.xml
axis-wsdl2java.xml foreach.xml
runaxisfunctionaltests.xml
Log:
Migration for Forrest 0.6
Revision Changes Path
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/ant.xml
Index: ant.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<a name="AxisAntTasks"/>
<section>
<title>Axis Ant Tasks</title>
<p>Axis comes with Ant tasks to automate aspects of the build process inside ant. To use these tasks, you need</p>
<ol>
<li><a href="http://jakarta.apache.org/ant">Apache Ant 1.5.1 or later</a></li>
<li>The library <code>axis-ant.jar</code> which contains the tasks</li>
<li>All the main Axis libraries</li>
</ol>
<section>
<title>Declaring the Tasks</title>
<p>To declare the tasks, set up a classpath to include the axis task JAR and all the dependent libraries. Including everything in the axis lib directory should suffice</p>
<source><path id="axis.classpath">
<fileset dir="${axis.home}/build/lib">
<include name="**/*.jar" />
</fileset>
</path></source>
<p>Then use the <code><taskdef></code> declaration to declare all the tasks listed in a properties file inside the <code>axis-ant.jar</code> file:</p>
<source><taskdef resource="axis-tasks.properties"
classpathref="axis.classpath" /></source>
</section>
<section>
<title>Creating Java files from WSDL</title>
<p>This uses the <a href="axis-wsdl2java.html"><axis-wsdl2java></a> task.</p>
<source><axis-wsdl2java
output="${generated.dir}"
testcase="true"
verbose="true"
url="${local.wsdl}" >
<mapping
namespace="http://axis.apache.org/ns/interop"
package="interop" />
</axis-wsdl2java></source>
<p>The mapping elements are used to list the mappings from XML namespaces to Java packages; you can include as many as you need.</p>
</section>
<section>
<title>Creating WSDL files from Java</title>
<p>This uses the <a href="axis-java2wsdl.html"><axis-java2wsdl></a> task.</p>
</section>
<section>
<title>Talking to the admin service</title>
<p>This can be done with the <a href="axis-admin.html"><axis-admin></a> task.</p>
<source><axis-admin
port="${target.port}"
hostname="${target.server}"
failonerror="true"
servletpath="${target.appname}/services/AdminService"
debug="true"
xmlfile="${endpoint-stub.wsdd}"
/></source>
<p>Here the target.* properties are pulled from a properties file for the system being deployed to, so a single build file can deploy to different systems with ease.</p>
</section>
<section>
<title>Foreach Task</title>
<p><a href="foreach.html"><axis-admin></a></p>
</section>
<section>
<title>Runaxisfunctionaltests Task</title>
<p><a href="runaxisfunctionaltests.html"><axis-admin></a></p>
</section>
</section>
</body>
</document>
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/axis-admin.xml
Index: axis-admin.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<section>
<title>Axis-admin Task</title>
<p>Task to administer a local or remote Axis server.</p>
<section>
<title>Description</title>
<p>Task to administer a local or remote Axis server. Remember, for remote admin, the server has to be accept remote management calls.</p>
</section>
<section>
<title>Parameters</title>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr>
<td>debug</td>
<td>set a debug flag</td>
<td>boolean</td>
</tr>
<tr>
<td>failonerror</td>
<td>Whether or not the build should halt if this task fails. Defaults to <code>true</code>.</td>
<td>boolean</td>
</tr>
<tr>
<td>fileprotocol</td>
<td>specifies that a simple file protocol be used</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>hostname</td>
<td>name the host to admin</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>newpassword</td>
<td>set a new password; only valid if action=passwd</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>password</td>
<td>the admin password</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>port</td>
<td>the port to connect to</td>
<td>int</td>
</tr>
<tr>
<td>servletpath</td>
<td>the path to the AxisAdmin servlet</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>transportchain</td>
<td>set the transport chain to use</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>url</td>
<td>full url to the admin endpoint</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>username</td>
<td>username to log in as</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>xmlfile</td>
<td>the name of the XML file containing deployment information</td>
<td>java.io.File</td>
</tr>
</table>
</section>
<section>
<title>Parameters as nested elements</title>
</section>
</section>
</body>
</document>
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/axis-java2wsdl.xml
Index: axis-java2wsdl.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<section>
<title>Axis-java2wsdl Task</title>
<p>Generates a WSDL description from a Java class.</p>
<section>
<title>Description</title>
<p>Generates a WSDL description from a Java class.</p>
</section>
<section>
<title>Parameters</title>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr>
<td>bindingname</td>
<td>The name to use use for the binding element. If not specified, the value of the <code>servicePortName</code> + "SoapBinding" is used.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>classname</td>
<td>the class name to import, eg. org.example.Foo. Required. The class must be on the classpath.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>exclude</td>
<td>Comma separated list of methods to exclude from the wsdl file.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>extraclasses</td>
<td>The setter for the "extraClasses" attribute</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>implclass</td>
<td>Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>input</td>
<td>Optional attribute 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.</td>
<td>java.io.File</td>
</tr>
<tr>
<td>location</td>
<td>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.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>locationimport</td>
<td>the location of the interface WSDL when generating an implementation WSDL Required when <code>outputImpl</code> is set</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>methods</td>
<td>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</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>namespace</td>
<td>the target namespace. Required.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>namespaceimpl</td>
<td>Namespace of the implementation WSDL.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>output</td>
<td>The name of the output WSDL file. If not specified, a suitable default WSDL file is written into the current directory.</td>
<td>java.io.File</td>
</tr>
<tr>
<td>outputimpl</td>
<td>Use this option to indicate the name of the output implementation WSDL file. If specified, Java2WSDL will produce separate interface and implementation WSDL files. If not, a single WSDL file is generated</td>
<td>java.io.File</td>
</tr>
<tr>
<td>porttypename</td>
<td>Indicates the name to use use for the portType element. If not specified, the class-of-portType name is used.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>serviceelementname</td>
<td>the name of the service element. If not specified, the service element is the <code>portTypeName</code>Service.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>serviceportname</td>
<td>service port name (obtained from location if not specified)</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>stopclasses</td>
<td>Comma separated list of classes which stop the Java2WSDL inheritance search.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>style</td>
<td>The style of the WSDL document: RPC, DOCUMENT or WRAPPED. If RPC, a rpc/encoded wsdl is generated. If DOCUMENT, a document/literal wsdl is generated. If WRAPPED, a document/literal wsdl is generated using the wrapped approach.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>typemappingversion</td>
<td>the default type mapping registry to use. Either 1.1 or 1.2. Default is 1.1</td>
<td>org.apache.axis.tools.ant.wsdl.TypeMappingVersionEnum</td>
</tr>
<tr>
<td>use</td>
<td>Set the use option</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>useinheritedmethods</td>
<td>should inherited methods be exported too? Default=false</td>
<td>boolean</td>
</tr>
</table>
</section>
<section>
<title>Parameters as nested elements</title>
<p>mapping (org.apache.axis.tools.ant.wsdl.NamespaceMapping)<br/>add a mapping of namespaces to packages</p>
<p>mappingset (org.apache.axis.tools.ant.wsdl.MappingSet)<br/>add a mapping of namespaces to packages</p>
</section>
</section>
</body>
</document>
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/axis-wsdl2java.xml
Index: axis-wsdl2java.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<section>
<title>Axis-wsdl2java Task</title>
<p>Create Java classes from local or remote WSDL.</p>
<section>
<title>Description</title>
<p>Create Java classes from local or remote WSDL. Mappings from namespaces to packages can be provided as nested <mapping> elements.</p>
<p>Proxy settings are taken from the java runtime settings of http.ProxyHost, http.ProxyPort, etc. The Ant task <setProxy> can set these. As well as the nested mapping elements, this task uses the file <code>NStoPkg.properties</code> in the project base directory for namespace mapping</p>
<p>This task does no dependency checking; files are generated whether they need to be or not. The exception to this is the Impl class, which is not
overwritten if it exists. This is a safety measure. However, all other classes are generated overwriting anything that exists.</p>
<p>The safe way to use this task is to have it generate the java source in a build directory, then have a <copy> task selectively copy the files you need into a safe location. Again, copying into the source tree is dangerous, but a separate build/src tree is safe. Then include this separate tree in the <javac> task's src attribute to include it in the build. Implement your own implementation classes of the server stub and the test cases using the generated templates. If you want to add methods to autogenerated data types, consider subclassing them, or write helper classes.</p>
<p>Tip: if you <get> the wsdl, and use the <filesmatch> condition to compare the fetched wsdl with a catched copy, you can make the target that calls the axis-wsd2ljava task conditional on the WSDL having changed. This stops spurious code regeneration and follow-on rebuilds across the java source tree.</p>
</section>
<section>
<title>Parameters</title>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr>
<td>all</td>
<td>flag to generate code for all elements, even unreferenced ones default=false;</td>
<td>boolean</td>
</tr>
<tr>
<td>debug</td>
<td>flag for debug output; default=false</td>
<td>boolean</td>
</tr>
<tr>
<td>deployscope</td>
<td>add scope to deploy.xml: "Application", "Request", "Session" optional;</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>factory</td>
<td>name of the Java2WSDLFactory class for extending WSDL generation functions</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>helpergen</td>
<td>Turn on/off Helper class generation; default is false</td>
<td>boolean</td>
</tr>
<tr>
<td>namespacemappingfile</td>
<td>set the mapping file. This is a properties file of package=namespace order. Optional, default is to look for a file called NStoPkg.properties in the project directory.</td>
<td>java.io.File</td>
</tr>
<tr>
<td>noimports</td>
<td>only generate code for the immediate WSDL document, and not imports; default=false;</td>
<td>boolean</td>
</tr>
<tr>
<td>output</td>
<td>output directory for emitted files</td>
<td>java.io.File</td>
</tr>
<tr>
<td>serverside</td>
<td>emit server-side bindings for web service; default=false</td>
<td>boolean</td>
</tr>
<tr>
<td>skeletondeploy</td>
<td>deploy skeleton (true) or implementation (false) in deploy.wsdd. Default is false. Assumes server-side="true".</td>
<td>boolean</td>
</tr>
<tr>
<td>testcase</td>
<td>flag for automatic Junit testcase generation default is false</td>
<td>boolean</td>
</tr>
<tr>
<td>timeout</td>
<td>timeout in milliseconds for URL retrieval; default is 45 seconds. Set this to -1 to disable timeouts altogether: other negative values are not allowed)</td>
<td>long</td>
</tr>
<tr>
<td>typemappingversion</td>
<td>the default type mapping registry to use. Either 1.1 or 1.2. Default is 1.1</td>
<td>org.apache.axis.tools.ant.wsdl.TypeMappingVersionEnum</td>
</tr>
<tr>
<td>url</td>
<td>URL to fetch and generate WSDL for. Can be remote or a local file.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>verbose</td>
<td>flag for verbose output; default=false</td>
<td>boolean</td>
</tr>
</table>
</section>
<section>
<title>Parameters as nested elements</title>
<p>mapping (org.apache.axis.tools.ant.wsdl.NamespaceMapping)<br/>add a mapping of namespaces to packages</p>
<p>mappingset (org.apache.axis.tools.ant.wsdl.MappingSet)<br/>add a mapping of namespaces to packages</p>
</section>
</section>
</body>
</document>
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/foreach.xml
Index: foreach.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<section>
<title>Foreach Task</title>
<p>Call a target foreach entry in a set of parameters based on a fileset.</p>
<section>
<title>Description</title>
<p>Call a target foreach entry in a set of parameters based on a fileset.</p>
<p><i>For Axis development; there is no support or stability associated with this task</i></p>
<source><target name="target1">
<foreach target="target2">
<param name="param1">
<fileset refid="fset1"/>
</param>
<param name="param2">
<item value="jar" />
<item value="zip" />
</param>
</foreach>
</target>
<target name="target2">
<echo message="prop is ${param1}.${param2}" />
</target></source>
<p>Really this just a wrapper around "AntCall"<br/>
Added a "type" attribute that works precisely like
its equivalent in <CODE>ExecuteOn</CODE>. It allows
the user to specify whether directories, files, or
both directories and files from the filesets are
included as entries in the parameter set.</p>
</section>
<section>
<title>Parameters</title>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr>
<td>fork</td>
<td>If true, forks the ant invocation.</td>
<td>boolean</td>
</tr>
<tr>
<td>inheritall</td>
<td>If true, pass all properties to the new Ant project. Defaults to true.</td>
<td>boolean</td>
</tr>
<tr>
<td>inheritrefs</td>
<td>If true, pass all references to the new Ant project. Defaults to false</td>
<td>boolean</td>
</tr>
<tr>
<td>target</td>
<td>Target to execute, required.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>verbose</td>
<td>Enable verbose output when signing ; optional: default false</td>
<td>boolean</td>
</tr>
</table>
</section>
<section>
<title>Parameters as nested elements</title>
<p>param (org.apache.axis.tools.ant.foreach.ParamSet)<br/></p>
</section>
</section>
</body>
</document>
1.1 ws-axis/site/src4forrest-060/java/src/documentation/content/xdocs/java/ant/runaxisfunctionaltests.xml
Index: runaxisfunctionaltests.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
<document>
<header>
<title>WebServices - Axis</title>
</header>
<body>
<section>
<title>Runaxisfunctionaltests Task</title>
<p>Ant task for starting / stopping servers and running junit in the middle.</p>
<section>
<title>Description</title>
<p>Ant task for starting / stopping servers and running junit in the middle. Based on the Cactus org.apache.commons.cactus.ant package, heavily munged and cruftily dumped into one file.</p>
<p><i>For Axis development; there is no support or stability associated with this task</i></p>
</section>
<section>
<title>Parameters</title>
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr>
<td>httpservertarget</td>
<td>Sets the target to call to start server 2.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>httpstoptarget</td>
<td>Sets the stop target. This is the target which does a HTTP admin shutdown on the simple server.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>tcpservertarget</td>
<td>Sets the target to call to start server 1.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>testtarget</td>
<td>Sets the target to call to run the tests.</td>
<td>java.lang.String</td>
</tr>
<tr>
<td>url</td>
<td>Sets the target URL (just http://host:port)</td>
<td>java.lang.String</td>
</tr>
</table>
</section>
<section>
<title>Parameters as nested elements</title>
</section>
</section>
</body>
</document>