Package org.apache.ivy.util.url
Interface TimeoutConstrainedURLHandler
- All Superinterfaces:
URLHandler
- All Known Implementing Classes:
BasicURLHandler
,HttpClientHandler
,URLHandlerDispatcher
A enhanced version of
URLHandler
which respects TimeoutConstraint
s on
the operations dealing with download, upload, reachability checks etc...-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.ivy.util.url.URLHandler
URLHandler.URLInfo
-
Field Summary
Fields inherited from interface org.apache.ivy.util.url.URLHandler
REQUEST_METHOD_GET, REQUEST_METHOD_HEAD, UNAVAILABLE
-
Method Summary
Modifier and TypeMethodDescriptionvoid
download
(URL src, File dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) Downloads the resource available atsrc
to the targetdest
long
getContentLength
(URL url, TimeoutConstraint timeoutConstraint) Returns the number of bytes of data that's available for the resource at the passedurl
.long
getLastModified
(URL url, TimeoutConstraint timeoutConstraint) Returns the last modified timestamp of the resource accessible at the passedurl
.getURLInfo
(URL url, TimeoutConstraint timeoutConstraint) Returns theURLHandler.URLInfo
extracted from the given url, orURLHandler.UNAVAILABLE
when the url is not reachable.boolean
isReachable
(URL url, TimeoutConstraint timeoutConstraint) Returns true if the passedURL
is reachable.openStream
(URL url, TimeoutConstraint timeoutConstraint) Opens and returns anInputStream
to the passedurl
.void
upload
(File src, URL dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) Methods inherited from interface org.apache.ivy.util.url.URLHandler
download, getContentLength, getContentLength, getLastModified, getLastModified, getURLInfo, getURLInfo, isReachable, isReachable, openStream, setRequestMethod, upload
-
Method Details
-
isReachable
Returns true if the passedURL
is reachable. Else returns false. Uses the passedtimeoutConstraint
for determining the connectivity to the URL.Please use
getURLInfo(URL, TimeoutConstraint)
if more one information about theurl
is needed- Parameters:
url
- The URL to accesstimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Returns:
- boolean
- Since:
- 2.5
-
getContentLength
Returns the number of bytes of data that's available for the resource at the passedurl
. Returns 0 if the passedurl
isn't reachable- Parameters:
url
- The URL to accesstimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Returns:
- long
- Since:
- 2.5
-
getLastModified
Returns the last modified timestamp of the resource accessible at the passedurl
.Please use
getURLInfo(URL, TimeoutConstraint)
if more one information about theurl
is needed- Parameters:
url
- The URL to accesstimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Returns:
- long
- Since:
- 2.5
-
getURLInfo
Returns theURLHandler.URLInfo
extracted from the given url, orURLHandler.UNAVAILABLE
when the url is not reachable. Never returns null.- Parameters:
url
- The URL for which the information is to be retrievedtimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Returns:
- URLInfo
- Since:
- 2.5
-
openStream
Opens and returns anInputStream
to the passedurl
.- Parameters:
url
- The URL to which anInputStream
has to be openedtimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Returns:
- InputStream
- Throws:
IOException
- if something goes wrong- Since:
- 2.5
-
download
void download(URL src, File dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) throws IOException Downloads the resource available atsrc
to the targetdest
- Parameters:
src
- The source URL to download the resource fromdest
- The destinationFile
to download the resource tolistener
- The listener that will be notified of the download progresstimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Throws:
IOException
- if something goes wrong- Since:
- 2.5
-
upload
void upload(File src, URL dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) throws IOException - Parameters:
src
- The sourceFile
to uploaddest
- The target URL where theFile
has to be uploadedlistener
- The listener that will be notified of the upload progresstimeoutConstraint
- The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific- Throws:
IOException
- if something goes wrong- Since:
- 2.5
-