com.google.android.exoplayer.upstream

Class DefaultHttpDataSource

java.lang.Object

com.google.android.exoplayer.upstream.DefaultHttpDataSource

All Implemented Interfaces:

DataSource, HttpDataSource, UriDataSource

public class DefaultHttpDataSource
extends Object
implements HttpDataSource

A HttpDataSource that uses Android's HttpURLConnection.

By default this implementation will not follow cross-protocol redirects (i.e. redirects from HTTP to HTTPS or vice versa). Cross-protocol redirects can be enabled by using the DefaultHttpDataSource(String, Predicate, TransferListener, int, int, boolean) constructor and passing true as the final argument.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer.upstream.HttpDataSource

HttpDataSource.HttpDataSourceException, HttpDataSource.InvalidContentTypeException, HttpDataSource.InvalidResponseCodeException

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT_MILLIS The default connection timeout, in milliseconds.
static int	DEFAULT_READ_TIMEOUT_MILLIS The default read timeout, in milliseconds.

Fields inherited from interface com.google.android.exoplayer.upstream.HttpDataSource

REJECT_PAYWALL_TYPES

Constructor Summary

Constructors

Constructor and Description
DefaultHttpDataSource(String userAgent, Predicate<String> contentTypePredicate)
DefaultHttpDataSource(String userAgent, Predicate<String> contentTypePredicate, TransferListener listener)
DefaultHttpDataSource(String userAgent, Predicate<String> contentTypePredicate, TransferListener listener, int connectTimeoutMillis, int readTimeoutMillis)
DefaultHttpDataSource(String userAgent, Predicate<String> contentTypePredicate, TransferListener listener, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects)

Method Summary

Modifier and Type	Method and Description
protected long	bytesRead() Returns the number of bytes that have been read since the most recent call to open(DataSpec).
protected long	bytesRemaining() Returns the number of bytes that are still to be read for the current DataSpec.
protected long	bytesSkipped() Returns the number of bytes that have been skipped since the most recent call to open(DataSpec).
void	clearAllRequestProperties() Clears all request header fields that were set by HttpDataSource.setRequestProperty(String, String).
void	clearRequestProperty(String name) Clears the value of a request header field.
void	close() Closes the DataSource.
protected HttpURLConnection	getConnection() Returns the current connection, or null if the source is not currently opened.
Map<String,List<String>>	getResponseHeaders() Gets the headers provided in the response.
String	getUri() When the source is open, returns the URI from which data is being read.
long	open(DataSpec dataSpec) Opens the DataSource to read the specified data.
int	read(byte[] buffer, int offset, int readLength) Reads up to length bytes of data and stores them into buffer, starting at index offset.
void	setRequestProperty(String name, String value) Sets the value of a request header field.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECT_TIMEOUT_MILLIS

public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS

The default connection timeout, in milliseconds.

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT_MILLIS

public static final int DEFAULT_READ_TIMEOUT_MILLIS

The default read timeout, in milliseconds.

See Also:

Constant Field Values

Constructor Detail

DefaultHttpDataSource

public DefaultHttpDataSource(String userAgent,
                             Predicate<String> contentTypePredicate)

Parameters:

userAgent - The User-Agent string that should be used.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).

DefaultHttpDataSource

public DefaultHttpDataSource(String userAgent,
                             Predicate<String> contentTypePredicate,
                             TransferListener listener)

Parameters:

userAgent - The User-Agent string that should be used.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).

listener - An optional listener.

DefaultHttpDataSource

public DefaultHttpDataSource(String userAgent,
                             Predicate<String> contentTypePredicate,
                             TransferListener listener,
                             int connectTimeoutMillis,
                             int readTimeoutMillis)

Parameters:

userAgent - The User-Agent string that should be used.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).

listener - An optional listener.

connectTimeoutMillis - The connection timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.

readTimeoutMillis - The read timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.

DefaultHttpDataSource

public DefaultHttpDataSource(String userAgent,
                             Predicate<String> contentTypePredicate,
                             TransferListener listener,
                             int connectTimeoutMillis,
                             int readTimeoutMillis,
                             boolean allowCrossProtocolRedirects)

Parameters:

userAgent - The User-Agent string that should be used.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).

listener - An optional listener.

connectTimeoutMillis - The connection timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout. Pass DEFAULT_CONNECT_TIMEOUT_MILLIS to use the default value.

readTimeoutMillis - The read timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout. Pass DEFAULT_READ_TIMEOUT_MILLIS to use the default value.

