Java2WsdlAntTask (Apache Axis)

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

```
public class Java2WsdlAntTask
extends org.apache.tools.ant.Task
```
Generates a WSDL description from a Java class.

Author:

Rich Scheuerle (scheu@us.ibm.com), Steve Loughran

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

Constructor Summary

Constructors
Constructor and Description

Java2WsdlAntTask()

Constructors
Constructor and Description
`Java2WsdlAntTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addComplexType(ComplexType ct)` Nested element for Complex Types.
`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 optional classpath
`void`	`execute()` execute the task
`protected void`	`generateServerSide(Emitter j2w, String wsdlFileName)` Generate the server side artifacts from the generated WSDL
`void`	`setBindingName(String parameter)` The name to use use for the binding element.
`void`	`setClassName(String parameter)` the class name to import, eg. org.example.Foo.
`void`	`setClasspath(org.apache.tools.ant.types.Path classpath)` Set the optional classpath
`void`	`setClasspathRef(org.apache.tools.ant.types.Reference r)` Set the reference to an optional classpath
`void`	`setDeploy(boolean deploy)` Sets the deploy flag
`void`	`setExclude(String exclude)` Comma separated list of methods to exclude from the wsdl file.
`void`	`setExtraClasses(String extraClasses)` A comma separated list of classes to add to the classpath.
`void`	`setImplClass(String parameter)` Sometimes extra information is available in the implementation class file.
`void`	`setImportSchema(File parameter)` Option attribute that indicates the name of an XML Schema file that should be physically imported into the generated WSDL.
`void`	`setInput(File parameter)` Optional attribute that indicates the name of the input wsdl file.
`void`	`setLocation(String parameter)` The url of the location of the service.
`void`	`setLocationImport(String parameter)` the location of the interface WSDL when generating an implementation WSDL Required when `outputImpl` is set
`void`	`setMethods(String methods)` If this option is specified, only the indicated methods in your interface class will be exported into the WSDL file.
`void`	`setNamespace(String parameter)` the target namespace.
`void`	`setNamespaceImpl(String parameter)` Namespace of the implementation WSDL.
`void`	`setOutput(File parameter)` The name of the output WSDL file.
`void`	`setOutputImpl(File parameter)` Use this option to indicate the name of the output implementation WSDL file.
`void`	`setPortTypeName(String parameter)` Indicates the name to use use for the portType element.
`void`	`setServiceElementName(String serviceElementName)` the name of the service element.
`void`	`setServicePortName(String parameter)` service port name (obtained from location if not specified)
`void`	`setSoapAction(String soapAction)` The setter for the "soapAction" attribute
`void`	`setStopClasses(String stopClasses)` Comma separated list of classes which stop the Java2WSDL inheritance search.
`void`	`setStyle(String style)` The style of the WSDL document: RPC, DOCUMENT or WRAPPED.
`void`	`setTypeMappingVersion(TypeMappingVersionEnum parameter)` the default type mapping registry to use.
`void`	`setUse(String use)` Set the use option
`void`	`setUseInheritedMethods(boolean parameter)` should inherited methods be exported too?
`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

- Constructor Detail
  - Java2WsdlAntTask
```
public Java2WsdlAntTask()
```
- Method Detail
  - traceParams
```
public void traceParams(int logLevel)
```
    trace out parameters
    
    Parameters:
    logLevel - to log at
    See Also:
    Project.log(java.lang.String)
  - validate
```
protected void validate()
                 throws org.apache.tools.ant.BuildException
```
    validation code
    
    Throws:
    
    org.apache.tools.ant.BuildException - if validation failed
  - execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
    execute the task
    
    Overrides:
    
    execute in class org.apache.tools.ant.Task
    
    Throws:
    
    org.apache.tools.ant.BuildException
  - setOutput
```
public void setOutput(File parameter)
```
    The name of the output WSDL file. If not specified, a suitable default WSDL file is written into the current directory.
    
    Parameters:
    parameter -
  - setImportSchema
```
public void setImportSchema(File parameter)
                     throws org.apache.tools.ant.BuildException
```
    Option attribute that indicates the name of an XML Schema file that should be physically imported into the generated WSDL.
    
    Parameters:
    parameter -
    
    Throws:
    
    org.apache.tools.ant.BuildException
  - setInput
```
public void setInput(File parameter)
```
    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.
    
    Parameters:
    parameter - filename
  - setOutputImpl
```
public void setOutputImpl(File parameter)
```
    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
    
    Parameters:
    parameter -
  - setLocation
```
public void setLocation(String parameter)
```
    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.
    
    Parameters:
    parameter - a URL
  - setLocationImport
