# HttpDataSource

Artifact: [androidx.media3:media3-datasource](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/datasource/HttpDataSource.java+class:androidx.media3.datasource.HttpDataSource)

*** ** * ** ***


```
public interface HttpDataSource extends DataSource
```

<br />

Known direct subclasses [CronetDataSource](https://developer.android.com/reference/androidx/media3/datasource/cronet/CronetDataSource), [DefaultHttpDataSource](https://developer.android.com/reference/androidx/media3/datasource/DefaultHttpDataSource), [HttpEngineDataSource](https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource), [KtorDataSource](https://developer.android.com/reference/androidx/media3/datasource/ktor/KtorDataSource), [OkHttpDataSource](https://developer.android.com/reference/androidx/media3/datasource/okhttp/OkHttpDataSource)

|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/cronet/CronetDataSource` | DataSource without intermediate buffer based on Cronet API set using UrlRequest. |
| `https://developer.android.com/reference/androidx/media3/datasource/DefaultHttpDataSource` | An `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource` that uses Android's `https://developer.android.com/reference/java/net/HttpURLConnection.html`. |
| `https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource` | DataSource without intermediate buffer based on `https://developer.android.com/reference/android/net/http/HttpEngine.html` set using `https://developer.android.com/reference/android/net/http/UrlRequest.html`. |
| `https://developer.android.com/reference/androidx/media3/datasource/ktor/KtorDataSource` | An `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource` that delegates to Ktor's `https://api.ktor.io/ktor-client-core/io.ktor.client/-http-client/index.html`. |
| `https://developer.android.com/reference/androidx/media3/datasource/okhttp/OkHttpDataSource` | An `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource` that delegates to Square's Call.Factory. |

*** ** * ** ***

An HTTP `https://developer.android.com/reference/androidx/media3/datasource/DataSource`.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi public abstract class https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.BaseFactory implements https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory` Base implementation of `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory` that sets default request properties. |
| `public final class https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.CleartextNotPermittedException extends https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` Thrown when cleartext HTTP traffic is not permitted. |
| `public interface https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory extends https://developer.android.com/reference/androidx/media3/datasource/DataSource.Factory` A factory for `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource` instances. |
| `public class https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException extends https://developer.android.com/reference/androidx/media3/datasource/DataSourceException` Thrown when an error is encountered when trying to read from a `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource`. |
| `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/androidx/annotation/IntDef(value = ) public annotation https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException.Type` The type of operation that produced the error. |
| `public final class https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.InvalidContentTypeException extends https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` Thrown when the content type is invalid. |
| `public final class https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.InvalidResponseCodeException extends https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` Thrown when an attempt to open a connection results in a response code not in the 2xx range. |
| `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi public final class https://developer.android.com/reference/androidx/media3/datasource/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. |

| ### Constants |
|---|---|
| `default static final https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html<https://developer.android.com/reference/java/lang/String.html>` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#REJECT_PAYWALL_TYPES()` A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html` that rejects content types often used for pay-walls. |

| ### Public methods |
|---|---|
| `abstract void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#clearAllRequestProperties()()` Clears all request headers that were set by `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)`. |
| `abstract void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#clearRequestProperty(java.lang.String)(https://developer.android.com/reference/java/lang/String.html name)` Clears the value of a request header. |
| `abstract void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#close()()` Closes the source. |
| `abstract int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#getResponseCode()()` When the source is open, returns the HTTP response status code associated with the last `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)` call. |
| `abstract https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>>` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#getResponseHeaders()()` When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` call. |
| `abstract long` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)(https://developer.android.com/reference/androidx/media3/datasource/DataSpec dataSpec)` Opens the source to read the specified data. |
| `abstract int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#read(byte[],int,int)(byte[] buffer, int offset, int length)` Reads up to `length` bytes of data from the input. |
| `abstract void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)(https://developer.android.com/reference/java/lang/String.html name, https://developer.android.com/reference/java/lang/String.html value)` Sets the value of a request header. |

### Inherited methods

From [androidx.media3.datasource.DataSource](https://developer.android.com/reference/androidx/media3/datasource/DataSource) `abstract void` `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/androidx/media3/datasource/DataSource#addTransferListener(androidx.media3.datasource.TransferListener)(https://developer.android.com/reference/androidx/media3/datasource/TransferListener transferListener)`

Adds a `https://developer.android.com/reference/androidx/media3/datasource/TransferListener` to listen to data transfers.
`abstract @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/net/Uri.html` `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/androidx/media3/datasource/DataSource#getUri()()`

When the source is open, returns the `https://developer.android.com/reference/android/net/Uri.html` from which data is being read.

## Constants

### REJECT_PAYWALL_TYPES

```
@UnstableApi
default static final Predicate<String> REJECT_PAYWALL_TYPES
```

A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html` that rejects content types often used for pay-walls.

## Public methods

### clearAllRequestProperties

```
@UnstableApi
abstract void clearAllRequestProperties()
```

Clears all request headers that were set by `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)`.

### clearRequestProperty

```
@UnstableApi
abstract void clearRequestProperty(String name)
```

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

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html name` | The name of the header field. |

### close

```
@UnstableApi
abstract void close()
```

Closes the source. This method must be called even if the corresponding call to `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` threw an `https://developer.android.com/reference/java/io/IOException.html`.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs closing the source. |
| `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### getResponseCode

```
@UnstableApi
abstract int getResponseCode()
```

When the source is open, returns the HTTP response status code associated with the last `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)` call. Otherwise, returns a negative value.

### getResponseHeaders

```
@UnstableApi
abstract Map<String, List<String>> getResponseHeaders()
```

When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` call. Otherwise, returns an empty map.

Key look-up in the returned map is case-insensitive.

### open

```
@UnstableApi
abstract long open(DataSpec dataSpec)
```

Opens the source to read the specified data.

Note: `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource` implementations are advised to set request headers passed via (in order of decreasing priority) the `dataSpec`, `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)` and the default parameters set in the `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory`.

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### read

```
@UnstableApi
abstract int read(byte[] buffer, int offset, int length)
```

Reads up to `length` 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, then `https://developer.android.com/reference/androidx/media3/common/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.

| Parameters |
|---|---|
| `byte[] buffer` | A target array into which data should be written. |
| `int offset` | The offset into the target array at which to write. |
| `int length` | The maximum number of bytes to read from the input. |

| Returns |
|---|---|
| `int` | The number of bytes read, or `https://developer.android.com/reference/androidx/media3/common/C#RESULT_END_OF_INPUT()` if the input has ended. This may be less than `length` 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 |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs reading from the input. |
| `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### setRequestProperty

```
@UnstableApi
abstract void setRequestProperty(String name, String value)
```

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 `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory`, then the header value set with this method should be preferred when connecting with the data source. See `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html name` | The name of the header field. |
| `https://developer.android.com/reference/java/lang/String.html value` | The value of the field. |