net.sf.antcontrib.net
Class PostTask
Task
net.sf.antcontrib.net.PostTask
public class PostTask
extends 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.
- Dale Anson, danson@germane-software.com
void | addConfiguredProp(Prop p) - Adds a name/value pair to post.
|
void | addText(String text) - Adds a feature to the Text attribute of the PostTask object
|
void | 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 | setFile(File f) - 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 | setTo(URL name) - 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.
|
addConfiguredProp
public void addConfiguredProp(Prop p)
throws BuildException
Adds a name/value pair to post. Optional.
p
- A property pair to send as part of the post.
addText
public void addText(String text)
Adds a feature to the Text attribute of the PostTask object
text
- The feature to be added to the Text attribute
execute
public void execute()
throws BuildException
Do the post.
setAppend
public void setAppend(boolean b)
Should the log file be appended to or overwritten? Default is true,
append to the file.
setEncoding
public void setEncoding(String encoding)
Sets the encoding of the outgoing properties, default is UTF-8.
encoding
- The new encoding value
setFailonerror
public void setFailonerror(boolean fail)
Should the build fail if the post fails?
fail
- true = fail the build, default is false
setFile
public void setFile(File f)
Set the name of a file to read a set of properties from.
setLogfile
public void setLogfile(File f)
Set the name of a file to save the response to. Optional. Ignored if
"want response" is false.
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).
wait
- time to wait in seconds, set to 0 to wait forever.
setProperty
public void setProperty(String name)
Set the name of a property to save the response to. Optional. Ignored if
"wantResponse" is false.
name
- the name to use for the property
setTo
public void setTo(URL name)
Set the url to post to. Required.
name
- the url to post to.
setVerbose
public void setVerbose(boolean b)
If true, progress messages and returned data from the post will be
displayed. Default is true.
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.
b
- print/log server response