IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.ant.tasks
Class Java2WSDL

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by com.ibm.ws.webservices.tools.ant.Java2WSDL
              extended by com.ibm.websphere.ant.tasks.Java2WSDL

public class Java2WSDL
extends com.ibm.ws.webservices.tools.ant.Java2WSDL

The Java2WSDL task maps a Java class to a Web Services Description Language (WSDL) file. The structure of the Java2WSDL task is shown below:

<taskdef name="Java2WSDLTask" classname="com.ibm.websphere.ant.tasks.Java2WSDL"> <classpath> <pathelement path="location of installed websphere classes"/> <pathelement path="location of Java class to be mapped"/> </classpath> </taskdef> <Java2WSDLTask output="pathname of wsdl file to create" className="name of Java class to be mapped" classPath="location of Java class to be mapped" implClass="name of Java class implementation to be mapped" namespace="target namespace for the WSDL file being generated" location="location or URL of the service"> <mapping namespace="namespace to map to" package="Java package to map"/> </Java2WSDLTask>


Nested Class Summary
 class Java2WSDL.Mapping
          Used for nested package definitions.
 
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
Java2WSDL()
           
 
Method Summary
 com.ibm.ws.webservices.tools.ant.Java2WSDL.Mapping createMapping()
          Used to provide mappings of a Java package to a namespace.
 void setBindingName(java.lang.String bindingName)
          Sets the bindingName
 void setBindingTypes(java.lang.String bindingTypes)
          Set the list of binding types to be produced in the resulting WSDL document.
 void setClassName(java.lang.String className)
          Sets the className
 void setClasspath(java.lang.String cp)
          Set classpath to use for class introspection.
 void setDebug(boolean debug)
          Sets the debug
 void setExtraClasses(java.lang.String extraClasses)
          Sets the extraClasses
 void setImplClass(java.lang.String implClass)
          Sets the implClass
 void setInput(java.lang.String input)
          Sets the input
 void setLocation(java.lang.String location)
          Sets the location
 void setLocationImport(java.lang.String locationImport)
          Sets the locationImport
 void setMethods(java.lang.String methods)
          Allows users to indicate which methods on the SEI should be exposed in the output wsdl file.
 void setMIMEStyle(java.lang.String mimeStyle)
          Sets the mimeStyle
 void setNamespace(java.lang.String namespace)
          Sets the namespace
 void setNamespaceImpl(java.lang.String namespaceImpl)
          Sets the namespaceImpl
 void setOutput(java.lang.String output)
          Sets the output
 void setOutputImpl(java.lang.String outputImpl)
          Sets the outputImpl
 void setPortTypeName(java.lang.String portTypeName)
          Sets the portTypeName
 void setProperties(java.lang.String properties)
          Allows specification of binding specific properties.
 void setPropertiesFile(java.lang.String propertiesFile)
          Allows specification of a properties file which can contain either a list of class names that should be added to the type section of the output wsdl, and/or a list of
 void setServiceElementName(java.lang.String serviceElementName)
          Sets the serviceElementName
 void setServicePortName(java.lang.String servicePortName)
          Sets the servicePortName
 void setSoapAction(java.lang.String soapAction)
          Sets the soapAction
 void setStopClasses(java.lang.String stopClasses)
          Sets the stopClasses
 void setStyle(java.lang.String style)
          Sets the style
 void setTransport(java.lang.String transport)
          Sets the transport
 void setUse(java.lang.String use)
          Sets the use
 void setVerbose(boolean verbose)
          Sets the verbose
 void setVoidReturn(java.lang.String voidReturn)
          Sets the voidReturn
 void setWrapped(boolean value)
          Sets the wrapped
 
Methods inherited from class com.ibm.ws.webservices.tools.ant.Java2WSDL
execute, setAttributeFormDefault, setElementFormDefault
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
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

Java2WSDL

public Java2WSDL()
Method Detail

setOutput

public void setOutput(java.lang.String output)
Sets the output

Overrides:
setOutput in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
output - The output WSDL pathname to set.

setInput

public void setInput(java.lang.String input)
Sets the input

Overrides:
setInput in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
input - The input WSDL to set.

setOutputImpl

public void setOutputImpl(java.lang.String outputImpl)
Sets the outputImpl

Overrides:
setOutputImpl in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
outputImpl - The outputImpl to set.

setLocation

public void setLocation(java.lang.String location)
Sets the location

Overrides:
setLocation in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
location - The location to set.

setLocationImport

public void setLocationImport(java.lang.String locationImport)
Sets the locationImport

Overrides:
setLocationImport in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
locationImport - The locationImport to set.

setClassName

public void setClassName(java.lang.String className)
Sets the className

Overrides:
setClassName in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
className - The className to set.

setImplClass

