Package org.mozilla.geckoview

Class ContentBlocking.SafeBrowsingProvider.Builder

Object

org.mozilla.geckoview.ContentBlocking.SafeBrowsingProvider.Builder

Enclosing class:

ContentBlocking.SafeBrowsingProvider

@AnyThread
public static class ContentBlocking.SafeBrowsingProvider.Builder
extends Object

Builder for constructing SafeBrowsingProvider instances.

Method Summary

Modifier and Type	Method	Description
ContentBlocking.SafeBrowsingProvider.Builder	advisoryName(String advisoryName)	Set the advisory name for this provider.
ContentBlocking.SafeBrowsingProvider.Builder	advisoryUrl(String advisoryUrl)	Set the url that will be used to give a general advisory about this SafeBrowsing provider.
ContentBlocking.SafeBrowsingProvider	build()	Build the ContentBlocking.SafeBrowsingProvider based on this ContentBlocking.SafeBrowsingProvider.Builder instance.
ContentBlocking.SafeBrowsingProvider.Builder	dataSharingEnabled(boolean dataSharingEnabled)	Set whether to share threat data with the provider, off by default.
ContentBlocking.SafeBrowsingProvider.Builder	dataSharingUrl(String dataSharingUrl)	Set url to share threat data to the provider, if enabled by dataSharingEnabled(boolean).
ContentBlocking.SafeBrowsingProvider.Builder	enabled(boolean enabled)	Set whether to enable this provider.
ContentBlocking.SafeBrowsingProvider.Builder	getHashUrl(String getHashUrl)	Sets the url that will be used to get the full hashes that match a partial hash.
ContentBlocking.SafeBrowsingProvider.Builder	lists(String... lists)	Sets the lists provided by this provider.
ContentBlocking.SafeBrowsingProvider.Builder	reportMalwareMistakeUrl(String reportMalwareMistakeUrl)	Set the url that will be used to report a url mistakenly reported as Malware to the SafeBrowsing provider.
ContentBlocking.SafeBrowsingProvider.Builder	reportPhishingMistakeUrl(String reportPhishingMistakeUrl)	Set the url that will be used to report a url mistakenly reported as Phishing to the SafeBrowsing provider.
ContentBlocking.SafeBrowsingProvider.Builder	reportUrl(String reportUrl)	Set the url that will be used to report a url to the SafeBrowsing provider.
ContentBlocking.SafeBrowsingProvider.Builder	updateUrl(String updateUrl)	Sets the url that will be used to update the threat list for this provider.
ContentBlocking.SafeBrowsingProvider.Builder	version(String version)	Sets the SafeBrowsing protocol session for this provider.

Methods inherited from class java.lang.Object

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

Method Details

version

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder version(@NonNull
 String version)

Sets the SafeBrowsing protocol session for this provider.

Parameters:

version - the version strong, e.g. "2.2" or "4".

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

lists

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder lists(@NonNull
 String... lists)

Sets the lists provided by this provider.

Parameters:

lists - one or more lists for this provider, e.g. "goog-malware-proto", "goog-unwanted-proto"

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

updateUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder updateUrl(@NonNull
 String updateUrl)

Sets the url that will be used to update the threat list for this provider.

See also v4/threadListUpdates/fetch .

Parameters:

updateUrl - the update url endpoint for this provider

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

getHashUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder getHashUrl(@NonNull
 String getHashUrl)

Sets the url that will be used to get the full hashes that match a partial hash.

See also v4/fullHashes/find .

Parameters:

getHashUrl - the gethash url endpoint for this provider

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

reportUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder reportUrl(@NonNull
 String reportUrl)

Set the url that will be used to report a url to the SafeBrowsing provider.

Parameters:

reportUrl - the url endpoint to report a url to this provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

reportPhishingMistakeUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder reportPhishingMistakeUrl(@NonNull
 String reportPhishingMistakeUrl)

Set the url that will be used to report a url mistakenly reported as Phishing to the SafeBrowsing provider.

Parameters:

reportPhishingMistakeUrl - the url endpoint to report a url to this provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

reportMalwareMistakeUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder reportMalwareMistakeUrl(@NonNull
 String reportMalwareMistakeUrl)

Set the url that will be used to report a url mistakenly reported as Malware to the SafeBrowsing provider.

Parameters:

reportMalwareMistakeUrl - the url endpoint to report a url to this provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

advisoryUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder advisoryUrl(@NonNull
 String advisoryUrl)

Set the url that will be used to give a general advisory about this SafeBrowsing provider.

Parameters:

advisoryUrl - the adivisory page url for this provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

advisoryName

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder advisoryName(@NonNull
 String advisoryName)

Set the advisory name for this provider.

Parameters:

advisoryName - the adivisory name for this provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

dataSharingUrl

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder dataSharingUrl(@NonNull
 String dataSharingUrl)

Set url to share threat data to the provider, if enabled by dataSharingEnabled(boolean).

Parameters:

dataSharingUrl - the url endpoint

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

dataSharingEnabled

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder dataSharingEnabled(boolean dataSharingEnabled)

Set whether to share threat data with the provider, off by default.

Parameters:

dataSharingEnabled - true if the browser should share threat data with the provider.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

enabled

@NonNull
public ContentBlocking.SafeBrowsingProvider.Builder enabled(boolean enabled)

Set whether to enable this provider. This is currently only used for the SafeBrowsing V5.

Parameters:

enabled - true if the provider should be enabled.

Returns:

this ContentBlocking.SafeBrowsingProvider.Builder instance.

build

@NonNull
public ContentBlocking.SafeBrowsingProvider build()

Build the ContentBlocking.SafeBrowsingProvider based on this ContentBlocking.SafeBrowsingProvider.Builder instance.

Returns:

thie ContentBlocking.SafeBrowsingProvider instance.