com.ibm.websphere.ant.tasks

Class WSDeploy

  • java.lang.Object
    • org.apache.tools.ant.ProjectComponent
      • org.apache.tools.ant.Task
        • com.ibm.ws.webservices.tools.ant.WSDeploy
          • com.ibm.websphere.ant.tasks.WSDeploy


  • public class WSDeploy
    extends com.ibm.ws.webservices.tools.ant.WSDeploy
    The wsdeploy task executes the WebSphere Web Services Deploy tool on the specified EAR file with the specified options. The structure of the wsdeploy task is shown below: <taskdef name="wsdeploy" classname="com.ibm.websphere.ant.tasks.WSDeploy"> </taskdef> <wsdeploy inputFile="input earfile" outputFile="output earfile" classpath="javac compilation classes" debug="true | false" ignoreErrors="true | false" noValidate="true | false" trace="true | false"/> The inputFile attribute is required and contains the undeployed EAR file you wish to deploy.
    The outputFile attribute is required and specifies the name of the deployed EAR file to create.
    The classpath attribute is required. It specifies the classes to be added to the classpath used to compile generated files. The classpath contains colon or semicolon separated jar file names. This path must include install_root/dev/JavaEE/j2ee.jar;install_root/runtimes/com.ibm.ws.webservices.thinclient_8.0.0.jar
    The debug attribute is optional and is set to true to compile the generated Java files with debug information
    The ignoreErrors attribute is optional and is set to true to continue deploying modules despite errors
    The noValidate attribute is optional and set to true to disable validation messages
    The trace attribute is optional and set to true to enable tracing of file generation and compilation

    • 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
      WSDeploy()
      Constructor for WSDeploy
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      org.apache.tools.ant.types.Path createClasspath()
      Creates a nested classpath element.
      void execute() 
      void setClasspath(org.apache.tools.ant.types.Path classpath)
      Sets the compilation classpath from a string of colon or semicolon separated jar file names.
      void setIgnoreErrors(boolean ignoreErrors)
      Continue deploying even in the presence of errors.
      void setInputFile(java.lang.String inputFile)
      Set the input EAR file name This value is required.
      void setNoValidate(boolean noValidate)
      Disable Web Services validation when the parameter is true.
      void setOutputFile(java.lang.String outputFile)
      Sets the output EAR file name.
      void setTrace(boolean trace)
      Enable trace of file generation and compilation.
      • Methods inherited from class com.ibm.ws.webservices.tools.ant.WSDeploy

        setClassPath, setDebug
      • 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

      • WSDeploy

        public WSDeploy()
        Constructor for WSDeploy
    • Method Detail

      • createClasspath

        public org.apache.tools.ant.types.Path createClasspath()
        Creates a nested classpath element.
      • setClasspath

        public void setClasspath(org.apache.tools.ant.types.Path classpath)
        Sets the compilation classpath from a string of colon or semicolon separated jar file names.
        Parameters:
        classpath - The jar files to be added to the compilation classpath.
      • setIgnoreErrors

        public void setIgnoreErrors(boolean ignoreErrors)
        Continue deploying even in the presence of errors. Default is false.
        Overrides:
        setIgnoreErrors in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Parameters:
        ignoreErrors - Continue in the presence of errors when true.
      • setInputFile

        public void setInputFile(java.lang.String inputFile)
        Set the input EAR file name This value is required.
        Overrides:
        setInputFile in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Parameters:
        inputFile - The file system path of the input EAR file
      • setNoValidate

        public void setNoValidate(boolean noValidate)
        Disable Web Services validation when the parameter is true. Default is false (validation is enabled).
        Overrides:
        setNoValidate in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Parameters:
        noValidate - Disable validation when true.
      • setOutputFile

        public void setOutputFile(java.lang.String outputFile)
        Sets the output EAR file name. This value is required.
        Overrides:
        setOutputFile in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Parameters:
        outputFile - The file system path of the output EAR file.
      • setTrace

        public void setTrace(boolean trace)
        Enable trace of file generation and compilation. Default is false.
        Overrides:
        setTrace in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Parameters:
        trace - If true, display trace information
      • execute

        public void execute()
                     throws org.apache.tools.ant.BuildException
        Overrides:
        execute in class com.ibm.ws.webservices.tools.ant.WSDeploy
        Throws:
        org.apache.tools.ant.BuildException
        See Also:
        Task#execute()
IBM WebSphere Application ServerTM
Release 9.0