Class Http
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.taskdefs.condition.Http
-
- All Implemented Interfaces:
java.lang.Cloneable,Condition
public class Http extends ProjectComponent implements Condition
Condition to wait for a HTTP request to succeed. Its attribute(s) are: url - the URL of the request. errorsBeginAt - number at which errors begin at; default=400. requestMethod - HTTP request method to use; GET, HEAD, etc. default=GET readTimeout - The read timeout in ms. default=0- Since:
- Ant 1.5
-
-
Field Summary
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description Http()
-
Method Summary
Modifier and Type Method Description booleaneval()Is this condition true?voidsetErrorsBeginAt(int errorsBeginAt)Set the errorsBeginAt attributevoidsetFollowRedirects(boolean f)Whether redirects sent by the server should be followed, defaults to true.voidsetReadTimeout(int t)Sets the read timeout.voidsetRequestMethod(java.lang.String method)Sets the method to be used when issuing the HTTP request.voidsetUrl(java.lang.String url)Set the url attribute-
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
-
-
-
Method Detail
-
setUrl
public void setUrl(java.lang.String url)
Set the url attribute- Parameters:
url- the url of the request
-
setErrorsBeginAt
public void setErrorsBeginAt(int errorsBeginAt)
Set the errorsBeginAt attribute- Parameters:
errorsBeginAt- number at which errors begin at, default is 400
-
setRequestMethod
public void setRequestMethod(java.lang.String method)
Sets the method to be used when issuing the HTTP request.- Parameters:
method- The HTTP request method to use. Valid values are the same as those accepted by the HttpURLConnection.setRequestMethod() method, such as "GET", "HEAD", "TRACE", etc. The default if not specified is "GET".- Since:
- Ant 1.8.0
- See Also:
HttpURLConnection.setRequestMethod(java.lang.String)
-
setFollowRedirects
public void setFollowRedirects(boolean f)
Whether redirects sent by the server should be followed, defaults to true.- Parameters:
f- boolean- Since:
- Ant 1.9.7
-
setReadTimeout
public void setReadTimeout(int t)
Sets the read timeout. Any value < 0 will be ignored- Parameters:
t- the timeout value in milli seconds- Since:
- Ant 1.10.6
- See Also:
URLConnection.setReadTimeout(int)
-
eval
public boolean eval() throws BuildExceptionDescription copied from interface:ConditionIs this condition true?- Specified by:
evalin interfaceCondition- Returns:
- true if the HTTP request succeeds
- Throws:
BuildException- if an error occurs
-
-