AbstractCatalinaCommandTask (Apache Tomcat 11.0.25 API Documentation)
Description: declaration: package: org.apache.catalina.ant, class: AbstractCatalinaCommandTask

# Class AbstractCatalinaCommandTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.catalina.ant.BaseRedirectorHelperTask
org.apache.catalina.ant.AbstractCatalinaTask
org.apache.catalina.ant.AbstractCatalinaCommandTask

All Implemented Interfaces:
  `Cloneable`

Direct Known Subclasses:
  `DeployTask, ReloadTask, SessionsTask, StartTask, StopTask, UndeployTask`

public abstract class AbstractCatalinaCommandTask extends AbstractCatalinaTask
Abstract task for Catalina commands.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected String`
  `path`
  The context path of the web application we are managing.
  `protected String`
  `version`
  The context version of the web application we are managing.

  ### Fields inherited from class AbstractCatalinaTask

  `charset, ignoreResponseConstraint, password, url, username`

  ### Fields inherited from class BaseRedirectorHelperTask

  `alwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStream`

  ### 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
  `AbstractCatalinaCommandTask()`
  Create a new instance.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `StringBuilder`
  `createQueryString(String command)`
  Create query string for the specified command.
  `String`
  `getPath()`
  Returns the path.
  `String`
  `getVersion()`
  Returns the version.
  `void`
  `setPath(String path)`
  Sets the path.
  `void`
  `setVersion(String version)`
  Sets the version.

  ### Methods inherited from class AbstractCatalinaTask

  `execute, execute, execute, getCharset, getPassword, getUrl, getUsername, isIgnoreResponseConstraint, setCharset, setIgnoreResponseConstraint, setPassword, setUrl, setUsername`

  ### Methods inherited from class BaseRedirectorHelperTask

  `addConfiguredRedirector, closeRedirector, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, handleOutput, isFailOnError, openRedirector, setAlwaysLog, setAppend, setCreateEmptyFiles, setError, setErrorProperty, setFailonerror, setLogError, setOutput, setOutputproperty`

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

  `bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, 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 Object

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

- ## Field Details

  - ### path

    protected String path
    The context path of the web application we are managing.

  - ### version

    protected String version
    The context version of the web application we are managing.

- ## Constructor Details

  - ### AbstractCatalinaCommandTask

    public AbstractCatalinaCommandTask()
    Create a new instance.

- ## Method Details

  - ### getPath

    public String getPath()
    Returns the path.
    Returns:
      the path

  - ### setPath

    public void setPath(String path)
    Sets the path.
    Parameters:
      `path` - The path to set

  - ### getVersion

    public String getVersion()
    Returns the version.
    Returns:
      the version

  - ### setVersion

    public void setVersion(String version)
    Sets the version.
    Parameters:
      `version` - The version to set

  - ### createQueryString

    public StringBuilder createQueryString(String command) throws org.apache.tools.ant.BuildException
    Create query string for the specified command.
    Parameters:
      `command` - Command to be executed
    Returns:
      The generated query string
    Throws:
      `org.apache.tools.ant.BuildException` - if an error occurs