Package org.apache.catalina.ant

Class DeployTask

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

org.apache.catalina.ant.DeployTask

All Implemented Interfaces:

java.lang.Cloneable

public class DeployTask
extends AbstractCatalinaCommandTask

Ant task that implements the /deploy command, supported by the Tomcat manager application.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	config	URL of the context configuration file for this application, if any.
protected java.lang.String	localWar	URL of the server local web application archive (WAR) file to be deployed.
protected java.lang.String	tag	Tag to associate with this to be deployed webapp.
protected boolean	update	Update existing webapps.
protected java.lang.String	war	URL of the web application archive (WAR) file to be deployed.

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

path, version

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

charset, ignoreResponseConstraint, password, url, username

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	Description
DeployTask()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute the requested operation.
java.lang.String	getConfig()	Get the context configuration file URL.
java.lang.String	getLocalWar()	Get the local WAR file path.
java.lang.String	getTag()	Get the deployment tag.
boolean	getUpdate()	Check if existing webapps should be updated.
java.lang.String	getWar()	Get the WAR file URL.
void	setConfig(java.lang.String config)	Set the context configuration file URL.
void	setLocalWar(java.lang.String localWar)	Set the local WAR file path.
void	setTag(java.lang.String tag)	Set the deployment tag.
void	setUpdate(boolean update)	Set whether to update existing webapps.
void	setWar(java.lang.String war)	Set the WAR file URL.

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

createQueryString, getPath, getVersion, setPath, setVersion

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

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

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

config

protected java.lang.String config

URL of the context configuration file for this application, if any.

localWar

protected java.lang.String localWar

URL of the server local web application archive (WAR) file to be deployed.

tag

protected java.lang.String tag

Tag to associate with this to be deployed webapp.

update

protected boolean update

Update existing webapps.

war

protected java.lang.String war

URL of the web application archive (WAR) file to be deployed.

Constructor Detail

DeployTask

public DeployTask()

Default constructor.

Method Detail

getConfig

public java.lang.String getConfig()

Get the context configuration file URL.

Returns:

Context configuration file URL

setConfig

public void setConfig(java.lang.String config)

Set the context configuration file URL.

Parameters:

config - Context configuration file URL

getLocalWar

public java.lang.String getLocalWar()

Get the local WAR file path.

Returns:

Local WAR file path

setLocalWar

public void setLocalWar(java.lang.String localWar)

Set the local WAR file path.

Parameters:

localWar - Local WAR file path

getTag

public java.lang.String getTag()

Get the deployment tag.

Returns:

Deployment tag

setTag

public void setTag(java.lang.String tag)

Set the deployment tag.

Parameters:

tag - Deployment tag

getUpdate

public boolean getUpdate()

Check if existing webapps should be updated.

Returns:

true if existing webapps should be updated

setUpdate

public void setUpdate(boolean update)

Set whether to update existing webapps.

Parameters:

update - true to update existing webapps

getWar

public java.lang.String getWar()

Get the WAR file URL.

Returns:

WAR file URL

setWar

public void setWar(java.lang.String war)

Set the WAR file URL.

Parameters:

war - WAR file URL

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute the requested operation.

Overrides:

execute in class AbstractCatalinaTask

Throws:

org.apache.tools.ant.BuildException - if an error occurs