com.danikula.videocache

Class HttpProxyCacheServer

java.lang.Object

com.danikula.videocache.HttpProxyCacheServer

public class HttpProxyCacheServer
extends java.lang.Object

Simple lightweight proxy server with file caching support that handles HTTP requests. Typical usage:

 public onCreate(Bundle state) {
      super.onCreate(state);

      HttpProxyCacheServer proxy = getProxy();
      String proxyUrl = proxy.getProxyUrl(VIDEO_URL);
      videoView.setVideoPath(proxyUrl);
 }

 private HttpProxyCacheServer getProxy() {
 // should return single instance of HttpProxyCacheServer shared for whole app.
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpProxyCacheServer.Builder Builder for HttpProxyCacheServer.

Constructor Summary

Constructors

Constructor and Description
HttpProxyCacheServer(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProxyUrl(java.lang.String url) Returns url that wrap original url and should be used for client (MediaPlayer, ExoPlayer, etc).
java.lang.String	getProxyUrl(java.lang.String url, boolean allowCachedFileUri) Returns url that wrap original url and should be used for client (MediaPlayer, ExoPlayer, etc).
boolean	isCached(java.lang.String url) Checks is cache contains fully cached file for particular url.
void	registerCacheListener(CacheListener cacheListener, java.lang.String url)
void	shutdown()
void	unregisterCacheListener(CacheListener cacheListener)
void	unregisterCacheListener(CacheListener cacheListener, java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpProxyCacheServer

public HttpProxyCacheServer(android.content.Context context)

Method Detail

getProxyUrl

public java.lang.String getProxyUrl(java.lang.String url)

Returns url that wrap original url and should be used for client (MediaPlayer, ExoPlayer, etc).

If file for this url is fully cached (it means method isCached(String) returns true) then file:// uri to cached file will be returned.

Calling this method has same effect as calling getProxyUrl(String, boolean) with 2nd parameter set to true.

Parameters:

url - a url to file that should be cached.

Returns:

a wrapped by proxy url if file is not fully cached or url pointed to cache file otherwise.

getProxyUrl

public java.lang.String getProxyUrl(java.lang.String url,
                                    boolean allowCachedFileUri)

Returns url that wrap original url and should be used for client (MediaPlayer, ExoPlayer, etc).

If parameter allowCachedFileUri is true and file for this url is fully cached (it means method isCached(String) returns true) then file:// uri to cached file will be returned.

Parameters:

url - a url to file that should be cached.

allowCachedFileUri - true if allow to return file:// uri if url is fully cached

Returns:

a wrapped by proxy url if file is not fully cached or url pointed to cache file otherwise (if allowCachedFileUri is true).

registerCacheListener

public void registerCacheListener(CacheListener cacheListener,
                                  java.lang.String url)

unregisterCacheListener

public void unregisterCacheListener(CacheListener cacheListener,
                                    java.lang.String url)

unregisterCacheListener

public void unregisterCacheListener(CacheListener cacheListener)

isCached

public boolean isCached(java.lang.String url)

Checks is cache contains fully cached file for particular url.

Parameters:

url - an url cache file will be checked for.

Returns:

true if cache contains fully cached file for passed in parameters url.

shutdown

public void shutdown()