Class DefaultHttpDataSource
- java.lang.Object
-
- com.google.android.exoplayer2.upstream.BaseDataSource
-
- com.google.android.exoplayer2.upstream.DefaultHttpDataSource
-
- All Implemented Interfaces:
DataReader
,DataSource
,HttpDataSource
public class DefaultHttpDataSource extends BaseDataSource implements HttpDataSource
AnHttpDataSource
that uses Android'sHttpURLConnection
.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 passing
true
toDefaultHttpDataSource.Factory.setAllowCrossProtocolRedirects(boolean)
.Note: HTTP request headers will be set using all parameters passed via (in order of decreasing priority) the
dataSpec
,setRequestProperty(java.lang.String, java.lang.String)
and the default properties that can be passed toHttpDataSource.Factory.setDefaultRequestProperties(Map)
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DefaultHttpDataSource.Factory
DataSource.Factory
forDefaultHttpDataSource
instances.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.upstream.HttpDataSource
HttpDataSource.BaseFactory, HttpDataSource.CleartextNotPermittedException, HttpDataSource.HttpDataSourceException, HttpDataSource.InvalidContentTypeException, HttpDataSource.InvalidResponseCodeException, HttpDataSource.RequestProperties
-
-
Field Summary
Fields Modifier and Type Field 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 Description DefaultHttpDataSource()
Deprecated.UseDefaultHttpDataSource.Factory
instead.DefaultHttpDataSource(String userAgent)
Deprecated.UseDefaultHttpDataSource.Factory
instead.DefaultHttpDataSource(String userAgent, int connectTimeoutMillis, int readTimeoutMillis)
Deprecated.UseDefaultHttpDataSource.Factory
instead.DefaultHttpDataSource(String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects, HttpDataSource.RequestProperties defaultRequestProperties)
Deprecated.UseDefaultHttpDataSource.Factory
instead.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clearAllRequestProperties()
Clears all request headers that were set byHttpDataSource.setRequestProperty(String, String)
.void
clearRequestProperty(String name)
Clears the value of a request header.void
close()
Closes the source.int
getResponseCode()
When the source is open, returns the HTTP response status code associated with the lastHttpDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
call.Map<String,List<String>>
getResponseHeaders()
When the source is open, returns the response headers associated with the lastDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
call.Uri
getUri()
When the source is open, returns theUri
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 length)
Reads up tolength
bytes of data from the input.void
setContentTypePredicate(Predicate<String> contentTypePredicate)
Deprecated.void
setRequestProperty(String name, 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
@Deprecated public DefaultHttpDataSource()
Deprecated.UseDefaultHttpDataSource.Factory
instead.
-
DefaultHttpDataSource
@Deprecated public DefaultHttpDataSource(@Nullable String userAgent)
Deprecated.UseDefaultHttpDataSource.Factory
instead.
-
DefaultHttpDataSource
@Deprecated public DefaultHttpDataSource(@Nullable String userAgent, int connectTimeoutMillis, int readTimeoutMillis)
Deprecated.UseDefaultHttpDataSource.Factory
instead.
-
DefaultHttpDataSource
@Deprecated public DefaultHttpDataSource(@Nullable String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects, @Nullable HttpDataSource.RequestProperties defaultRequestProperties)
Deprecated.UseDefaultHttpDataSource.Factory
instead.
-
-
Method Detail
-
setContentTypePredicate
@Deprecated public void setContentTypePredicate(@Nullable Predicate<String> contentTypePredicate)
Deprecated.
-
getUri
@Nullable public Uri getUri()
Description copied from interface:DataSource
When the source is open, returns theUri
from which data is being read. The returnedUri
will be identical to the one passedDataSource.open(DataSpec)
in theDataSpec
unless redirection has occurred. If redirection has occurred, theUri
after redirection is returned.- Specified by:
getUri
in interfaceDataSource
- Returns:
- The
Uri
from which data is being read, or null if the source is not open.
-
getResponseCode
public int getResponseCode()
Description copied from interface:HttpDataSource
When the source is open, returns the HTTP response status code associated with the lastHttpDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
call. Otherwise, returns a negative value.- Specified by:
getResponseCode
in interfaceHttpDataSource
-
getResponseHeaders
public Map<String,List<String>> getResponseHeaders()
Description copied from interface:DataSource
When the source is open, returns the response headers associated with the lastDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
call. Otherwise, returns an empty map.Key look-up in the returned map is case-insensitive.
- Specified by:
getResponseHeaders
in interfaceDataSource
- Specified by:
getResponseHeaders
in interfaceHttpDataSource
-
setRequestProperty
public void setRequestProperty(String name, 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.Note: If the same header is set as a default parameter in the
HttpDataSource.Factory
, then the header value set with this method should be preferred when connecting with the data source. SeeHttpDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
.- Specified by:
setRequestProperty
in interfaceHttpDataSource
- 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. The change will apply to subsequent connections established by the source.- Specified by:
clearRequestProperty
in interfaceHttpDataSource
- Parameters:
name
- The name of the header field.
-
clearAllRequestProperties
public void clearAllRequestProperties()
Description copied from interface:HttpDataSource
Clears all request headers that were set byHttpDataSource.setRequestProperty(String, String)
.- Specified by:
clearAllRequestProperties
in interfaceHttpDataSource
-
open
public long open(DataSpec dataSpec) throws HttpDataSource.HttpDataSourceException
Opens the source to read the specified data.- Specified by:
open
in interfaceDataSource
- Specified by:
open
in interfaceHttpDataSource
- 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
equalsC.LENGTH_UNSET
) this value is the resolved length of the request, orC.LENGTH_UNSET
if the length is still unresolved. For all other requests, the value returned will be equal to the request'sDataSpec.length
. - Throws:
HttpDataSource.HttpDataSourceException
-
read
public int read(byte[] buffer, int offset, int length) throws HttpDataSource.HttpDataSourceException
Description copied from interface:DataReader
Reads up tolength
bytes of data from the input.If
readLength
is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, thenC.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 interfaceDataReader
- Specified by:
read
in interfaceHttpDataSource
- Parameters:
buffer
- A target array into which data should be written.offset
- The offset into the target array at which to write.length
- The maximum number of bytes to read from the input.- Returns:
- The number of bytes read, or
C.RESULT_END_OF_INPUT
if the input has ended. This may be less thanlength
because the end of the input (or available data) was reached, the method was interrupted, or the operation was aborted early for another reason. - Throws:
HttpDataSource.HttpDataSourceException
-
close
public void close() throws HttpDataSource.HttpDataSourceException
Description copied from interface:DataSource
Closes the source. This method must be called even if the corresponding call toDataSource.open(DataSpec)
threw anIOException
.- Specified by:
close
in interfaceDataSource
- Specified by:
close
in interfaceHttpDataSource
- Throws:
HttpDataSource.HttpDataSourceException
-
-