DefaultHttpDataSource.Factory
class DefaultHttpDataSource.Factory : HttpDataSource.Factory
DataSource.Factory for DefaultHttpDataSource instances.
Summary
Public constructors |
|---|
Factory()Creates an instance. |
Inherited functions |
||
|---|---|---|
|
Public constructors
Public functions
createDataSource
@UnstableApi
fun createDataSource(): DefaultHttpDataSource!
Creates a DataSource instance.
setAllowCrossProtocolRedirects
@CanIgnoreReturnValue
@UnstableApi
fun setAllowCrossProtocolRedirects(allowCrossProtocolRedirects: Boolean): DefaultHttpDataSource.Factory!
Sets whether to allow cross protocol redirects.
The default is false.
| Parameters | |
|---|---|
allowCrossProtocolRedirects: Boolean |
Whether to allow cross protocol redirects. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setConnectTimeoutMs
@CanIgnoreReturnValue
@UnstableApi
fun setConnectTimeoutMs(connectTimeoutMs: Int): DefaultHttpDataSource.Factory!
Sets the connect timeout, in milliseconds.
The default is DEFAULT_CONNECT_TIMEOUT_MILLIS.
| Parameters | |
|---|---|
connectTimeoutMs: Int |
The connect timeout, in milliseconds, that will be used. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setContentTypePredicate
@CanIgnoreReturnValue
@UnstableApi
fun setContentTypePredicate(contentTypePredicate: Predicate<String!>?): DefaultHttpDataSource.Factory!
Sets a content type Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open.
The default is null.
| Parameters | |
|---|---|
contentTypePredicate: Predicate<String!>? |
The content type |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setCrossProtocolRedirectsForceOriginal
@CanIgnoreReturnValue
@UnstableApi
fun setCrossProtocolRedirectsForceOriginal(
crossProtocolRedirectsForceOriginal: Boolean
): DefaultHttpDataSource.Factory!
Sets whether cross protocol redirects should be forced to follow original protocol. This should only be set if allowCrossProtocolRedirects is false.
The default is false.
| Parameters | |
|---|---|
crossProtocolRedirectsForceOriginal: Boolean |
Whether to force original protocol. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setDefaultRequestProperties
@CanIgnoreReturnValue
@UnstableApi
fun setDefaultRequestProperties(
defaultRequestProperties: (Mutable)Map<String!, String!>!
): DefaultHttpDataSource.Factory!
Sets the default request headers for HttpDataSource instances created by the factory.
The new request properties will be used for future requests made by HttpDataSources created by the factory, including instances that have already been created. Modifying the defaultRequestProperties map after a call to this method will have no effect, and so it's necessary to call this method again each time the request properties need to be updated.
| Parameters | |
|---|---|
defaultRequestProperties: (Mutable)Map<String!, String!>! |
The default request properties. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setKeepPostFor302Redirects
@CanIgnoreReturnValue
@UnstableApi
fun setKeepPostFor302Redirects(keepPostFor302Redirects: Boolean): DefaultHttpDataSource.Factory!
Sets whether we should keep the POST method and body when we have HTTP 302 redirects for a POST request.
setReadTimeoutMs
@CanIgnoreReturnValue
@UnstableApi
fun setReadTimeoutMs(readTimeoutMs: Int): DefaultHttpDataSource.Factory!
Sets the read timeout, in milliseconds.
The default is DEFAULT_READ_TIMEOUT_MILLIS.
| Parameters | |
|---|---|
readTimeoutMs: Int |
The connect timeout, in milliseconds, that will be used. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setTransferListener
@CanIgnoreReturnValue
@UnstableApi
fun setTransferListener(transferListener: TransferListener?): DefaultHttpDataSource.Factory!
Sets the TransferListener that will be used.
The default is null.
See addTransferListener.
| Parameters | |
|---|---|
transferListener: TransferListener? |
The listener that will be used. |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |
setUserAgent
@CanIgnoreReturnValue
@UnstableApi
fun setUserAgent(userAgent: String?): DefaultHttpDataSource.Factory!
Sets the user agent that will be used.
The default is null, which causes the default user agent of the underlying platform to be used.
| Parameters | |
|---|---|
userAgent: String? |
The user agent that will be used, or |
| Returns | |
|---|---|
DefaultHttpDataSource.Factory! |
This factory. |