```
public void setLocationImport(String parameter)
```
    the location of the interface WSDL when generating an implementation WSDL Required when outputImpl is set
    
    Parameters:
    parameter - URL?
  - setClassName
```
public void setClassName(String parameter)
```
    the class name to import, eg. org.example.Foo. Required. The class must be on the classpath.
    
    Parameters:
    parameter - fully qualified class name
  - setImplClass
```
public void setImplClass(String parameter)
```
    Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class.
    
    Parameters:
    parameter -
  - setServicePortName
```
public void setServicePortName(String parameter)
```
    service port name (obtained from location if not specified)
    
    Parameters:
    parameter - portname
  - setPortTypeName
```
public void setPortTypeName(String parameter)
```
    Indicates the name to use use for the portType element. If not specified, the class-of-portType name is used.
    
    Parameters:
    parameter -
  - setBindingName
```
public void setBindingName(String parameter)
```
    The name to use use for the binding element. If not specified, the value of the servicePortName + "SoapBinding" is used.
    
    Parameters:
    parameter -
  - setNamespace
```
public void setNamespace(String parameter)
```
    the target namespace. Required.
    
    Parameters:
    parameter -
  - setNamespaceImpl
```
public void setNamespaceImpl(String parameter)
```
    Namespace of the implementation WSDL.
    
    Parameters:
    parameter -
  - setUseInheritedMethods
```
public void setUseInheritedMethods(boolean parameter)
```
    should inherited methods be exported too? Default=false
    
    Parameters:
    parameter -
  - setExclude
```
public void setExclude(String exclude)
```
    Comma separated list of methods to exclude from the wsdl file.
    
    Parameters:
    exclude -
  - setStopClasses
```
public void setStopClasses(String stopClasses)
```
    Comma separated list of classes which stop the Java2WSDL inheritance search.
    
    Parameters:
    stopClasses -
  - setStyle
```
public void setStyle(String style)
```
    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.
    
    Parameters:
    style -
  - 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
  - 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
  - setMethods
```
public void setMethods(String methods)
```
    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
    
    Parameters:
    methods - list of methods
  - setUse
```
public void setUse(String use)
```
    Set the use option
  - setServiceElementName
```
public void setServiceElementName(String serviceElementName)
```
    the name of the service element. If not specified, the service element is the portTypeNameService.
    
    Parameters:
    serviceElementName -
  - setExtraClasses
```
public void setExtraClasses(String extraClasses)
```
    A comma separated list of classes to add to the classpath.
  - setSoapAction
```
public void setSoapAction(String soapAction)
```
    The setter for the "soapAction" attribute
  - addComplexType
```
public void addComplexType(ComplexType ct)
```
    Nested element for Complex Types. Each Complex Type uses the following fields:
    
    Parameters:
    ct -
  - setClasspath
```
public void setClasspath(org.apache.tools.ant.types.Path classpath)
```
    Set the optional classpath
    
    Parameters:
    classpath - the classpath to use when loading class
  - createClasspath
```
public org.apache.tools.ant.types.Path createClasspath()
```
    Set the optional classpath
    
    Returns:
    a path instance to be configured by the Ant core.
  - setClasspathRef
```
public void setClasspathRef(org.apache.tools.ant.types.Reference r)
```
    Set the reference to an optional classpath
    
    Parameters:
    r - the id of the Ant path instance to act as the classpath
  - 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
  - setDeploy
```
public void setDeploy(boolean deploy)
```
    Sets the deploy flag
    
    Parameters:
    deploy - true if deploy mode
  - generateServerSide
```
protected void generateServerSide(Emitter j2w,
                      String wsdlFileName)
                           throws Exception
```
    Generate the server side artifacts from the generated WSDL
    
    Parameters:
    j2w - the Java2WSDL emitter
    wsdlFileName - the generated WSDL file
    
    Throws:
    
    Exception

Class Java2WsdlAntTask

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

Constructor Detail

Java2WsdlAntTask

Method Detail

traceParams

validate

execute

setOutput

setImportSchema

setInput

setOutputImpl

setLocation

setLocationImport

setClassName

setImplClass

setServicePortName

setPortTypeName

setBindingName

setNamespace

setNamespaceImpl

setUseInheritedMethods

setExclude

setStopClasses

setStyle

addMapping

addMappingSet

setTypeMappingVersion

setMethods

setUse

setServiceElementName

setExtraClasses

setSoapAction

addComplexType

setClasspath

createClasspath

setClasspathRef

addSysproperty

setDeploy

generateServerSide