public void setImplClass(java.lang.String implClass)
Sets the implClass

Overrides:
setImplClass in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
implClass - The implClass to set.

setSoapAction

public void setSoapAction(java.lang.String soapAction)
Sets the soapAction

Overrides:
setSoapAction in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
soapAction - The soapAction to set.

setServiceElementName

public void setServiceElementName(java.lang.String serviceElementName)
Sets the serviceElementName

Overrides:
setServiceElementName in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
serviceElementName - The serviceElementName to set.

setServicePortName

public void setServicePortName(java.lang.String servicePortName)
Sets the servicePortName

Overrides:
setServicePortName in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
servicePortName - The servicePortName to set.

setPortTypeName

public void setPortTypeName(java.lang.String portTypeName)
Sets the portTypeName

Overrides:
setPortTypeName in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
portTypeName - The portTypeName to set.

setBindingName

public void setBindingName(java.lang.String bindingName)
Sets the bindingName

Overrides:
setBindingName in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
bindingName - The bindingName to set.

setNamespace

public void setNamespace(java.lang.String namespace)
Sets the namespace

Overrides:
setNamespace in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
namespace - The namespace to set.

setNamespaceImpl

public void setNamespaceImpl(java.lang.String namespaceImpl)
Sets the namespaceImpl

Overrides:
setNamespaceImpl in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
namespaceImpl - The namespaceImpl to set.

setVerbose

public void setVerbose(boolean verbose)
Sets the verbose

Overrides:
setVerbose in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
verbose - The verbose to set.

setDebug

public void setDebug(boolean debug)
Sets the debug

Overrides:
setDebug in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
debug - The debug to set.

setStopClasses

public void setStopClasses(java.lang.String stopClasses)
Sets the stopClasses

Overrides:
setStopClasses in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
stopClasses - The stopClasses to set.

setMethods

public void setMethods(java.lang.String methods)
Allows users to indicate which methods on the SEI should be exposed in the output wsdl file.

Overrides:
setMethods in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
methods - A space or comma separated list of the SEI methods which should be exposed in the output wsdl.

setStyle

public void setStyle(java.lang.String style)
Sets the style

Overrides:
setStyle in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
style - The style to be used in the generated WSDL file.

setUse

public void setUse(java.lang.String use)
Sets the use

Overrides:
setUse in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
use - The use to set.

setWrapped

public void setWrapped(boolean value)
Sets the wrapped

Overrides:
setWrapped in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
wrapped - The wrapped to set.

setMIMEStyle

public void setMIMEStyle(java.lang.String mimeStyle)
Sets the mimeStyle

Overrides:
setMIMEStyle in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
mimeStyle - The mimeStyle to set.

setTransport

public void setTransport(java.lang.String transport)
Sets the transport

Overrides:
setTransport in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
transport - The transport to set, either HTTP (default) or JMS.

setBindingTypes

public void setBindingTypes(java.lang.String bindingTypes)
Set the list of binding types to be produced in the resulting WSDL document.

Overrides:
setBindingTypes in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
bindingTypes - a String containing a colon-separated list of binding types.

setProperties

public void setProperties(java.lang.String properties)
Allows specification of binding specific properties. Allows specification of properties which specify a list of class names that should be added to the type section of the output wsdl. Example: extraClasses=com.ibm.Class1,com.sun.Class2,org.apache.Class3

Overrides:
setProperties in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
properties - a comma or blank seperated list of

setVoidReturn

public void setVoidReturn(java.lang.String voidReturn)
Sets the voidReturn

Overrides:
setVoidReturn in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
voidReturn - The voidReturn to set.

setExtraClasses

public void setExtraClasses(java.lang.String extraClasses)
Sets the extraClasses

Overrides:
setExtraClasses in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
extraClasses - The extraClasses to set.

setPropertiesFile

public void setPropertiesFile(java.lang.String propertiesFile)
Allows specification of a properties file which can contain either a list of class names that should be added to the type section of the output wsdl, and/or a list of
Overrides:
setPropertiesFile in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
propertiesFile - Name of the properties file.

setClasspath

public void setClasspath(java.lang.String cp)
Set classpath to use for class introspection.

Overrides:
setClasspath in class com.ibm.ws.webservices.tools.ant.Java2WSDL
Parameters:
cp - a String representing classpath.

createMapping

public com.ibm.ws.webservices.tools.ant.Java2WSDL.Mapping createMapping()
Used to provide mappings of a Java package to a namespace. If a package is encountered that does not have a namespace, Java2WSDL will generate a suitable namespace name. This argument may be repeated to specify mappings for multiple packages.

Overrides:
createMapping in class com.ibm.ws.webservices.tools.ant.Java2WSDL

IBM WebSphere Application ServerTM
Release 7