com.liulishuo.filedownloader.connection

Class FileDownloadUrlConnection

java.lang.Object

com.liulishuo.filedownloader.connection.FileDownloadUrlConnection

All Implemented Interfaces:

FileDownloadConnection

public class FileDownloadUrlConnection
extends java.lang.Object
implements FileDownloadConnection

The FileDownloadConnection implemented using URLConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileDownloadUrlConnection.Configuration The sample configuration for the FileDownloadUrlConnection
static class	FileDownloadUrlConnection.Creator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URLConnection	mConnection

Fields inherited from interface com.liulishuo.filedownloader.connection.FileDownloadConnection

NO_RESPONSE_CODE, RESPONSE_CODE_FROM_OFFSET

Constructor Summary

Constructors

Constructor and Description
FileDownloadUrlConnection(java.lang.String originUrl)
FileDownloadUrlConnection(java.lang.String originUrl, FileDownloadUrlConnection.Configuration configuration)
FileDownloadUrlConnection(java.net.URL url, FileDownloadUrlConnection.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value) Sets the header named name to value.
boolean	dispatchAddResumeOffset(java.lang.String etag, long offset) If we find the file has been downloaded several bytes, we will try to resume from the breakpoint from offset length.
void	ending() To Be Reused or Close this connection, since this connection is ending in this session.
void	execute() Invokes the request immediately, and blocks until the response can be processed or is in error.
java.io.InputStream	getInputStream() Returns an input stream that reads from this open connection.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaderFields() Returns an unmodifiable Map of general request header fields for this connection.
int	getResponseCode() Gets the status code from an HTTP response message.
java.lang.String	getResponseHeaderField(java.lang.String name) Returns the value of the named header field, which would be the response-header field.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaderFields() Returns an unmodifiable Map of the header fields.
boolean	setRequestMethod(java.lang.String method) Set the method for the request, one of: GET POST HEAD OPTIONS PUT DELETE TRACE are legal, subject to protocol restrictions.

Methods inherited from class java.lang.Object

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

Field Detail

mConnection

protected java.net.URLConnection mConnection

Constructor Detail

FileDownloadUrlConnection

public FileDownloadUrlConnection(java.lang.String originUrl,
                                 FileDownloadUrlConnection.Configuration configuration)
                          throws java.io.IOException

Throws:

java.io.IOException

FileDownloadUrlConnection

public FileDownloadUrlConnection(java.net.URL url,
                                 FileDownloadUrlConnection.Configuration configuration)
                          throws java.io.IOException

Throws:

java.io.IOException

FileDownloadUrlConnection

public FileDownloadUrlConnection(java.lang.String originUrl)
                          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: FileDownloadConnection

Sets the header named name to value.

The capacity of this method is similar to the URLConnection.addRequestProperty(String, String)

Specified by:

addHeader in interface FileDownloadConnection

dispatchAddResumeOffset

public boolean dispatchAddResumeOffset(java.lang.String etag,
                                       long offset)

Description copied from interface: FileDownloadConnection

If we find the file has been downloaded several bytes, we will try to resume from the breakpoint from offset length.

Specified by:

dispatchAddResumeOffset in interface FileDownloadConnection

Parameters:

etag - the etag is stored by the past downloaded.

offset - the offset length has already been downloaded.

Returns:

true if adding resume offset was dispatched, so we can't handle that by internal.

getInputStream

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

Description copied from interface: FileDownloadConnection

Returns an input stream that reads from this open connection.

The capacity of this method is similar to the URLConnection.getInputStream()

Specified by:

getInputStream in interface FileDownloadConnection

Returns:

an input stream that reads from this open connection.

Throws:

java.io.IOException

getRequestHeaderFields

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaderFields()

Description copied from interface: FileDownloadConnection

Returns an unmodifiable Map of general request header fields for this connection. The Map keys are Strings that represent the request-header field names. Each Map value is a unmodifiable List of Strings that represents the corresponding field values.

The capacity of this method is similar to the URLConnection.getRequestProperties()

Specified by:

getRequestHeaderFields in interface FileDownloadConnection

Returns:

a Map of the general request properties for this connection.

getResponseHeaderFields

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaderFields()

Description copied from interface: FileDownloadConnection

Returns an unmodifiable Map of the header fields. The Map keys are Strings that represent the response-header field names. Each Map value is an unmodifiable List of Strings that represents the corresponding field values.

The capacity of this method is similar to the URLConnection.getHeaderFields()

Specified by:

getResponseHeaderFields in interface FileDownloadConnection

Returns:

a Map of header fields

getResponseHeaderField

public java.lang.String getResponseHeaderField(java.lang.String name)

Description copied from interface: FileDownloadConnection

Returns the value of the named header field, which would be the response-header field.

If called on a connection that sets the same header multiple times with possibly different values, only the last value is returned.

Specified by:

getResponseHeaderField in interface FileDownloadConnection

Parameters:

name - the name of a header field.

Returns:

the value of the named header field, or null if there is no such field in the header.

setRequestMethod

public boolean setRequestMethod(java.lang.String method)
                         throws java.net.ProtocolException

Description copied from interface: FileDownloadConnection

Set the method for the request, one of:

• GET
• POST
• HEAD
• OPTIONS
• PUT
• DELETE
• TRACE

are legal, subject to protocol restrictions. The default method is GET.

Specified by:

setRequestMethod in interface FileDownloadConnection

Parameters:

method - the HTTP method

Returns:

true if set effect, otherwise false.

Throws:

java.net.ProtocolException - if the method cannot be reset or if the requested method isn't valid for HTTP.

execute

public void execute()
             throws java.io.IOException

Description copied from interface: FileDownloadConnection

Invokes the request immediately, and blocks until the response can be processed or is in error.

Specified by:

execute in interface FileDownloadConnection

Throws:

java.io.IOException

getResponseCode

public int getResponseCode()
                    throws java.io.IOException

Description copied from interface: FileDownloadConnection

Gets the status code from an HTTP response message.

If this is not http/https protocol connection: 1. If you make sure this connection is resume from the offset breakpoint(which you can check out this through FileDownloadConnection.dispatchAddResumeOffset(String, long)), please return FileDownloadConnection.RESPONSE_CODE_FROM_OFFSET 2. otherwise, return FileDownloadConnection.NO_RESPONSE_CODE.

Specified by:

getResponseCode in interface FileDownloadConnection

Returns:

the HTTP Status-Code, or -1

Throws:

java.io.IOException

ending

public void ending()

Description copied from interface: FileDownloadConnection

To Be Reused or Close this connection, since this connection is ending in this session.

Specified by:

ending in interface FileDownloadConnection