org.adblockplus.libadblockplus

Class FilterEngine

java.lang.Object

org.adblockplus.libadblockplus.FilterEngine

public final class FilterEngine
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterEngine.ContentType
static class	FilterEngine.EmulationSelector

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_PARENT
static java.lang.String	EMPTY_SITEKEY
protected long	ptr

Method Summary

Modifier and Type	Method and Description
void	addFilter(Filter filter)
void	addSubscription(Subscription subscription)
java.util.List<Subscription>	fetchAvailableSubscriptions()
java.lang.String	getAcceptableAdsSubscriptionURL()
java.lang.String	getAllowedConnectionType()
java.util.List<FilterEngine.EmulationSelector>	getElementHidingEmulationSelectors(java.lang.String domain)
java.lang.String	getElementHidingStyleSheet(java.lang.String domain)
java.lang.String	getElementHidingStyleSheet(java.lang.String domain, boolean specificOnly)
Filter	getFilter(java.lang.String text)
java.lang.String	getHostFromURL(java.lang.String url)
java.util.List<Filter>	getListedFilters()
java.util.List<Subscription>	getListedSubscriptions()
long	getNativePtr() Get FilterEngine pointer
JsValue	getPref(java.lang.String pref)
Subscription	getSubscription(java.lang.String url)
boolean	isAcceptableAdsEnabled()
boolean	isContentAllowlisted(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey) Checks whether the resource at the supplied URL is allowlisted.
boolean	isDocumentAllowlisted(java.lang.String url, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey) Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#DOCUMENT} instead.
boolean	isElemhideAllowlisted(java.lang.String url, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey) Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#ELEMHIDE} instead.
boolean	isGenericblockAllowlisted(java.lang.String url, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey) Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#GENERICBLOCK} instead.
Filter	matches(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey) Deprecated. Use FilterEngine#matches) which takes a single parent as a String instead of {@param documentUrls} and {@param specificOnly} argument.
Filter	matches(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.util.List<java.lang.String> documentUrls, java.lang.String siteKey, boolean specificOnly) Deprecated. Use FilterEngine#matches) which takes a single parent as a String instead of {@param documentUrls}.
Filter	matches(java.lang.String url, java.util.Set<FilterEngine.ContentType> contentTypes, java.lang.String parent, java.lang.String siteKey, boolean specificOnly) Checks if any active filter matches the supplied URL.
void	removeFilter(Filter filter)
void	removeFilterChangeCallback()
void	removeSubscription(Subscription subscription)
void	setAcceptableAdsEnabled(boolean enabled)
void	setAllowedConnectionType(java.lang.String value)
void	setFilterChangeCallback(FilterChangeCallback callback)
void	setPref(java.lang.String pref, JsValue value) Set libadblockplus preference.
void	updateFiltersAsync(java.lang.String subscriptionUrl) Schedules updating of a subscription corresponding to the passed URL.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PARENT

public static final java.lang.String EMPTY_PARENT

See Also:

Constant Field Values

EMPTY_SITEKEY

public static final java.lang.String EMPTY_SITEKEY

See Also:

Constant Field Values

ptr

protected final long ptr

Method Detail

getFilter

public Filter getFilter(java.lang.String text)

getListedFilters

public java.util.List<Filter> getListedFilters()

getSubscription

public Subscription getSubscription(java.lang.String url)

getListedSubscriptions

public java.util.List<Subscription> getListedSubscriptions()

fetchAvailableSubscriptions

public java.util.List<Subscription> fetchAvailableSubscriptions()

removeFilterChangeCallback

public void removeFilterChangeCallback()

setFilterChangeCallback

public void setFilterChangeCallback(FilterChangeCallback callback)

getElementHidingStyleSheet

public java.lang.String getElementHidingStyleSheet(java.lang.String domain)

getElementHidingStyleSheet

public java.lang.String getElementHidingStyleSheet(java.lang.String domain,
                                                   boolean specificOnly)

getElementHidingEmulationSelectors

public java.util.List<FilterEngine.EmulationSelector> getElementHidingEmulationSelectors(java.lang.String domain)

matches

@Deprecated
public Filter matches(java.lang.String url,
                                  java.util.Set<FilterEngine.ContentType> contentTypes,
                                  java.util.List<java.lang.String> documentUrls,
                                  java.lang.String siteKey)

Deprecated. Use FilterEngine#matches) which takes a single parent as a String instead of {@param documentUrls} and {@param specificOnly} argument.

Checks if any active filter matches the supplied URL.

Parameters:

url - url URL to match.

contentTypes - Content type mask of the requested resource.

documentUrls - Chain of documents requesting the resource, starting with the current resource's parent frame, ending with the top-level frame.

siteKey - sitekey or null/empty string

Returns:

Matching filter, or a `null` if there was no match.

