org.osmdroid.tileprovider.tilesource

Class TileSourcePolicy

java.lang.Object

org.osmdroid.tileprovider.tilesource.TileSourcePolicy

public class TileSourcePolicy
extends Object

Online Tile Source Usage Policy, including

• the max number of concurrent downloads
• if it accepts a meaningless user agent
• if it accepts bulk downloads
• if the user agent must be normalized

Since:

6.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_NO_BULK No bulk downloads allowed
static int	FLAG_NO_PREVENTIVE Don't try to preventively download tiles that aren't currently displayed
static int	FLAG_USER_AGENT_MEANINGFUL Demands a user agent different from the default value
static int	FLAG_USER_AGENT_NORMALIZED Uses the "normalized" user agent (package name + version)

Constructor Summary

Constructors

Constructor and Description
TileSourcePolicy()
TileSourcePolicy(int pMaxConcurrent, int pFlags)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsBulkDownload()
boolean	acceptsPreventive()
boolean	acceptsUserAgent(String pUserAgent)
long	computeExpirationTime(HttpURLConnection pHttpURLConnection, long pNow)
long	computeExpirationTime(String pHttpExpiresHeader, String pHttpCacheControlHeader, long pNow)
Long	getHttpCacheControlDuration(String pHttpCacheControlHeader)
Long	getHttpExpiresTime(String pHttpExpiresHeader)
int	getMaxConcurrent()
boolean	normalizesUserAgent()

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_NO_BULK

public static final int FLAG_NO_BULK

No bulk downloads allowed

See Also:

Constant Field Values

FLAG_NO_PREVENTIVE

public static final int FLAG_NO_PREVENTIVE

Don't try to preventively download tiles that aren't currently displayed

See Also:

Constant Field Values

FLAG_USER_AGENT_MEANINGFUL

public static final int FLAG_USER_AGENT_MEANINGFUL

Demands a user agent different from the default value

See Also:

Constant Field Values

FLAG_USER_AGENT_NORMALIZED

public static final int FLAG_USER_AGENT_NORMALIZED

Uses the "normalized" user agent (package name + version)

See Also:

Constant Field Values

Constructor Detail

TileSourcePolicy

public TileSourcePolicy()

TileSourcePolicy

public TileSourcePolicy(int pMaxConcurrent,
                        int pFlags)

Method Detail

getMaxConcurrent

public int getMaxConcurrent()

acceptsBulkDownload

public boolean acceptsBulkDownload()

normalizesUserAgent

public boolean normalizesUserAgent()

acceptsPreventive

public boolean acceptsPreventive()

acceptsUserAgent

public boolean acceptsUserAgent(String pUserAgent)

getHttpExpiresTime

public Long getHttpExpiresTime(String pHttpExpiresHeader)

Returns:

the Epoch timestamp corresponding to the http header (in milliseconds), or null

Since:

6.1.7 Used to be in TileDownloader

getHttpCacheControlDuration

public Long getHttpCacheControlDuration(String pHttpCacheControlHeader)

Returns:

the max-age corresponding to the http header (in seconds), or null

Since:

6.1.7 Used to be in TileDownloader

computeExpirationTime

public long computeExpirationTime(String pHttpExpiresHeader,
                                  String pHttpCacheControlHeader,
                                  long pNow)

Returns:

the expiration time (as Epoch timestamp in milliseconds)

Since:

6.1.7 Used to be in TileDownloader

computeExpirationTime

public long computeExpirationTime(HttpURLConnection pHttpURLConnection,
                                  long pNow)

Returns:

the expiration time (as Epoch timestamp in milliseconds)

Since:

6.1.7