allowCrossProtocolRedirects - Whether cross-protocol redirects (i.e. redirects from HTTP to HTTPS and vice versa) are enabled.

Method Detail

getUri

public String getUri()

Description copied from interface: UriDataSource

When the source is open, returns the URI from which data is being read.

If redirection occurred, the URI after redirection is the one returned.

Specified by:

getUri in interface UriDataSource

Returns:

When the source is open, the URI from which data is being read. Null otherwise.

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()

Description copied from interface: HttpDataSource

Gets the headers provided in the response.

Specified by:

getResponseHeaders in interface HttpDataSource

Returns:

The response headers, or null if response headers are unavailable.

setRequestProperty

public void setRequestProperty(String name,
                               String value)

Description copied from interface: HttpDataSource

Sets the value of a request header field. The value will be used for subsequent connections established by the source.

Specified by:

setRequestProperty in interface HttpDataSource

Parameters:

name - The name of the header field.

value - The value of the field.

clearRequestProperty

public void clearRequestProperty(String name)

Description copied from interface: HttpDataSource

Clears the value of a request header field. The change will apply to subsequent connections established by the source.

Specified by:

clearRequestProperty in interface HttpDataSource

Parameters:

name - The name of the header field.

clearAllRequestProperties

public void clearAllRequestProperties()

Description copied from interface: HttpDataSource

Clears all request header fields that were set by HttpDataSource.setRequestProperty(String, String).

Specified by:

clearAllRequestProperties in interface HttpDataSource

open

public long open(DataSpec dataSpec)
          throws HttpDataSource.HttpDataSourceException

Description copied from interface: DataSource

Opens the DataSource to read the specified data. Calls to DataSource.open(DataSpec) and DataSource.close() must be balanced.

Note: If DataSource.open(DataSpec) throws an IOException, callers must still call DataSource.close() to ensure that any partial effects of the DataSource.open(DataSpec) invocation are cleaned up. Implementations of this class can assume that callers will call DataSource.close() in this case.

Specified by:

open in interface DataSource

Specified by:

open in interface HttpDataSource

Parameters:

dataSpec - Defines the data to be read.

Returns:

The number of bytes that can be read from the opened source. For unbounded requests (i.e. requests where DataSpec.length equals C.LENGTH_UNBOUNDED) this value is the resolved length of the request, or C.LENGTH_UNBOUNDED if the length is still unresolved. For all other requests, the value returned will be equal to the request's DataSpec.length.

Throws:

HttpDataSource.HttpDataSourceException

read

public int read(byte[] buffer,
                int offset,
                int readLength)
         throws HttpDataSource.HttpDataSourceException

Description copied from interface: DataSource

Reads up to length bytes of data and stores them into buffer, starting at index offset.

This method blocks until at least one byte of data can be read, the end of the opened range is detected, or an exception is thrown.

Specified by:

read in interface DataSource

Specified by:

read in interface HttpDataSource

Parameters:

buffer - The buffer into which the read data should be stored.

offset - The start offset into buffer at which data should be written.

readLength - The maximum number of bytes to read.

Returns:

The number of bytes read, or C.RESULT_END_OF_INPUT if the end of the opened range is reached.

Throws:

HttpDataSource.HttpDataSourceException

close

public void close()
           throws HttpDataSource.HttpDataSourceException

Description copied from interface: DataSource

Closes the DataSource.

Note: This method will be called even if the corresponding call to DataSource.open(DataSpec) threw an IOException. See DataSource.open(DataSpec) for more details.

Specified by:

close in interface DataSource

Specified by:

close in interface HttpDataSource

Throws:

HttpDataSource.HttpDataSourceException

getConnection

protected final HttpURLConnection getConnection()

Returns the current connection, or null if the source is not currently opened.

Returns:

The current open connection, or null.

bytesSkipped

protected final long bytesSkipped()

Returns the number of bytes that have been skipped since the most recent call to open(DataSpec).

Returns:

The number of bytes skipped.

bytesRead

protected final long bytesRead()

Returns the number of bytes that have been read since the most recent call to open(DataSpec).

Returns:

The number of bytes read.

bytesRemaining

protected final long bytesRemaining()

Returns the number of bytes that are still to be read for the current DataSpec.

If the total length of the data being read is known, then this length minus bytesRead() is returned. If the total length is unknown, C.LENGTH_UNBOUNDED is returned.

Returns:

The remaining length, or C.LENGTH_UNBOUNDED.