matches

@Deprecated
public Filter matches(java.lang.String url,
                                  java.util.Set<FilterEngine.ContentType> contentTypes,
                                  java.util.List<java.lang.String> documentUrls,
                                  java.lang.String siteKey,
                                  boolean specificOnly)

Deprecated. Use FilterEngine#matches) which takes a single parent as a String instead of {@param documentUrls}.

Checks if any active filter matches the supplied URL.

Parameters:

url - url URL to match.

contentTypes - Content type mask of the requested resource.

documentUrls - Chain of documents requesting the resource, starting with the current resource's parent frame, ending with the top-level frame.

siteKey - sitekey or null/empty string

specificOnly - if set to `true` then skips generic filters

Returns:

Matching filter, or a `null` if there was no match.

matches

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

Checks if any active filter matches the supplied URL.

Parameters:

url - url URL to match.

contentTypes - Content type mask of the requested resource.

parent - immediate parent of the .

siteKey - sitekey or null/empty string

specificOnly - if set to `true` then skips generic filters

Returns:

Matching filter, or a `null` if there was no match.

isContentAllowlisted

public boolean isContentAllowlisted(java.lang.String url,
                                    java.util.Set<FilterEngine.ContentType> contentTypes,
                                    java.util.List<java.lang.String> documentUrls,
                                    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.

documentUrls - Chain of URLs requesting the resource

siteKey - public key provided by the document, can be empty.

Returns:

`true` if the URL is allowlisted.

isGenericblockAllowlisted

@Deprecated
public boolean isGenericblockAllowlisted(java.lang.String url,
                                                     java.util.List<java.lang.String> documentUrls,
                                                     java.lang.String siteKey)

Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#GENERICBLOCK} instead.

Checks if any active filter matches the supplied URL.

Parameters:

url - URL to match which is actually first parent of URL for which we want to check a $genericblock filter. Value obtained by `IsGenericblockAllowlisted()` is used later on as a `specificOnly` parameter value for `Matches()` call.

documentUrls - Chain of documents requesting the resource, starting with the current resource's parent frame, ending with the top-level frame.

siteKey - sitekey or null/empty string

Returns:

`true` if the URL is allowlisted by $genericblock filter

isDocumentAllowlisted

@Deprecated
public boolean isDocumentAllowlisted(java.lang.String url,
                                                 java.util.List<java.lang.String> documentUrls,
                                                 java.lang.String siteKey)

Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#DOCUMENT} instead.

Check if the document with URL is allowlisted

Parameters:

url - URL

documentUrls - Chain of document URLs requesting the document, starting with the current document's parent frame, ending with the top-level frame.

siteKey - sitekey or null/empty string

Returns:

`true` if the URL is allowlisted

isElemhideAllowlisted

@Deprecated
public boolean isElemhideAllowlisted(java.lang.String url,
                                                 java.util.List<java.lang.String> documentUrls,
                                                 java.lang.String siteKey)

Deprecated. Use FilterEngine#isContentAllowlisted) with contentType containing {@link ContentType#ELEMHIDE} instead.

Check if the element hiding is allowlisted

Parameters:

url - URL

documentUrls - Chain of document URLs requesting the document, starting with the current document's parent frame, ending with the top-level frame.

siteKey - sitekey or null/empty string

Returns:

`true` if element hiding is allowlisted for the supplied URL.

getPref

public JsValue getPref(java.lang.String pref)

setPref

public void setPref(java.lang.String pref,
                    JsValue value)

Set libadblockplus preference. Only known preferences will be stored after engine is disposed.

Parameters:

pref - preference name. See lib/pref.js in libadblockplus for valid names

value - preference value

getHostFromURL

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

setAllowedConnectionType

public void setAllowedConnectionType(java.lang.String value)

getAllowedConnectionType

public java.lang.String getAllowedConnectionType()

setAcceptableAdsEnabled

public void setAcceptableAdsEnabled(boolean enabled)

isAcceptableAdsEnabled

public boolean isAcceptableAdsEnabled()

getAcceptableAdsSubscriptionURL

public java.lang.String getAcceptableAdsSubscriptionURL()

updateFiltersAsync

public void updateFiltersAsync(java.lang.String subscriptionUrl)

Schedules updating of a subscription corresponding to the passed URL.

Parameters:

subscriptionUrl - may contain query parameters, only the beginning of the string is used to find a corresponding subscription.

getNativePtr

public long getNativePtr()

Get FilterEngine pointer

Returns:

C++ FilterEngine instance pointer (AdblockPlus::FilterEngine*)

addSubscription

public void addSubscription(Subscription subscription)

removeSubscription

public void removeSubscription(Subscription subscription)

addFilter

public void addFilter(Filter filter)

removeFilter

public void removeFilter(Filter filter)