HttpDataSource.BaseFactory


@UnstableApi
public abstract class HttpDataSource.BaseFactory implements HttpDataSource.Factory


Base implementation of Factory that sets default request properties.

Summary

Public constructors

Public methods

final HttpDataSource

Creates a DataSource instance.

final HttpDataSource.Factory
@CanIgnoreReturnValue
setDefaultRequestProperties(
    Map<StringString> defaultRequestProperties
)

Sets the default request headers for HttpDataSource instances created by the factory.

Protected methods

abstract HttpDataSource

Called by createDataSource to create a HttpDataSource instance.

Public constructors

BaseFactory

public BaseFactory()

Public methods

createDataSource

public final HttpDataSource createDataSource()

Creates a DataSource instance.

setDefaultRequestProperties

@CanIgnoreReturnValue
public final HttpDataSource.Factory setDefaultRequestProperties(
    Map<StringString> defaultRequestProperties
)

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
Map<StringString> defaultRequestProperties

The default request properties.

Returns
HttpDataSource.Factory

This factory.

Protected methods

createDataSourceInternal

protected abstract HttpDataSource createDataSourceInternal(
    HttpDataSource.RequestProperties defaultRequestProperties
)

Called by createDataSource to create a HttpDataSource instance.

Parameters
HttpDataSource.RequestProperties defaultRequestProperties

The default RequestProperties to be used by the HttpDataSource instance.

Returns
HttpDataSource

A HttpDataSource instance.