net.sf.antcontrib.net
Class 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.
Version: $Revision: 1.9 $
Author: Dale Anson, danson@germane-software.com
Method Summary |
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? |
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. |
public void addConfiguredProp(
Prop p)
Adds a name/value pair to post. Optional.
Parameters: p A property pair to send as part of the post.
Throws: BuildException When name and/or value are missing.
public void addText(String text)
Adds a feature to the Text attribute of the PostTask object
Parameters: text The feature to be added to the Text attribute
public void execute()
Do the post.
Throws: BuildException On any error.
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
public void setEncoding(String encoding)
Sets the encoding of the outgoing properties, default is UTF-8.
Parameters: encoding The new encoding value
public void setFailonerror(boolean fail)
Should the build fail if the post fails?
Parameters: fail true = fail the build, default is false
public void setFile(File f)
Set the name of a file to read a set of properties from.
Parameters: f the file
public void setLogfile(File f)
Set the name of a file to save the response to. Optional. Ignored if
"want response" is false.
Parameters: f the file
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.
public void setProperty(String name)
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
public void setTo(URL name)
Set the url to post to. Required.
Parameters: name the url to post to.
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
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