Package com.castlabs.sdk.okhttp

Class OkHttpDataSource

java.lang.Object
com.castlabs.sdk.okhttp.OkHttpDataSource
All Implemented Interfaces:
com.castlabs.media3.common.DataReader, com.castlabs.media3.datasource.DataSource, com.castlabs.media3.datasource.HttpDataSource, okhttp3.Interceptor
public class OkHttpDataSource extends Object implements com.castlabs.media3.datasource.HttpDataSource, okhttp3.Interceptor
An HttpDataSource that delegates to Square's Call.Factory.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    OkHttpDataSource.Predicate<T>
    Interface to evaluate the input

    Nested classes/interfaces inherited from interface com.castlabs.media3.datasource.HttpDataSource

    com.castlabs.media3.datasource.HttpDataSource.BaseFactory, com.castlabs.media3.datasource.HttpDataSource.CleartextNotPermittedException, com.castlabs.media3.datasource.HttpDataSource.Factory, com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException, com.castlabs.media3.datasource.HttpDataSource.InvalidContentTypeException, com.castlabs.media3.datasource.HttpDataSource.InvalidResponseCodeException, com.castlabs.media3.datasource.HttpDataSource.RequestProperties

    Nested classes/interfaces inherited from interface okhttp3.Interceptor

    okhttp3.Interceptor.Chain

  • Field Summary

    Fields inherited from interface com.castlabs.media3.datasource.HttpDataSource

    REJECT_PAYWALL_TYPES

  • Constructor Summary

    Constructors
    Constructor
    Description
    OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.media3.datasource.TransferListener listener, NetworkConfiguration networkConfiguration, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
    Creates an instance.
    OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.media3.datasource.TransferListener listener, okhttp3.CacheControl cacheControl, com.castlabs.media3.datasource.HttpDataSource.RequestProperties defaultRequestProperties, NetworkConfiguration networkConfiguration, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
    Creates an instance.
    OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
    Creates an instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTransferListener(com.castlabs.media3.datasource.TransferListener listener)
     
    void
    clearAllRequestProperties()
     
    void
    clearRequestProperty(String name)
     
    void
    close()
     
    int
    getResponseCode()
     
    Map<String,List<String>>
    getResponseHeaders()
     
    Uri
    getUri()
     
    okhttp3.Response
    intercept(okhttp3.Interceptor.Chain chain)
     
    long
    open(com.castlabs.media3.datasource.DataSpec dataSpec)
     
    int
    read(byte[] buffer, int offset, int readLength)
     
    void
    setRedirectListener(com.castlabs.media3.datasource.HttpRedirectListener listener)
     
    void
    setRequestProperty(String name, String value)
     

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OkHttpDataSource

      public OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
      Creates an instance.
      Parameters:
      callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.
      userAgent - The User-Agent string that should be used.
      contentTypePredicate - An optional OkHttpDataSource.Predicate. If a content type is rejected by the predicate then a InvalidContentTypeException} is thrown from open(DataSpec).
      clientCreatedListener - A listener to inform about new OkHttpClients

    • OkHttpDataSource

      public OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.media3.datasource.TransferListener listener, NetworkConfiguration networkConfiguration, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
      Creates an instance.
      Parameters:
      callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.
      userAgent - The User-Agent string that should be used.
      contentTypePredicate - An optional OkHttpDataSource.Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).
      listener - An optional listener.
      networkConfiguration - The network configuration
      clientCreatedListener - A listener to inform about new OkHttpClients

    • OkHttpDataSource

      public OkHttpDataSource(okhttp3.Call.Factory callFactory, String userAgent, OkHttpDataSource.Predicate<String> contentTypePredicate, com.castlabs.media3.datasource.TransferListener listener, okhttp3.CacheControl cacheControl, com.castlabs.media3.datasource.HttpDataSource.RequestProperties defaultRequestProperties, NetworkConfiguration networkConfiguration, com.castlabs.sdk.okhttp.OkHttpClientCreatedListener clientCreatedListener)
      Creates an instance.
      Parameters:
      callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.
      userAgent - The User-Agent string that should be used.
      contentTypePredicate - An optional OkHttpDataSource.Predicate. If a content type is rejected by the predicate then a HttpDataSource.InvalidContentTypeException is thrown from open(DataSpec).
      listener - An optional listener.
      cacheControl - An optional CacheControl for setting the Cache-Control header.
      defaultRequestProperties - The optional default HttpDataSource.RequestProperties to be sent to the server as HTTP headers on every request.
      networkConfiguration - The network configuration
      clientCreatedListener - A listener to inform about new OkHttpClients

  • Method Details

    • getUri

      public Uri getUri()
      Specified by:
      getUri in interface com.castlabs.media3.datasource.DataSource

    • addTransferListener

      public void addTransferListener(com.castlabs.media3.datasource.TransferListener listener)
      Specified by:
      addTransferListener in interface com.castlabs.media3.datasource.DataSource

    • getResponseHeaders

      public Map<String,List<String>> getResponseHeaders()
      Specified by:
      getResponseHeaders in interface com.castlabs.media3.datasource.DataSource
      Specified by:
      getResponseHeaders in interface com.castlabs.media3.datasource.HttpDataSource

    • setRedirectListener

      public void setRedirectListener(com.castlabs.media3.datasource.HttpRedirectListener listener)
      Specified by:
      setRedirectListener in interface com.castlabs.media3.datasource.HttpDataSource

    • setRequestProperty

      public void setRequestProperty(String name, String value)
      Specified by:
      setRequestProperty in interface com.castlabs.media3.datasource.HttpDataSource

    • clearRequestProperty

      public void clearRequestProperty(String name)
      Specified by:
      clearRequestProperty in interface com.castlabs.media3.datasource.HttpDataSource

    • clearAllRequestProperties

      public void clearAllRequestProperties()
      Specified by:
      clearAllRequestProperties in interface com.castlabs.media3.datasource.HttpDataSource

    • getResponseCode

      public int getResponseCode()
      Specified by:
      getResponseCode in interface com.castlabs.media3.datasource.DataSource

    • open

      public long open(com.castlabs.media3.datasource.DataSpec dataSpec) throws com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException
      Specified by:
      open in interface com.castlabs.media3.datasource.DataSource
      Specified by:
      open in interface com.castlabs.media3.datasource.HttpDataSource
      Throws:
      com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException

    • read

      public int read(byte[] buffer, int offset, int readLength) throws com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException
      Specified by:
      read in interface com.castlabs.media3.common.DataReader
      Specified by:
      read in interface com.castlabs.media3.datasource.HttpDataSource
      Throws:
      com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException

    • close

      public void close() throws com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException
      Specified by:
      close in interface com.castlabs.media3.datasource.DataSource
      Specified by:
      close in interface com.castlabs.media3.datasource.HttpDataSource
      Throws:
      com.castlabs.media3.datasource.HttpDataSource.HttpDataSourceException

    • intercept

      public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOException
      Specified by:
      intercept in interface okhttp3.Interceptor
      Throws:
      IOException