com.google.android.exoplayer2.upstream

Interface HttpDataSource

All Superinterfaces:

DataSource

All Known Implementing Classes:

DefaultHttpDataSource

public interface HttpDataSource
extends DataSource

An HTTP DataSource.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpDataSource.BaseFactory Base implementation of HttpDataSource.Factory that sets default request properties.
static interface	HttpDataSource.Factory A factory for HttpDataSource instances.
static class	HttpDataSource.HttpDataSourceException Thrown when an error is encountered when trying to read from a HttpDataSource.
static class	HttpDataSource.InvalidContentTypeException Thrown when the content type is invalid.
static class	HttpDataSource.InvalidResponseCodeException Thrown when an attempt to open a connection results in a response code not in the 2xx range.
static class	HttpDataSource.RequestProperties Stores HTTP request properties (aka HTTP headers) and provides methods to modify the headers in a thread safe way to avoid the potential of creating snapshots of an inconsistent or unintended state.

Field Summary

Fields

Modifier and Type	Field and Description
static Predicate<java.lang.String>	REJECT_PAYWALL_TYPES A Predicate that rejects content types often used for pay-walls.

Method Summary

Modifier and Type	Method and Description
void	clearAllRequestProperties() Clears all request headers that were set by setRequestProperty(String, String).
void	clearRequestProperty(java.lang.String name) Clears the value of a request header.
void	close() Closes the source.
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.
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 interface com.google.android.exoplayer2.upstream.DataSource

addTransferListener, getUri

Field Detail

REJECT_PAYWALL_TYPES

static final Predicate<java.lang.String> REJECT_PAYWALL_TYPES

A Predicate that rejects content types often used for pay-walls.

Method Detail

open

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

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

close

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

Throws:

HttpDataSource.HttpDataSourceException

read

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

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

setRequestProperty

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

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

Parameters:

name - The name of the header field.

value - The value of the field.

clearRequestProperty

void clearRequestProperty(java.lang.String name)

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

Parameters:

name - The name of the header field.

clearAllRequestProperties

void clearAllRequestProperties()

Clears all request headers that were set by setRequestProperty(String, String).

getResponseHeaders

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