com.google.android.exoplayer2.upstream

Class DefaultHttpDataSource

java.lang.Object

com.google.android.exoplayer2.upstream.BaseDataSource

com.google.android.exoplayer2.upstream.DefaultHttpDataSource

All Implemented Interfaces:

DataSource, HttpDataSource

public class DefaultHttpDataSource
extends BaseDataSource
implements HttpDataSource

An 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, RequestProperties) constructor and passing true as the second last argument.

Nested Class Summary

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

HttpDataSource.BaseFactory, HttpDataSource.Factory, HttpDataSource.HttpDataSourceException, HttpDataSource.InvalidContentTypeException, HttpDataSource.InvalidResponseCodeException, HttpDataSource.RequestProperties

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.exoplayer2.upstream.HttpDataSource

REJECT_PAYWALL_TYPES

Constructor Summary

Constructors

Constructor and Description
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate)
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate, int connectTimeoutMillis, int readTimeoutMillis)
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects, HttpDataSource.RequestProperties defaultRequestProperties)
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate, TransferListener listener) Deprecated. Use DefaultHttpDataSource(String, Predicate) and BaseDataSource.addTransferListener(TransferListener).
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate, TransferListener listener, int connectTimeoutMillis, int readTimeoutMillis) Deprecated. Use DefaultHttpDataSource(String, Predicate, int, int) and BaseDataSource.addTransferListener(TransferListener).
DefaultHttpDataSource(java.lang.String userAgent, Predicate<java.lang.String> contentTypePredicate, TransferListener listener, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects, HttpDataSource.RequestProperties defaultRequestProperties) Deprecated. Use #DefaultHttpDataSource(String, Predicate, int, int, boolean, RequestProperties) and BaseDataSource.addTransferListener(TransferListener).

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 headers that were set by HttpDataSource.setRequestProperty(String, String).
void	clearRequestProperty(java.lang.String name) Clears the value of a request header.
void	close() Closes the source.
protected java.net.HttpURLConnection	getConnection() Returns the current connection, or null if the source is not currently opened.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders() When the source is open, returns the response headers associated with the last DataSource.open(com.google.android.exoplayer2.upstream.DataSpec) call.
android.net.Uri	getUri() When the source is open, returns the Uri from which data is being read.
long	open(DataSpec dataSpec) Opens the source to read the specified data.
int	read(byte[] buffer, int offset, int readLength) Reads up to readLength bytes of data and stores them into buffer, starting at index offset.
void	setRequestProperty(java.lang.String name, java.lang.String value) Sets the value of a request header.

Methods inherited from class com.google.android.exoplayer2.upstream.BaseDataSource

addTransferListener, bytesTransferred, transferEnded, transferInitializing, transferStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.android.exoplayer2.upstream.DataSource

addTransferListener

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(java.lang.String userAgent,
                             @Nullable
                             Predicate<java.lang.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(java.lang.String userAgent,
                             @Nullable
                             Predicate<java.lang.String> contentTypePredicate,
                             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).

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(java.lang.String userAgent,
                             @Nullable
                             Predicate<java.lang.String> contentTypePredicate,
                             int connectTimeoutMillis,
                             int readTimeoutMillis,
                             boolean allowCrossProtocolRedirects,
                             @Nullable
                             HttpDataSource.RequestProperties defaultRequestProperties)

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).

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.

defaultRequestProperties - The default request properties to be sent to the server as HTTP headers or null if not required.

DefaultHttpDataSource

@Deprecated
public DefaultHttpDataSource(java.lang.String userAgent,
                                         @Nullable
                                         Predicate<java.lang.String> contentTypePredicate,
                                         @Nullable
                                         TransferListener listener)

Deprecated. Use DefaultHttpDataSource(String, Predicate) and BaseDataSource.addTransferListener(TransferListener).

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

@Deprecated
public DefaultHttpDataSource(java.lang.String userAgent,
                                         @Nullable
                                         Predicate<java.lang.String> contentTypePredicate,
                                         @Nullable
                                         TransferListener listener,
                                         int connectTimeoutMillis,
                                         int readTimeoutMillis)

Deprecated. Use DefaultHttpDataSource(String, Predicate, int, int) and BaseDataSource.addTransferListener(TransferListener).

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

@Deprecated
public DefaultHttpDataSource(java.lang.String userAgent,
                                         @Nullable
                                         Predicate<java.lang.String> contentTypePredicate,
                                         @Nullable
                                         TransferListener listener,
                                         int connectTimeoutMillis,
                                         int readTimeoutMillis,
                                         boolean allowCrossProtocolRedirects,
                                         @Nullable
                                         HttpDataSource.RequestProperties defaultRequestProperties)

Deprecated. Use #DefaultHttpDataSource(String, Predicate, int, int, boolean, RequestProperties) and BaseDataSource.addTransferListener(TransferListener).

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.

defaultRequestProperties - The default request properties to be sent to the server as HTTP headers or null if not required.

Method Detail

getUri

@Nullable
public android.net.Uri getUri()

Description copied from interface: DataSource

When the source is open, returns the Uri from which data is being read. The returned Uri will be identical to the one passed DataSource.open(DataSpec) in the DataSpec unless redirection has occurred. If redirection has occurred, the Uri after redirection is returned.

Specified by:

getUri in interface DataSource

Returns:

The Uri from which data is being read, or null if the source is not open.

getResponseHeaders

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

Description copied from interface: DataSource

When the source is open, returns the response headers associated with the last DataSource.open(com.google.android.exoplayer2.upstream.DataSpec) call. Otherwise, returns an empty map.

Specified by:

getResponseHeaders in interface DataSource

Specified by:

getResponseHeaders in interface HttpDataSource

setRequestProperty

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

Description copied from interface: HttpDataSource

Sets the value of a request header. 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(java.lang.String name)

Description copied from interface: HttpDataSource

Clears the value of a request header. 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 headers 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 source to read the specified data.

Note: If an IOException is thrown, callers must still call DataSource.close() to ensure that any partial effects of the invocation are cleaned up.

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_UNSET) this value is the resolved length of the request, or C.LENGTH_UNSET 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 readLength bytes of data and stores them into buffer, starting at index offset.

If readLength is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then C.RESULT_END_OF_INPUT is returned. Otherwise, the call will block until at least one byte of data has been read and the number of bytes read is returned.

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 no data is available because the end of the opened range has been reached.

Throws:

HttpDataSource.HttpDataSourceException

close

public void close()
           throws HttpDataSource.HttpDataSourceException

Description copied from interface: DataSource

Closes the source.

Note: This method must 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

@Nullable
protected final java.net.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_UNSET is returned.

Returns:

The remaining length, or C.LENGTH_UNSET.