WebLogicHotDeploymentTool (Apache Ant API)
Date: 2018-03-24

org.apache.tools.ant.taskdefs.optional.j2ee

## Class WebLogicHotDeploymentTool

- java.lang.Object
- - org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
  - - org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool

- All Implemented Interfaces:
    HotDeploymentTool

      public class WebLogicHotDeploymentTool
      extends AbstractHotDeploymentTool
      implements HotDeploymentTool

  An Ant wrapper task for the weblogic.deploy tool. This is used to hot-deploy J2EE applications to a running WebLogic server. This is not the same as creating the application archive. This task assumes the archive (EAR, JAR, or WAR) file has been assembled and is supplied as the "source" attribute.

  In the end, this task assembles the commandline parameters and runs the weblogic.deploy tool in a separate JVM.

  See Also:
    `HotDeploymentTool`, `AbstractHotDeploymentTool`, `ServerDeploy`

- - ### Field Summary

    - ### Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool

      `ACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `WebLogicHotDeploymentTool()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected java.lang.StringBuffer` | `buildArgsPrefix()` Builds the prefix arguments to pass to weblogic.deploy.
    `protected java.lang.String` | `buildDeployArgs()` Builds the arguments to pass to weblogic.deploy for deployment actions ("deploy" and "update").
    `protected java.lang.String` | `buildListArgs()` Builds the arguments to pass to weblogic.deploy for the list action
    `protected java.lang.String` | `buildUndeployArgs()` Builds the arguments to pass to weblogic.deploy for undeployment actions ("undeploy" and "delete").
    `void` | `deploy()` Perform the actual deployment.
    `java.lang.String` | `getArguments()` Builds the arguments to pass to weblogic.deploy according to the supplied action.
    `protected boolean` | `isActionValid()` Determines if the action supplied is valid.
    `void` | `setApplication(java.lang.String application)` The name of the application being deployed; required.
    `void` | `setComponent(java.lang.String component)` the component string for the deployment targets; optional.
    `void` | `setDebug(boolean debug)` If set to true, additional information will be printed during the deployment process; optional.
    `void` | `validateAttributes()` Validates the passed in attributes.

    - ### Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool

      `createClasspath, getClasspath, getPassword, getServer, getTask, getUserName, setClasspath, setPassword, setServer, setTask, setUserName`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool

      `setTask`

- - ### Constructor Detail

    - #### WebLogicHotDeploymentTool

          public WebLogicHotDeploymentTool()

  - ### Method Detail

    - #### deploy

          public void deploy()

      Perform the actual deployment. For this implementation, a JVM is spawned and the weblogic.deploy tools is executed.
      Specified by:
        `deploy` in interface `HotDeploymentTool`
      Throws:
        `BuildException` - if the attributes are invalid or incomplete.

    - #### validateAttributes

          public void validateAttributes()
                                  throws BuildException

      Validates the passed in attributes.

      The rules are:

      1. If action is "deploy" or "update" the "application" and "source" attributes must be supplied.
      2. If action is "delete" or "undeploy" the "application" attribute must be supplied.
      Specified by:
        `validateAttributes` in interface `HotDeploymentTool`
      Overrides:
        `validateAttributes` in class `AbstractHotDeploymentTool`
      Throws:
        `BuildException` - if the attributes are invalid or incomplete

    - #### getArguments

          public java.lang.String getArguments()
                                        throws BuildException

      Builds the arguments to pass to weblogic.deploy according to the supplied action.
      Returns:
        A String containing the arguments for the weblogic.deploy tool.
      Throws:
        `BuildException` - if there is an error.

    - #### isActionValid

          protected boolean isActionValid()

      Determines if the action supplied is valid.

      Valid actions are contained in the static array VALID_ACTIONS

      Specified by:
        `isActionValid` in class `AbstractHotDeploymentTool`
      Returns:
        true if the action attribute is valid, false if not.

    - #### buildArgsPrefix

          protected java.lang.StringBuffer buildArgsPrefix()

      Builds the prefix arguments to pass to weblogic.deploy. These arguments are generic across all actions.
      Returns:
        A StringBuffer containing the prefix arguments. The action-specific build methods will append to this StringBuffer.

    - #### buildDeployArgs

          protected java.lang.String buildDeployArgs()

      Builds the arguments to pass to weblogic.deploy for deployment actions ("deploy" and "update").
      Returns:
        A String containing the full argument string for weblogic.deploy.

    - #### buildUndeployArgs

          protected java.lang.String buildUndeployArgs()

      Builds the arguments to pass to weblogic.deploy for undeployment actions ("undeploy" and "delete").
      Returns:
        A String containing the full argument string for weblogic.deploy.

    - #### buildListArgs

          protected java.lang.String buildListArgs()

      Builds the arguments to pass to weblogic.deploy for the list action
      Returns:
        A String containing the full argument string for weblogic.deploy.

    - #### setDebug

          public void setDebug(boolean debug)

      If set to true, additional information will be printed during the deployment process; optional.
      Parameters:
        `debug` - A boolean representing weblogic.deploy "-debug" flag.

    - #### setApplication

          public void setApplication(java.lang.String application)

      The name of the application being deployed; required.
      Parameters:
        `application` - A String representing the application portion of the weblogic.deploy command line.

    - #### setComponent

          public void setComponent(java.lang.String component)

      the component string for the deployment targets; optional. It is in the form `<component>:<target1>,<target2>...` Where component is the archive name (minus the .jar, .ear, .war extension). Targets are the servers where the components will be deployed
      Parameters:
        `component` - A String representing the value of the "-component" argument of the weblogic.deploy command line argument.