com.google.android.vending.licensing

Class APKExpansionPolicy

java.lang.Object

com.google.android.vending.licensing.APKExpansionPolicy

All Implemented Interfaces:

Policy

public class APKExpansionPolicy
extends Object
implements Policy

Default policy. All policy decisions are based off of response data received from the licensing service. Specifically, the licensing server sends the following information: response validity period, error retry period, and error retry count.

These values will vary based on the the way the application is configured in the Android Market publishing console, such as whether the application is marked as free or is within its refund period, as well as how often an application is checking with the licensing service.

Developers who need more fine grained control over their application's licensing policy should implement a custom Policy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAIN_FILE_URL_INDEX The design of the protocol supports n files.
static int	PATCH_FILE_URL_INDEX

Fields inherited from interface com.google.android.vending.licensing.Policy

LICENSED, NOT_LICENSED, RETRY

Constructor Summary

Constructors

Constructor and Description
APKExpansionPolicy(android.content.Context context, Obfuscator obfuscator)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowAccess() Check if the user should be allowed access to the application.
String	getExpansionFileName(int index)
long	getExpansionFileSize(int index)
String	getExpansionURL(int index) Gets the expansion URL.
int	getExpansionURLCount() Gets the count of expansion URLs.
long	getMaxRetries()
long	getRetryCount()
long	getRetryUntil()
long	getValidityTimestamp()
void	processServerResponse(int response, ResponseData rawData) Process a new response from the license server.
void	resetPolicy() We call this to guarantee that we fetch a fresh policy from the server.
void	setExpansionFileName(int index, String name)
void	setExpansionFileSize(int index, long size)
void	setExpansionURL(int index, String URL) Sets the expansion URL.

Methods inherited from class java.lang.Object

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

Field Detail

MAIN_FILE_URL_INDEX

public static final int MAIN_FILE_URL_INDEX

The design of the protocol supports n files. Currently the market can only deliver two files. To accommodate this, we have these two constants, but the order is the only relevant thing here.

See Also:

Constant Field Values

PATCH_FILE_URL_INDEX

public static final int PATCH_FILE_URL_INDEX

See Also:

Constant Field Values

Constructor Detail

APKExpansionPolicy

public APKExpansionPolicy(android.content.Context context,
                  Obfuscator obfuscator)

Parameters:

context - The context for the current application

obfuscator - An obfuscator to be used with preferences.

Method Detail

resetPolicy

public void resetPolicy()

We call this to guarantee that we fetch a fresh policy from the server. This is to be used if the URL is invalid.

processServerResponse

public void processServerResponse(int response,
                         ResponseData rawData)

Process a new response from the license server.

This data will be used for computing future policy decisions. The following parameters are processed:

• VT: the timestamp that the client should consider the response valid until
• GT: the timestamp that the client should ignore retry errors until
• GR: the number of retry errors that the client should ignore

Specified by:

processServerResponse in interface Policy

Parameters:

response - the result from validating the server response

rawData - the raw server response data

getRetryCount

public long getRetryCount()

getValidityTimestamp

public long getValidityTimestamp()

getRetryUntil

public long getRetryUntil()

getMaxRetries

public long getMaxRetries()

getExpansionURLCount

public int getExpansionURLCount()

Gets the count of expansion URLs. Since expansionURLs are not committed to preferences, this will return zero if there has been no LVL fetch in the current session.

Returns:

the number of expansion URLs. (0,1,2)

getExpansionURL

public String getExpansionURL(int index)

Gets the expansion URL. Since these URLs are not committed to preferences, this will always return null if there has not been an LVL fetch in the current session.

Parameters:

index - the index of the URL to fetch. This value will be either MAIN_FILE_URL_INDEX or PATCH_FILE_URL_INDEX

URL - the URL to set

setExpansionURL

public void setExpansionURL(int index,
                   String URL)

Sets the expansion URL. Expansion URL's are not committed to preferences, but are instead intended to be stored when the license response is processed by the front-end.

Parameters:

index - the index of the expansion URL. This value will be either MAIN_FILE_URL_INDEX or PATCH_FILE_URL_INDEX

URL - the URL to set

getExpansionFileName

public String getExpansionFileName(int index)

setExpansionFileName

public void setExpansionFileName(int index,
                        String name)

getExpansionFileSize

public long getExpansionFileSize(int index)

setExpansionFileSize

public void setExpansionFileSize(int index,
                        long size)

allowAccess

public boolean allowAccess()

Check if the user should be allowed access to the application. This implementation allows access if either:

1. a LICENSED response was received within the validity period
2. a RETRY response was received in the last minute, and we are under the RETRY count or in the RETRY period.

Specified by:

allowAccess in interface Policy