org.adblockplus.libadblockplus.android

Class AdblockEngine

java.lang.Object

org.adblockplus.libadblockplus.android.AdblockEngine

public final class AdblockEngine
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdblockEngine.Builder Builds Adblock engine piece-by-pieece
static interface	AdblockEngine.Factory Builds Adblock engine
static class	AdblockEngine.MatchesResult The result of `matches()` call
static interface	AdblockEngine.SettingsChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_PATH_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
AdblockEngine()

Method Summary

Modifier and Type	Method and Description
void	addDomainAllowlistingFilter(java.lang.String domain) Add allowlisting filter for a given domain.
void	addDomainWhitelistingFilter(java.lang.String domain) Add whitelisting filter for a given domain.
AdblockEngine	addSettingsChangedListener(AdblockEngine.SettingsChangedListener listener)
static AdblockEngine.Builder	builder(android.content.Context context, AppInfo appInfo, java.lang.String basePath)
static AdblockEngine.Builder	builder(android.content.Context context, java.lang.String basePath)
void	clearSubscriptions()
void	configureDisabledByDefault(android.content.Context context)
void	dispose()
static AppInfo	generateAppInfo(android.content.Context context)
static AppInfo	generateAppInfo(android.content.Context context, java.lang.String application, java.lang.String applicationVersion)
java.lang.String	getAcceptableAdsSubscriptionURL()
java.lang.String	getDocumentationLink()
java.util.List<FilterEngine.EmulationSelector>	getElementHidingEmulationSelectors(java.lang.String url, java.lang.String domain, java.util.List<java.lang.String> referrerChain, java.lang.String sitekey)
java.lang.String	getElementHidingStyleSheet(java.lang.String url, java.lang.String domain, java.util.List<java.lang.String> referrerChain, java.lang.String sitekey, boolean specificOnly)
FilterEngine	getFilterEngine()
Subscription[]	getListedSubscriptions()
Subscription[]	getRecommendedSubscriptions()
void	initAllowlistedDomains(java.util.List<java.lang.String> domains) Init allowlisting filters.
boolean	isAcceptableAdsEnabled()
boolean	isContentAllowlisted(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.util.List<java.lang.String> referrerChain, java.lang.String siteKey) Checks whether the resource at the supplied URL is allowlisted.
boolean	isElemhideEnabled()
boolean	isEnabled()
AdblockEngine.MatchesResult	matches(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.lang.String parent, java.lang.String siteKey, boolean specificOnly) Checks whether the resource at the supplied URL has a blocking filter.
void	onLowMemory() Calls the platform's garbage collector Assuming the default implementation, V8 garbage collector will be called
void	removeDomainAllowlistingFilter(java.lang.String domain) Remove allowlisting filter for given domain.
AdblockEngine	removeSettingsChangedListener(AdblockEngine.SettingsChangedListener listener)
void	setAcceptableAdsEnabled(boolean enabled)
void	setEnabled(boolean enabled)
void	setSubscription(java.lang.String url)
void	setSubscriptions(java.util.Collection<java.lang.String> urls)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_PATH_DIRECTORY

public static final java.lang.String BASE_PATH_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

AdblockEngine

public AdblockEngine()

Method Detail

addSettingsChangedListener

public AdblockEngine addSettingsChangedListener(AdblockEngine.SettingsChangedListener listener)

removeSettingsChangedListener

public AdblockEngine removeSettingsChangedListener(AdblockEngine.SettingsChangedListener listener)

generateAppInfo

public static AppInfo generateAppInfo(android.content.Context context,
                                      java.lang.String application,
                                      java.lang.String applicationVersion)

generateAppInfo

public static AppInfo generateAppInfo(android.content.Context context)

onLowMemory

public void onLowMemory()

Calls the platform's garbage collector Assuming the default implementation, V8 garbage collector will be called

getRecommendedSubscriptions

public Subscription[] getRecommendedSubscriptions()

builder

