blob: 2bb0d174545e9b6239cac8f7aa84531c45df0d46 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="copyright" content="Copyright (c) 2000, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: IBM Corporation - initial API and implementation" />
<meta name="DC.rights.owner" content="(C) Copyright 2000, 2008" />
<meta content="public" name="security" />
<meta content="index,follow" name="Robots" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta content="reference" name="DC.Type" />
<meta name="DC.Title" content="Bottom-up Axis Web service Ant task properties file reference" />
<meta name="abstract" content="The axis_bujava.properties file is used to pass data to the Web services Ant tasks when creating an Axis Web service . This file shows the available options." />
<meta name="description" content="The axis_bujava.properties file is used to pass data to the Web services Ant tasks when creating an Axis Web service . This file shows the available options." />
<meta content="Axis runtime environment, java bean Web services, Ant task reference, Web services, Axis runtime environment, Ant task reference" name="DC.subject" />
<meta content="Axis runtime environment, java bean Web services, Ant task reference, Web services, Axis runtime environment, Ant task reference" name="keywords" />
<meta scheme="URI" name="DC.Relation" content="../topics/twbwsa.html" />
<meta content="XHTML" name="DC.Format" />
<meta content="bottom-upaxiswebservicecommandlinereference" name="DC.Identifier" />
<meta content="en-us" name="DC.Language" />
<link href="../../org.eclipse.wst.doc.user/common.css" type="text/css" rel="stylesheet" />
<title>Bottom-up Axis Web service Ant task properties file reference</title>
</head>
<body id="bottom-upaxiswebservicecommandlinereference"><a name="bottom-upaxiswebservicecommandlinereference"><!-- --></a>
<h1 class="topictitle1">Bottom-up Axis Web service Ant task properties file reference</h1>
<div><p>The <kbd class="userinput">axis_bujava.properties</kbd> file is used
to pass data to the Web services Ant tasks when creating an Axis Web service
. This file shows the available options.</p>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl>
<dt class="dlterm">ScenarioType</dt>
<dd><span class="synph"> Options: <samp class="codeph">service</samp> </span></dd>
<dd class="ddexpand">This is a required element that tells the Ant task if it is creating a
Web service or a Web service client.</dd>
<dt class="dlterm">InitialSelection</dt>
<dd>Enter the workspace relative URI to the WSDL file or Java bean within
your workspace. For example <kbd class="userinput">/dynamicWebProjectName/WebContent/myService.wsdl</kbd> or <kbd class="userinput">/dynamicWebProjectName/src/myBean.java</kbd></dd>
<dt class="dlterm">ListRuntimes</dt>
<dd><span class="synph"> Options: <samp class="codeph">true</samp> <samp class="codeph">false</samp></span></dd>
<dd class="ddexpand">If <samp class="codeph">true</samp> is selected, the list of valid runtime options
will be provided when the Ant task is run.</dd>
<dt class="dlterm">ListServers</dt>
<dd><span class="synph"> Options: <samp class="codeph">true</samp> <samp class="codeph">false</samp></span></dd>
<dd class="ddexpand">If <samp class="codeph">true</samp> is selected, the list of valid server options
will be provided when the Ant task is run.</dd>
<dt class="dlterm">Service.RuntimeId</dt>
<dd>This is the ID of the Web service's runtime. This parameter should not
be modified.</dd>
<dt class="dlterm">Service.ServerId</dt>
<dd>Options:<ul class="simple">
<li><samp class="codeph">org.eclipse.jst.server.tomcat.x</samp> (where <samp class="codeph">x</samp> is <samp class="codeph">32,
40, 41, 50,</samp> or <samp class="codeph">55</samp>)</li>
<li><samp class="codeph">org.eclipse.jst.server.generic.weblogicx</samp> (where <samp class="codeph">x</samp> is <samp class="codeph">81</samp> or <samp class="codeph">90</samp>) </li>
<li><samp class="codeph">org.eclipse.jst.server.generic.jbossx</samp> (where <samp class="codeph">x</samp> is <samp class="codeph">323</samp> or <samp class="codeph">4</samp>)</li>
<li><samp class="codeph">org.eclipse.jst.server.generic.jonas4</samp></li>
<li><samp class="codeph">org.eclipse.jst.server.generic.oracle1013</samp></li>
<li><samp class="codeph">org.eclipse.jst.servers.websphere.6</samp></li>
</ul>
</dd>
<dd class="ddexpand">This is the ID of the target server. Delete or comment out this parameter
to have the Ant task select the correct value based on the server settings
of the dynamic Web project.</dd>
<dt class="dlterm">ServiceProjectName</dt>
<dd>By default the service project is given the name of the WSDL file or Java
bean from which it is created. Use this parameter to create the service project
with a different name.</dd>
<dt class="dlterm">ServiceEarProjectName</dt>
<dd>By default the service EAR project is given the name of the WSDL file
or Java bean from which it is created. Use this parameter to create the service
EAR project with a different name.</dd>
<dt class="dlterm">Mappings</dt>
<dd>Enter the workspace relative URI to a property file containing mappings.</dd>
<dd class="ddexpand">Mappings are used to override the default namespace names in the generated
WSDL. The content of the properties file must be of the format package=namespace.
You will need to escape some special characters in the properties files.
For example <samp class="codeph">somePackage=http://someNamespace</samp> should be <samp class="codeph">somePackage=http\://someNamespace</samp>.
Otherwise, the colon (:) would be treated as delimiter resulting in trying
to map <samp class="codeph">somePackage</samp> to <samp class="codeph">http</samp>.</dd>
<dt class="dlterm">JavaOutput</dt>
<dd>Enter the workspace relative URI to an existing Java source folder for
the generated Java code.</dd>
<dt class="dlterm">Methods</dt>
<dd>Use this parameter to limit which methods are exposed in the service.
It must be in the form of a space delimited string of method signatures. For
example, <kbd class="userinput">method1(parmType1) method2(parmType2)</kbd>. If
no list is provided, all methods are exposed. </dd>
<dt class="dlterm">Style</dt>
<dd><span class="synph"> Options: <samp class="codeph">DOCUMENT</samp> <samp class="codeph">RPC</samp> <samp class="codeph">WRAPPED</samp></span></dd>
<dd class="ddexpand">Select the SOAP message style. The default is <samp class="codeph">DOCUMENT</samp>.</dd>
<dt class="dlterm">Use</dt>
<dd><span class="synph"> Options: <samp class="codeph">LITERAL</samp> <samp class="codeph">ENCODED</samp></span></dd>
<dd class="ddexpand">Select if the SOAP message will be literal or encoded. The default is <samp class="codeph">LITERAL</samp>.</dd>
<dt class="dlterm">OverwriteFilesEnabled</dt>
<dd><span class="synph"> Options: <samp class="codeph">true</samp> <samp class="codeph">false</samp></span></dd>
<dd class="ddexpand">Use this parameter to tell the Ant task to overwrite any file that it
creates with the same name as an existing file. By default this is set to <samp class="codeph">true</samp>.</dd>
<dt class="dlterm">CreateFoldersEnabled</dt>
<dd><span class="synph"> Options: <samp class="codeph">true</samp> <samp class="codeph">false</samp></span></dd>
<dd class="ddexpand">Use this parameter to tell the Ant task to create any neccessary folders.
By default this is set to <samp class="codeph">true</samp>.</dd>
<dt class="dlterm">CheckoutFilesEnabled</dt>
<dd><span class="synph"> Options: <samp class="codeph">true</samp> <samp class="codeph">false</samp></span></dd>
<dd class="ddexpand">Use this parameter to tell the Ant task to checkout files from CVS without
prompting you. By default this is set to <samp class="codeph">true</samp>.</dd>
</dl>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="../topics/twbwsa.html" title="You can use Ant through the Eclipse workspace to generate a Web service using the Axis run-time environment. Both top-down and bottom-up Web services development is supported with the Ant tasks.">Creating a Web service using Ant tasks in the Workbench</a></div>
</div>
</div>
</body>
</html>