htsjdk.tribble.util

Class HTTPHelper

java.lang.Object

htsjdk.tribble.util.HTTPHelper

All Implemented Interfaces:

URLHelper

public class HTTPHelper
extends java.lang.Object
implements URLHelper

Simple implementation of URLHelper based on the JDK URL and HttpURLConnection classes. This version optionally takes a proxy, but does not support authentication.

Constructor Summary

Constructors

Constructor and Description
HTTPHelper(java.net.URL url)

Method Summary

Modifier and Type	Method and Description
boolean	exists()
long	getContentLength()
java.net.URL	getUrl()
java.io.InputStream	openInputStream() Open an InputStream to stream the contents of the resource
java.io.InputStream	openInputStreamForRange(long start, long end) Open an InputStream to stream a slice (range) of the resource.
static void	setProxy(java.net.Proxy p)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPHelper

public HTTPHelper(java.net.URL url)

Method Detail

setProxy

public static void setProxy(java.net.Proxy p)

getUrl

public java.net.URL getUrl()

Specified by:

getUrl in interface URLHelper

Returns:

URL of the associated resource

getContentLength

public long getContentLength()
                      throws java.io.IOException

Specified by:

getContentLength in interface URLHelper

Returns:

content length of the resource, or -1 if not available

Throws:

java.io.IOException

openInputStream

public java.io.InputStream openInputStream()
                                    throws java.io.IOException

Description copied from interface: URLHelper

Open an InputStream to stream the contents of the resource

Specified by:

openInputStream in interface URLHelper

Returns:

Throws:

java.io.IOException

openInputStreamForRange

public java.io.InputStream openInputStreamForRange(long start,
                                                   long end)
                                            throws java.io.IOException

Open an InputStream to stream a slice (range) of the resource. The host server must support range byte requests and return a 206 response code (partial response). If it does not an IOException will be thrown. Its the client's responsibility to close the stream.

Specified by:

openInputStreamForRange in interface URLHelper

Parameters:

start - start of range in bytes

end - end of range ni bytes

Returns:

Throws:

java.io.IOException

exists

public boolean exists()
               throws java.io.IOException

Specified by:

exists in interface URLHelper

Throws:

java.io.IOException