Package org.jboss.ws.tools.ant

Class WSConsumeTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.jboss.ws.tools.ant.WSConsumeTask
All Implemented Interfaces:
Cloneable
public class WSConsumeTask extends org.apache.tools.ant.Task
Ant task which consumes a Web Service contract.
AttributeDescriptionDefault
forkWhether or not to run the generation task in a separate VM.true
keepKeep/Enable Java source code generation.false
catalog Oasis XML Catalog file for entity resolutionnone
clientjarGnerate the client jar of generated artifacts for calling a webservicenone
package The target Java package for generated code.generated
bindingA JAX-WS or JAXB binding filenone
wsdlLocationValue to use for @@WebService.wsdlLocationgenerated
destdirThe output directory for generated artifacts."output"
sourcedestdirThe output directory for Java source.value of destdir
extensionEnable SOAP 1.2 binding extension.false
verboseEnables more informational output about cmd progress.false
wsdl*The WSDL file or URLn/a
* = required.

Example: 

 <WSConsumeTask
   fork="true"
   verbose="true"
   destdir="output"
   sourcedestdir="gen-src"
   keep="true"
   wsdllocation="handEdited.wsdl"
   wsdl="foo.wsdl">
   <binding dir="binding-files" includes="*.xml" excludes="bad.xml"/>
 </wsimport>
Author:
Jason T. Greene, Richard Opalka

  • Field Summary

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

    target, taskName, taskType, wrapper

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

    description, location, project

  • Constructor Summary

    Constructors
    Constructor
    Description
    WSConsumeTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addConfiguredBinding(org.apache.tools.ant.types.FileSet fs)
     
    org.apache.tools.ant.types.Commandline.Argument
    createJvmarg()
     
    void
    execute()
     
    void
    executeNonForked()
     
    void
    setAdditionalHeaders(boolean additionalHeaders)
     
    void
    setBinding(File bindingFile)
     
    void
    setCatalog(File catalog)
     
    void
    setClientJar(File clientJar)
     
    void
    setDebug(boolean debug)
     
    void
    setDestdir(File destdir)
     
    void
    setEncoding(String encoding)
     
    void
    setExtension(boolean extension)
     
    void
    setFork(boolean fork)
     
    void
    setKeep(boolean keep)
     
    void
    setNoCompile(boolean nocompile)
     
    void
    setPackage(String targetPackage)
     
    void
    setSourcedestdir(File sourcedestdir)
     
    void
    setVerbose(boolean verbose)
     
    void
    setWsdl(String wsdl)
     
    void
    setWsdlLocation(String wsdlLocation)
     

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

    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WSConsumeTask

      public WSConsumeTask()

  • Method Details

    • setDebug

      public void setDebug(boolean debug)

    • createJvmarg

      public org.apache.tools.ant.types.Commandline.Argument createJvmarg()

    • setBinding

      public void setBinding(File bindingFile)

    • setCatalog

      public void setCatalog(File catalog)

    • setClientJar

      public void setClientJar(File clientJar)

    • setDestdir

      public void setDestdir(File destdir)

    • setFork

      public void setFork(boolean fork)

    • setKeep

      public void setKeep(boolean keep)

    • setExtension

      public void setExtension(boolean extension)

    • setAdditionalHeaders

      public void setAdditionalHeaders(boolean additionalHeaders)

    • setSourcedestdir

      public void setSourcedestdir(File sourcedestdir)

    • setPackage

      public void setPackage(String targetPackage)

    • setVerbose

      public void setVerbose(boolean verbose)

    • setNoCompile

      public void setNoCompile(boolean nocompile)

    • setWsdl

      public void setWsdl(String wsdl)

    • setWsdlLocation

      public void setWsdlLocation(String wsdlLocation)

    • setEncoding

      public void setEncoding(String encoding)

    • addConfiguredBinding

      public void addConfiguredBinding(org.apache.tools.ant.types.FileSet fs)

    • executeNonForked

      public void executeNonForked()

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Overrides:
      execute in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException