Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## fr.jayasoft.ivy.url
Interface URLHandler

All Known Implementing Classes:
  AbstractURLHandler, URLHandlerDispatcher

public interface URLHandler

This interface is responsible for handling some URL manipulation (stream opening, downloading, check reachability, ...).

Author:
  Xavier Hanin

Nested Class Summary
`static class` | `URLHandler.URLInfo`

Field Summary
`static URLHandler.URLInfo` | `UNAVAILABLE`

Method Summary
`void` | `download(java.net.URL src, java.io.File dest, CopyProgressListener l)`
`long` | `getContentLength(java.net.URL url)` Returns the length of the target if the given url is reachable, and without error code in case of http urls.
`long` | `getContentLength(java.net.URL url, int timeout)` Returns the length of the target if the given url is reachable, and without error code in case of http urls.
`long` | `getLastModified(java.net.URL url)` Please prefer getURLInfo when several infos are needed.
`long` | `getLastModified(java.net.URL url, int timeout)` Please prefer getURLInfo when several infos are needed.
`URLHandler.URLInfo` | `getURLInfo(java.net.URL url)` never returns null, return UNAVAILABLE when url is not reachable
`URLHandler.URLInfo` | `getURLInfo(java.net.URL url, int timeout)` never returns null, return UNAVAILABLE when url is not reachable
`boolean` | `isReachable(java.net.URL url)` Please prefer getURLInfo when several infos are needed.
`boolean` | `isReachable(java.net.URL url, int timeout)` Please prefer getURLInfo when several infos are needed.
`java.io.InputStream` | `openStream(java.net.URL url)`

Field Detail

### UNAVAILABLE

    public static final URLHandler.URLInfo UNAVAILABLE

Method Detail

### isReachable

    public boolean isReachable(java.net.URL url)

  Please prefer getURLInfo when several infos are needed.

  Parameters:
    `url` - the url to check
  Returns:
    true if the target is reachable

### isReachable

    public boolean isReachable(java.net.URL url,
                               int timeout)

  Please prefer getURLInfo when several infos are needed.

  Parameters:
    `url` - the url to check
  Returns:
    true if the target is reachable

### getContentLength

    public long getContentLength(java.net.URL url)

  Returns the length of the target if the given url is reachable, and without error code in case of http urls. Please prefer getURLInfo when several infos are needed.

  Parameters:
    `url` - the url to check
  Returns:
    the length of the target if available, 0 if not reachable

### getContentLength

    public long getContentLength(java.net.URL url,
                                 int timeout)

  Returns the length of the target if the given url is reachable, and without error code in case of http urls.

  Parameters:
    `url` - the url to check
    `timeout` - the maximum time before considering an url is not reachable a timeout of zero indicates no timeout
  Returns:
    the length of the target if available, 0 if not reachable

### getLastModified

    public long getLastModified(java.net.URL url)

  Please prefer getURLInfo when several infos are needed.

  Parameters:
    `url` - the url to check
  Returns:
    last modified timestamp of the given url

### getLastModified

    public long getLastModified(java.net.URL url,
                                int timeout)

  Please prefer getURLInfo when several infos are needed.

  Parameters:
    `url` - the url to check
  Returns:
    last modified timestamp of the given url

### getURLInfo

    public URLHandler.URLInfo getURLInfo(java.net.URL url)

  never returns null, return UNAVAILABLE when url is not reachable

  Parameters:
    `url` -
  Returns:

### getURLInfo

    public URLHandler.URLInfo getURLInfo(java.net.URL url,
                                         int timeout)

  never returns null, return UNAVAILABLE when url is not reachable

  Parameters:
    `url` -
  Returns:

### openStream

    public java.io.InputStream openStream(java.net.URL url)
                                   throws java.io.IOException

  Throws:
    `java.io.IOException`

### download

    public void download(java.net.URL src,
                         java.io.File dest,
                         CopyProgressListener l)
                  throws java.io.IOException

  Throws:
    `java.io.IOException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD