Package org.apache.catalina.ant
Class AbstractCatalinaTask
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
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 SummaryFieldsModifier and TypeFieldDescriptionprotected StringThe charset used during URL encoding.protected booleanIf set to true - ignore the constraint of the first line of the response message that must be "OK -".protected StringThe login password for theManagerapplication.protected StringThe URL of theManagerapplication to be used.protected StringThe login username for theManagerapplication.Fields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskalwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStreamFields inherited from class org.apache.tools.ant.Tasktarget, taskName, taskType, wrapperFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute()Execute the specified command.voidExecute the specified command, based on the configured properties.voidexecute(String command, InputStream istream, String contentType, long contentLength) Execute the specified command, based on the configured properties.getUrl()booleanvoidsetCharset(String charset) voidsetIgnoreResponseConstraint(boolean ignoreResponseConstraint) voidsetPassword(String password) voidvoidsetUsername(String username) Methods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskaddConfiguredRedirector, closeRedirector, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, handleOutput, isFailOnError, openRedirector, setAlwaysLog, setAppend, setCreateEmptyFiles, setError, setErrorProperty, setFailonerror, setLogError, setOutput, setOutputpropertyMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
charsetThe charset used during URL encoding.
- 
passwordThe login password for theManagerapplication.
- 
urlThe URL of theManagerapplication to be used.
- 
usernameThe login username for theManagerapplication.
- 
ignoreResponseConstraintprotected boolean ignoreResponseConstraintIf 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 Details- 
AbstractCatalinaTaskpublic AbstractCatalinaTask()
 
- 
- 
Method Details- 
getCharset
- 
setCharset
- 
getPassword
- 
setPassword
- 
getUrl
- 
setUrl
- 
getUsername
- 
setUsername
- 
isIgnoreResponseConstraintpublic boolean isIgnoreResponseConstraint()
- 
setIgnoreResponseConstraintpublic void setIgnoreResponseConstraint(boolean ignoreResponseConstraint) 
- 
executepublic void execute() throws org.apache.tools.ant.BuildExceptionExecute the specified command. This logic only performs the common attribute validation required by all subclasses; it does not perform any functional logic directly.- Overrides:
- executein class- org.apache.tools.ant.Task
- Throws:
- org.apache.tools.ant.BuildException- if a validation error occurs
 
- 
executeExecute the specified command, based on the configured properties.- Parameters:
- command- Command to be executed
- Throws:
- org.apache.tools.ant.BuildException- if an error occurs
 
- 
executepublic void execute(String command, InputStream istream, String contentType, long 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
 
 
-