Package net.sf.antcontrib.net
Class PostTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
net.sf.antcontrib.net.PostTask
- All Implemented Interfaces:
Cloneable
public class PostTask
extends org.apache.tools.ant.Task
This task does an http post. Name/value pairs for the post can be set in
either or both of two ways, by nested Prop elements and/or by a file
containing properties. Nested Prop elements are automatically configured by
Ant. Properties from a file are configured by code borrowed from Property so
all Ant property constructs (like ${somename}) are resolved prior to the
post. This means that a file can be set up in advance of running the build
and the appropriate property values will be filled in at run time.
- Version:
- $Revision: 1.11 $
- Author:
- Dale Anson, danson@germane-software.com
-
Nested Class Summary
Nested Classes -
Field Summary
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a name/value pair to post.void
Adds a feature to the Text attribute of the PostTask objectvoid
execute()
Do the post.void
setAppend
(boolean b) Should the log file be appended to or overwritten? Default is true, append to the file.void
setEncoding
(String encoding) Sets the encoding of the outgoing properties, default is UTF-8.void
setFailonerror
(boolean fail) Should the build fail if the post fails?void
Set the name of a file to read a set of properties from.void
setLogfile
(File f) Set the name of a file to save the response to.void
setMaxwait
(int wait) How long to wait on the remote server.void
setProperty
(String name) Set the name of a property to save the response to.void
Set the url to post to.void
setVerbose
(boolean b) If true, progress messages and returned data from the post will be displayed.void
setWantresponse
(boolean b) Default is true, get the response from the post.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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
-
Constructor Details
-
PostTask
public PostTask()
-
-
Method Details
-
setTo
Set the url to post to. Required.- Parameters:
name
- the url to post to.
-
setFile
Set the name of a file to read a set of properties from.- Parameters:
f
- the file
-
setLogfile
Set the name of a file to save the response to. Optional. Ignored if "want response" is false.- Parameters:
f
- the file
-
setAppend
public void setAppend(boolean b) Should the log file be appended to or overwritten? Default is true, append to the file.- Parameters:
b
- append or not
-
setVerbose
public void setVerbose(boolean b) If true, progress messages and returned data from the post will be displayed. Default is true.- Parameters:
b
- true = verbose
-
setWantresponse
public void setWantresponse(boolean b) Default is true, get the response from the post. Can be set to false for "fire and forget" messages.- Parameters:
b
- print/log server response
-
setProperty
Set the name of a property to save the response to. Optional. Ignored if "wantResponse" is false.- Parameters:
name
- the name to use for the property
-
setEncoding
Sets the encoding of the outgoing properties, default is UTF-8.- Parameters:
encoding
- The new encoding value
-
setMaxwait
public void setMaxwait(int wait) How long to wait on the remote server. As a post is generally a two part process (sending and receiving), maxwait is applied separately to each part, that is, if 180 is passed as the wait parameter, this task will spend at most 3 minutes to connect to the remote server and at most another 3 minutes waiting on a response after the post has been sent. This means that the wait period could total as much as 6 minutes (or 360 seconds).The default wait period is 3 minutes (180 seconds).
- Parameters:
wait
- time to wait in seconds, set to 0 to wait forever.
-
setFailonerror
public void setFailonerror(boolean fail) Should the build fail if the post fails?- Parameters:
fail
- true = fail the build, default is false
-
addConfiguredProp
Adds a name/value pair to post. Optional.- Parameters:
p
- A property pair to send as part of the post.- Throws:
org.apache.tools.ant.BuildException
- When name and/or value are missing.
-
addText
Adds a feature to the Text attribute of the PostTask object- Parameters:
text
- The feature to be added to the Text attribute
-
execute
public void execute() throws org.apache.tools.ant.BuildExceptionDo the post.- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
- On any error.
-