Wsdl2javaAntTask (Apache Axis)

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - org.apache.axis.tools.ant.wsdl.Wsdl2javaAntTask

```
public class Wsdl2javaAntTask
extends org.apache.tools.ant.Task
```
Create Java classes from local or remote WSDL. Mappings from namespaces to packages can be provided as nested <mapping> elements.
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 NStoPkg.properties in the project base directory for namespace mapping
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.
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.
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.

Author:

Davanum Srinivas (dims@yahoo.com), steve loughran

Property Summary

Properties
Type Property and Description

FactoryProperty create
Adds a property name/value pair for specialized JavaGeneratorFactories.

Properties
Type	Property and Description
`FactoryProperty`	`create` Adds a property name/value pair for specialized JavaGeneratorFactories.

Field Summary
- Fields inherited from class org.apache.tools.ant.Task
  description, location, target, taskName, taskType, wrapper
- Fields inherited from class org.apache.tools.ant.ProjectComponent
  project

Constructor Summary

Constructors
Constructor and Description

Wsdl2javaAntTask()

Constructors
Constructor and Description
`Wsdl2javaAntTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMapping(NamespaceMapping mapping)` add a mapping of namespaces to packages
`void`	`addMappingSet(MappingSet mappingset)` add a mapping of namespaces to packages
`void`	`addSysproperty(org.apache.tools.ant.types.Environment.Variable sysp)` Adds a system property that tests can access.
`org.apache.tools.ant.types.Path`	`createClasspath()` set the classpath
`protected Emitter`	`createEmitter()` This factory method makes it easier to extend this Ant task with a custom Emitter, if necessary.
`NamespaceSelector`	`createNsExclude()` Adds an additional namespace to the list to be excluded from source code generation.
`NamespaceSelector`	`createNsInclude()` Adds an additional namespace to the list to be included in source code generation.
`FactoryProperty`	`createProperty()` Adds a property name/value pair for specialized JavaGeneratorFactories.
`protected NamespaceSelector`	`createSelector()`
`void`	`execute()` The method executing the task
`void`	`setAll(boolean parameter)` flag to generate code for all elements, even unreferenced ones default=false;
`void`	`setAllowInvalidUrl(boolean b)` Set the allowInvalidURL flag.
`void`	`setDebug(boolean debug)` flag for debug output; default=false
`void`	`setDeployScope(String scope)` add scope to deploy.xml: "Application", "Request", "Session" optional;
`void`	`setFactory(String parameter)` name of the Java2WSDLFactory class for extending WSDL generation functions
`void`	`setFailOnNetworkErrors(boolean failOnNetworkErrors)` should the task fail the build if there is a network error?
`void`	`setHelperGen(boolean parameter)` Turn on/off Helper class generation; default is false
`void`	`setImplementationClassName(String implementationClassName)` Set the name of the class implementing the web service.
`void`	`setNamespaceMappingFile(File namespaceMappingFile)` set the mapping file.
`void`	`setNoImports(boolean parameter)` only generate code for the immediate WSDL document, and not imports; default=false;
`void`	`setNoWrapped(boolean noWrapped)` Set the noWrapped flag.
`void`	`setOutput(File parameter)` output directory for emitted files
`void`	`setPassword(String password)` set any password required for BASIC authenticated access to the WSDL; optional; only used if username is set
`void`	`setPrintStackTraceOnFailure(boolean printStackTraceOnFailure)` should we print a stack trace on failure?
`void`	`setProtocolHandlerPkgs(String handlerPkgs)` append any protocol handler pkgs specified with the task
`void`	`setQuiet(boolean quiet)` flag for quiet output; default=false
`void`	`setServerSide(boolean parameter)` emit server-side bindings for web service; default=false
`void`	`setSkeletonDeploy(boolean parameter)` deploy skeleton (true) or implementation (false) in deploy.wsdd.
`void`	`setTestCase(boolean parameter)` flag for automatic Junit testcase generation default is false
`void`	`setTimeout(long parameter)` timeout in milliseconds for URL retrieval; default is 45 seconds.
`void`	`setTypeMappingVersion(TypeMappingVersionEnum parameter)` the default type mapping registry to use.
`void`	`setURL(String parameter)` URL to fetch and generate WSDL for.
`void`	`setUsername(String username)` set any username required for BASIC authenticated access to the WSDL; optional.
`void`	`setVerbose(boolean verbose)` flag for verbose output; default=false
`void`	`setWrapArrays(boolean wrapArrays)` Set the wrap arrays flag - if true this will make new classes like "ArrayOfString" for literal "wrapped" arrays.
`void`	`traceParams(int logLevel)` trace out parameters
`protected void`	`validate()` validation code

Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - create
    
    Adds a property name/value pair for specialized JavaGeneratorFactories.
