AbstractCatalinaTask (Apache Tomcat 8.0.15 API Documentation)

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AbstractCatalinaCommandTask, FindLeaksTask, JKStatusUpdateTask, JMXGetTask, JMXQueryTask, JMXSetTask, ListTask, ResourcesTask, ServerinfoTask, SslConnectorCiphersTask, ThreaddumpTask, VminfoTask
```
public abstract class AbstractCatalinaTask
extends BaseRedirectorHelperTask
```
Abstract base class for Ant tasks that interact with the Manager web application for dynamically deploying and undeploying applications. These tasks require Ant 1.4 or later.

Since:

4.1

Author:

Craig R. McClanahan

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`charset` The charset used during URL encoding.
`protected boolean`	`ignoreResponseConstraint` If set to true - ignore the constraint of the first line of the response message that must be "OK -".
`protected String`	`password` The login password for the `Manager` application.
`protected String`	`url` The URL of the `Manager` application to be used.
`protected String`	`username` The login username for the `Manager` application.

Fields inherited from class org.apache.catalina.ant.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 and Description

AbstractCatalinaTask()

Constructors
Constructor and Description
`AbstractCatalinaTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute()` Execute the specified command.
`void`	`execute(String command)` Execute the specified command, based on the configured properties.
`void`	`execute(String command, InputStream istream, String contentType, int contentLength)` Execute the specified command, based on the configured properties.
`String`	`getCharset()`
`String`	`getPassword()`
`String`	`getUrl()`
`String`	`getUsername()`
`boolean`	`isIgnoreResponseConstraint()`
`void`	`setCharset(String charset)`
`void`	`setIgnoreResponseConstraint(boolean ignoreResponseConstraint)`
`void`	`setPassword(String password)`
`void`	`setUrl(String url)`
`void`	`setUsername(String username)`

Methods inherited from class org.apache.catalina.ant.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 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - charset
```
protected String charset
```
    The charset used during URL encoding.
  - password
```
protected String password
```
    The login password for the Manager application.
  - url
```
protected String url
```
    The URL of the Manager application to be used.
  - username
```
protected String username
```
    The login username for the Manager application.
  - ignoreResponseConstraint
```
protected boolean ignoreResponseConstraint
```
    If set to true - ignore the constraint of the first line of the response message that must be "OK -".
    When this attribute is set to false (the default), the first line of server response is expected to start with "OK -". If it does not then the task is considered as failed and the first line is treated as an error message.
    When this attribute is set to true, the first line of the response is treated like any other, regardless of its text.
- Constructor Detail
  - AbstractCatalinaTask
```
public AbstractCatalinaTask()
```
- Method Detail
  - getCharset
```
public String getCharset()
```
  - setCharset
```
public void setCharset(String charset)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
  - getUrl
```
public String getUrl()
```
  - setUrl
```
public void setUrl(String url)
```
  - getUsername
```
public String getUsername()
```
  - setUsername
```
public void setUsername(String username)
```
  - isIgnoreResponseConstraint
```
public boolean isIgnoreResponseConstraint()
```
  - setIgnoreResponseConstraint
```
public void setIgnoreResponseConstraint(boolean ignoreResponseConstraint)
```
  - execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
    Execute the specified command. This logic only performs the common attribute validation required by all subclasses; it does not perform any functional logic directly.
    
    Overrides:
    
    execute in class org.apache.tools.ant.Task
    
    Throws:
    
    org.apache.tools.ant.BuildException - if a validation error occurs
  - execute
```
public void execute(String command)
             throws org.apache.tools.ant.BuildException
```
    Execute the specified command, based on the configured properties.
    
    Parameters:
    command - Command to be executed
    
    Throws:
    
    org.apache.tools.ant.BuildException - if an error occurs
  - execute
```
public void execute(String command,
           InputStream istream,
           String contentType,
           int contentLength)
             throws org.apache.tools.ant.BuildException
```
    Execute the specified command, based on the configured properties. The input stream will be closed upon completion of this task, whether it was executed successfully or not.
    
    Parameters:
    command - Command to be executed
    istream - InputStream to include in an HTTP PUT, if any
    contentType - Content type to specify for the input, if any
    contentLength - Content length to specify for the input, if any
    
    Throws:
    
    org.apache.tools.ant.BuildException - if an error occurs

Class AbstractCatalinaTask

Field Summary

Fields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask

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

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask

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

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

Methods inherited from class java.lang.Object

Field Detail

charset

password

url

username

ignoreResponseConstraint

Constructor Detail

AbstractCatalinaTask

Method Detail

getCharset

setCharset

getPassword

setPassword

getUrl

setUrl

getUsername

setUsername

isIgnoreResponseConstraint

setIgnoreResponseConstraint

execute

execute

execute