java.lang.Object

org.apache.ivy.util.url.AbstractURLHandler

org.apache.ivy.util.url.HttpClientHandler

All Implemented Interfaces:: AutoCloseable, TimeoutConstrainedURLHandler, URLHandler

public class HttpClientHandler extends AbstractURLHandler implements TimeoutConstrainedURLHandler, AutoCloseable

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
Constructor Summary

Constructors

Constructor

Description

HttpClientHandler()
Method Summary

Modifier and Type

Method

Description

void

close()

void

download(URL src, File dest, CopyProgressListener l)

void

download(URL src, File dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint)

Downloads the resource available at src to the target dest

long

getContentLength(URL url, TimeoutConstraint timeoutConstraint)

Returns the number of bytes of data that's available for the resource at the passed url.

long

getLastModified(URL url, TimeoutConstraint timeoutConstraint)

Returns the last modified timestamp of the resource accessible at the passed url.

URLHandler.URLInfo

getURLInfo(URL url)

URLHandler.URLInfo

getURLInfo(URL url, int timeout)

URLHandler.URLInfo

getURLInfo(URL url, TimeoutConstraint timeoutConstraint)

Returns the URLHandler.URLInfo extracted from the given url, or URLHandler.UNAVAILABLE when the url is not reachable.

boolean

isReachable(URL url, TimeoutConstraint timeoutConstraint)

Returns true if the passed URL is reachable.

InputStream

openStream(URL url)

InputStream

openStream(URL url, TimeoutConstraint timeoutConstraint)

Opens and returns an InputStream to the passed url.

void

upload(File src, URL dest, CopyProgressListener l)

void

upload(File src, URL dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint)

Uploads the src File to the target dest URL

Methods inherited from class org.apache.ivy.util.url.AbstractURLHandler
createTimeoutConstraints, getContentLength, getContentLength, getDecodingInputStream, getLastModified, getLastModified, getRequestMethod, getUserAgent, isReachable, isReachable, normalizeToString, normalizeToURL, setRequestMethod, validatePutStatusCode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.ivy.util.url.URLHandler
getContentLength, getContentLength, getLastModified, getLastModified, isReachable, isReachable, setRequestMethod

Constructor Details
- HttpClientHandler
  
  public HttpClientHandler()
Method Details
- openStream
  
  public InputStream openStream(URL url) throws IOException
  
  Specified by:
  
  openStream in interface URLHandler
  
  Parameters:
  
  url - ditto
  
  Returns:
  
  InputStream
  
  Throws:
  
  IOException - if something goes wrong
- openStream
  
  public InputStream openStream(URL url, TimeoutConstraint timeoutConstraint) throws IOException
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Opens and returns an InputStream to the passed url.
  
  Specified by:
  
  openStream in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  url - The URL to which an InputStream has to be opened
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Returns:
  
  InputStream
  
  Throws:
  
  IOException - if something goes wrong
- download
  
  public void download(URL src, File dest, CopyProgressListener l) throws IOException
  
  Specified by:
  
  download in interface URLHandler
  
  Parameters:
  
  src - URL
  
  dest - File
  
  l - CopyProgressListener
  
  Throws:
  
  IOException - if something goes wrong
- download
  
  public void download(URL src, File dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) throws IOException
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Downloads the resource available at src to the target dest
  
  Specified by:
  
  download in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  src - The source URL to download the resource from
  
  dest - The destination File to download the resource to
  
  listener - The listener that will be notified of the download progress
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Throws:
  
  IOException - if something goes wrong
- upload
  
  public void upload(File src, URL dest, CopyProgressListener l) throws IOException
  
  Specified by:
  
  upload in interface URLHandler
  
  Parameters:
  
  src - File
  
  dest - URL
  
  l - CopyProgressListener
  
  Throws:
  
  IOException - if something goes wrong
- upload
  
  public void upload(File src, URL dest, CopyProgressListener listener, TimeoutConstraint timeoutConstraint) throws IOException
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Uploads the src File to the target dest URL
  
  Specified by:
  
  upload in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  src - The source File to upload
  
  dest - The target URL where the File has to be uploaded
  
  listener - The listener that will be notified of the upload progress
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Throws:
  
  IOException - if something goes wrong
- getURLInfo
  
  public URLHandler.URLInfo getURLInfo(URL url)
  
  Specified by:
  
  getURLInfo in interface URLHandler
  
  Parameters:
  
  url - The url from which information is retrieved.
  
  Returns:
  
  The URLInfo extracted from the given url, or URLHandler.UNAVAILABLE instance when the url is not reachable.
- getURLInfo
  
  public URLHandler.URLInfo getURLInfo(URL url, int timeout)
  
  Specified by:
  
  getURLInfo in interface URLHandler
  
  Parameters:
  
  url - The url from which information is retrieved.
  
  timeout - The timeout in milliseconds.
  
  Returns:
  
  The URLInfo extracted from the given url, or URLHandler.UNAVAILABLE when the url is not reachable, never null.
- isReachable
  
  public boolean isReachable(URL url, TimeoutConstraint timeoutConstraint)
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Returns true if the passed URL is reachable. Else returns false. Uses the passed timeoutConstraint for determining the connectivity to the URL.
  Please use TimeoutConstrainedURLHandler.getURLInfo(URL, TimeoutConstraint) if more one information about the url is needed
  
  Specified by:
  
  isReachable in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  url - The URL to access
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Returns:
  
  boolean
- getContentLength
  
  public long getContentLength(URL url, TimeoutConstraint timeoutConstraint)
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Returns the number of bytes of data that's available for the resource at the passed url. Returns 0 if the passed url isn't reachable
  
  Specified by:
  
  getContentLength in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  url - The URL to access
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Returns:
  
  long
- getLastModified
  
  public long getLastModified(URL url, TimeoutConstraint timeoutConstraint)
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Returns the last modified timestamp of the resource accessible at the passed url.
  Please use TimeoutConstrainedURLHandler.getURLInfo(URL, TimeoutConstraint) if more one information about the url is needed
  
  Specified by:
  
  getLastModified in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  url - The URL to access
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Returns:
  
  long
- getURLInfo
  
  public URLHandler.URLInfo getURLInfo(URL url, TimeoutConstraint timeoutConstraint)
  
  Description copied from interface: TimeoutConstrainedURLHandler
  
  Returns the URLHandler.URLInfo extracted from the given url, or URLHandler.UNAVAILABLE when the url is not reachable. Never returns null.
  
  Specified by:
  
  getURLInfo in interface TimeoutConstrainedURLHandler
  
  Parameters:
  
  url - The URL for which the information is to be retrieved
  
  timeoutConstraint - The connectivity timeout constraints. Can be null, in which case the timeouts are implementation specific
  
  Returns:
  
  URLInfo
- close
  
  public void close() throws Exception
  
  Specified by:
  
  close in interface AutoCloseable
  
  Throws:
  
  Exception

Class HttpClientHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ivy.util.url.URLHandler

Field Summary

Fields inherited from interface org.apache.ivy.util.url.URLHandler

Constructor Summary

Method Summary

Methods inherited from class org.apache.ivy.util.url.AbstractURLHandler

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.ivy.util.url.URLHandler

Constructor Details

HttpClientHandler

Method Details

openStream

openStream

download

download

upload

upload

getURLInfo

getURLInfo

isReachable

getContentLength

getLastModified

getURLInfo

close