- Constructor Detail
  - Wsdl2javaAntTask
```
public Wsdl2javaAntTask()
```
- Method Detail
  - validate
```
protected void validate()
                 throws org.apache.tools.ant.BuildException
```
    validation code
    
    Throws:
    
    org.apache.tools.ant.BuildException - if validation failed
  - traceParams
```
public void traceParams(int logLevel)
```
    trace out parameters
    
    Parameters:
    logLevel - to log at
    See Also:
    Project.log(java.lang.String)
  - execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
    The method executing the task
    
    Overrides:
    
    execute in class org.apache.tools.ant.Task
    
    Throws:
    
    org.apache.tools.ant.BuildException - if validation or execution failed
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    flag for verbose output; default=false
    
    Parameters:
    verbose - The new verbose value
  - setDebug
```
public void setDebug(boolean debug)
```
    flag for debug output; default=false
    
    Parameters:
    debug - The new debug value
  - setQuiet
```
public void setQuiet(boolean quiet)
```
    flag for quiet output; default=false
    
    Parameters:
    quiet - The new quiet value
  - setServerSide
```
public void setServerSide(boolean parameter)
```
    emit server-side bindings for web service; default=false
  - setSkeletonDeploy
```
public void setSkeletonDeploy(boolean parameter)
```
    deploy skeleton (true) or implementation (false) in deploy.wsdd. Default is false. Assumes server-side="true".
  - setTestCase
```
public void setTestCase(boolean parameter)
```
    flag for automatic Junit testcase generation default is false
  - setHelperGen
```
public void setHelperGen(boolean parameter)
```
    Turn on/off Helper class generation; default is false
  - setFactory
```
public void setFactory(String parameter)
```
    name of the Java2WSDLFactory class for extending WSDL generation functions
  - setNoImports
```
public void setNoImports(boolean parameter)
```
    only generate code for the immediate WSDL document, and not imports; default=false;
  - setOutput
```
public void setOutput(File parameter)
               throws org.apache.tools.ant.BuildException
```
    output directory for emitted files
    
    Throws:
    
    org.apache.tools.ant.BuildException
  - setProtocolHandlerPkgs
```
public void setProtocolHandlerPkgs(String handlerPkgs)
```
    append any protocol handler pkgs specified with the task
  - setDeployScope
```
public void setDeployScope(String scope)
```
    add scope to deploy.xml: "Application", "Request", "Session" optional;
  - setURL
```
public void setURL(String parameter)
```
    URL to fetch and generate WSDL for. Can be remote or a local file.
  - setAll
```
public void setAll(boolean parameter)
```
    flag to generate code for all elements, even unreferenced ones default=false;
  - setTypeMappingVersion
```
public void setTypeMappingVersion(TypeMappingVersionEnum parameter)
```
    the default type mapping registry to use. Either 1.1 or 1.2. Default is 1.1
    
    Parameters:
    parameter - new version
  - setTimeout
```
public void setTimeout(long parameter)
```
    timeout in milliseconds for URL retrieval; default is 45 seconds. Set this to -1 to disable timeouts altogether: other negative values are not allowed)
  - addMapping
```
public void addMapping(NamespaceMapping mapping)
```
    add a mapping of namespaces to packages
  - addMappingSet