public static AdblockEngine.Builder builder(android.content.Context context,
                                            AppInfo appInfo,
                                            java.lang.String basePath)

builder

public static AdblockEngine.Builder builder(android.content.Context context,
                                            java.lang.String basePath)

dispose

public void dispose()

isElemhideEnabled

public boolean isElemhideEnabled()

getListedSubscriptions

public Subscription[] getListedSubscriptions()

getDocumentationLink

public java.lang.String getDocumentationLink()

clearSubscriptions

public void clearSubscriptions()

setSubscription

public void setSubscription(java.lang.String url)

setSubscriptions

public void setSubscriptions(java.util.Collection<java.lang.String> urls)

configureDisabledByDefault

public void configureDisabledByDefault(android.content.Context context)

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

getAcceptableAdsSubscriptionURL

public java.lang.String getAcceptableAdsSubscriptionURL()

isAcceptableAdsEnabled

public boolean isAcceptableAdsEnabled()

setAcceptableAdsEnabled

public void setAcceptableAdsEnabled(boolean enabled)

matches

public AdblockEngine.MatchesResult matches(java.lang.String url,
                                           java.util.Set<FilterEngine.ContentType> contentTypes,
                                           java.lang.String parent,
                                           java.lang.String siteKey,
                                           boolean specificOnly)

Checks whether the resource at the supplied URL has a blocking filter. For checking allowlisting filters use isContentAllowlisted(java.lang.String, java.util.Set<org.adblockplus.libadblockplus.FilterEngine.ContentType>, java.util.List<java.lang.String>, java.lang.String).

Parameters:

url - URL of the resource

contentTypes - Set of content types for requested resource

parent - Immediate parent of the .

siteKey - Public key provided by the document, can be empty

specificOnly - If `true` then we check only domain specific filters

Returns:

AdblockEngine.MatchesResult.NOT_ENABLED if FilterEngine is not enabled, AdblockEngine.MatchesResult.BLOCKED when blocking filter was found or AdblockEngine.MatchesResult.NOT_FOUND when blocking filter was not found.

addDomainWhitelistingFilter

public void addDomainWhitelistingFilter(java.lang.String domain)

Add whitelisting filter for a given domain.

Parameters:

domain - Domain to be added for whitelisting

isContentAllowlisted

public boolean isContentAllowlisted(java.lang.String url,
                                    java.util.Set<FilterEngine.ContentType> contentTypes,
                                    java.util.List<java.lang.String> referrerChain,
                                    java.lang.String siteKey)

Checks whether the resource at the supplied URL is allowlisted.

Parameters:

url - URL of the resource

contentTypes - Set of content types for requested resource

referrerChain - Chain of URLs requesting the resource

siteKey - Public key provided by the document, can be empty

Returns:

`true` if the URL is allowlisted

getElementHidingStyleSheet

public java.lang.String getElementHidingStyleSheet(java.lang.String url,
                                                   java.lang.String domain,
                                                   java.util.List<java.lang.String> referrerChain,
                                                   java.lang.String sitekey,
                                                   boolean specificOnly)

getElementHidingEmulationSelectors

public java.util.List<FilterEngine.EmulationSelector> getElementHidingEmulationSelectors(java.lang.String url,
                                                                                         java.lang.String domain,
                                                                                         java.util.List<java.lang.String> referrerChain,
                                                                                         java.lang.String sitekey)

getFilterEngine

public FilterEngine getFilterEngine()

initAllowlistedDomains

public void initAllowlistedDomains(java.util.List<java.lang.String> domains)

Init allowlisting filters.

Parameters:

domains - List of domains to be allowlisting

addDomainAllowlistingFilter

public void addDomainAllowlistingFilter(java.lang.String domain)

Add allowlisting filter for a given domain.

Parameters:

domain - Domain to be added for allowlisting

removeDomainAllowlistingFilter

public void removeDomainAllowlistingFilter(java.lang.String domain)

Remove allowlisting filter for given domain.

Parameters:

domain - Domain to be removed from allowlisting