```
public void addMappingSet(MappingSet mappingset)
```
    add a mapping of namespaces to packages
  - setNamespaceMappingFile
```
public void setNamespaceMappingFile(File namespaceMappingFile)
```
    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.
    
    Parameters:
    namespaceMappingFile -
  - setFailOnNetworkErrors
```
public void setFailOnNetworkErrors(boolean failOnNetworkErrors)
```
    should the task fail the build if there is a network error? optional: defaults to false
    
    Parameters:
    failOnNetworkErrors -
  - setPrintStackTraceOnFailure
```
public void setPrintStackTraceOnFailure(boolean printStackTraceOnFailure)
```
    should we print a stack trace on failure? Optional, default=true.
    
    Parameters:
    printStackTraceOnFailure -
  - setUsername
```
public void setUsername(String username)
```
    set any username required for BASIC authenticated access to the WSDL; optional.
    
    Parameters:
    username -
  - setPassword
```
public void setPassword(String password)
```
    set any password required for BASIC authenticated access to the WSDL; optional; only used if username is set
    
    Parameters:
    password -
    See Also:
    username
  - setNoWrapped
```
public void setNoWrapped(boolean noWrapped)
```
    Set the noWrapped flag.
    
    Parameters:
    noWrapped -
  - setAllowInvalidUrl
```
public void setAllowInvalidUrl(boolean b)
```
    Set the allowInvalidURL flag.
  - setImplementationClassName
```
public void setImplementationClassName(String implementationClassName)
```
    Set the name of the class implementing the web service. This is especially useful when exporting a java class as a web service using Java2WSDL followed by WSDL2Java.
    
    Parameters:
    implementationClassName -
  - setWrapArrays
```
public void setWrapArrays(boolean wrapArrays)
```
    Set the wrap arrays flag - if true this will make new classes like "ArrayOfString" for literal "wrapped" arrays. Otherwise it will use "String []" and generate appropriate metadata.
    
    Parameters:
    wrapArrays -
  - createClasspath
```
public org.apache.tools.ant.types.Path createClasspath()
```
    set the classpath
    
    Returns:
  - createNsInclude
```
public NamespaceSelector createNsInclude()
```
    Adds an additional namespace to the list to be included in source code generation.
  - createNsExclude
```
public NamespaceSelector createNsExclude()
```
    Adds an additional namespace to the list to be excluded from source code generation.
  - createProperty
```
public FactoryProperty createProperty()
```
    Adds a property name/value pair for specialized JavaGeneratorFactories.
  - createEmitter
```
protected Emitter createEmitter()
```
    This factory method makes it easier to extend this Ant task with a custom Emitter, if necessary.
  - createSelector
```
protected NamespaceSelector createSelector()
```
  - addSysproperty
```
public void addSysproperty(org.apache.tools.ant.types.Environment.Variable sysp)
```
    Adds a system property that tests can access.
    
    Parameters:
    sysp - environment variable to add

Class Wsdl2javaAntTask

Property Summary

Field Summary

Fields inherited from class org.apache.tools.ant.Task

Fields inherited from class org.apache.tools.ant.ProjectComponent

Constructor Summary

Method Summary

Methods inherited from class org.apache.tools.ant.Task

Methods inherited from class org.apache.tools.ant.ProjectComponent

Methods inherited from class java.lang.Object

Property Detail

create

Constructor Detail

Wsdl2javaAntTask

Method Detail

validate

traceParams

execute

setVerbose

setDebug

setQuiet

setServerSide

setSkeletonDeploy

setTestCase

setHelperGen

setFactory

setNoImports

setOutput

setProtocolHandlerPkgs

setDeployScope

setURL

setAll

setTypeMappingVersion

setTimeout

addMapping

addMappingSet

setNamespaceMappingFile

setFailOnNetworkErrors

setPrintStackTraceOnFailure

setUsername

setPassword

setNoWrapped

setAllowInvalidUrl

setImplementationClassName

setWrapArrays

createClasspath

createNsInclude

createNsExclude

createProperty

createEmitter

createSelector

addSysproperty