Package org.mozilla.geckoview

Class StorageController

Object

org.mozilla.geckoview.StorageController

public final class StorageController
extends Object

Manage runtime storage data.

Retrieve an instance via GeckoRuntime.getStorageController().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StorageController.ClearFlags	Flags used for data clearing operations.
static @interface	StorageController.StorageControllerClearFlags	Clear flags for storage controller operations.

Constructor Summary

Constructors

Constructor	Description
StorageController()

Method Summary

Modifier and Type	Method	Description
GeckoResult<Void>	clearData(long flags)	Clear data for all hosts.
void	clearDataForSessionContext(String contextId)	Clear data for the given context ID.
GeckoResult<Void>	clearDataFromBaseDomain(String baseDomain, long flags)	Clear data owned by the given base domain (eTLD+1).
GeckoResult<Void>	clearDataFromHost(String host, long flags)	Clear data owned by the given host.
GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>>	getAllPermissions()	Get all currently stored permissions.
GeckoResult<Integer>	getCookieBannerModeForDomain(String uri, boolean isPrivateBrowsing)	Gets the actual ContentBlocking.CBCookieBannerMode for the given uri and browsing mode.
GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>>	getPermissions(String uri)	Get all currently stored permissions for a given URI and default (unset) context ID, in normal mode This API will be deprecated in the future https://bugzilla.mozilla.org/show_bug.cgi?id=1797379
GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>>	getPermissions(String uri, boolean privateMode)	Get all currently stored permissions for a given URI and default (unset) context ID.
GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>>	getPermissions(String uri, String contextId, boolean privateMode)	Get all currently stored permissions for a given URI and context ID.
GeckoResult<Void>	removeCookieBannerModeForDomain(String uri, boolean isPrivateBrowsing)	Removes a ContentBlocking.CBCookieBannerMode for the given uri and and browsing mode.
GeckoResult<Void>	setCookieBannerModeAndPersistInPrivateBrowsingForDomain(String uri, int mode)	Set a permanent ContentBlocking.CBCookieBannerMode for the given uri in private mode.
GeckoResult<Void>	setCookieBannerModeForDomain(String uri, int mode, boolean isPrivateBrowsing)	Set a permanent ContentBlocking.CBCookieBannerMode for the given uri and browsing mode.
void	setPermission(GeckoSession.PermissionDelegate.ContentPermission perm, int value)	Set a new value for an existing permission.
void	setPrivateBrowsingPermanentPermission(GeckoSession.PermissionDelegate.ContentPermission perm, int value)	Set a permanent value for a permission in a private browsing session.

Methods inherited from class java.lang.Object

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

Constructor Details

StorageController

public StorageController()

Method Details

clearData

@AnyThread
@NonNull
public GeckoResult<Void> clearData(long flags)

Clear data for all hosts.

Note: Any open session may re-accumulate previously cleared data. To ensure that no persistent data is left behind, you need to close all sessions prior to clearing data.

Parameters:

flags - Combination of StorageController.ClearFlags.

Returns:

A GeckoResult that will complete when clearing has finished.

clearDataFromHost

@AnyThread
@NonNull
public GeckoResult<Void> clearDataFromHost(@NonNull
 String host,
 long flags)

Clear data owned by the given host. Clearing data for a host will not clear data created by its third-party origins.

Note: Any open session may re-accumulate previously cleared data. To ensure that no persistent data is left behind, you need to close all sessions prior to clearing data.

Parameters:

host - The host to be used.

flags - Combination of StorageController.ClearFlags.

Returns:

A GeckoResult that will complete when clearing has finished.

clearDataFromBaseDomain

@AnyThread
@NonNull
public GeckoResult<Void> clearDataFromBaseDomain(@NonNull
 String baseDomain,
 long flags)

Clear data owned by the given base domain (eTLD+1). Clearing data for a base domain will also clear any associated third-party storage. This includes clearing for third-parties embedded by the domain and for the given domain embedded under other sites.

Note: Any open session may re-accumulate previously cleared data. To ensure that no persistent data is left behind, you need to close all sessions prior to clearing data.

Parameters:

baseDomain - The base domain to be used.

flags - Combination of StorageController.ClearFlags.

Returns:

A GeckoResult that will complete when clearing has finished.

clearDataForSessionContext

@AnyThread
public void clearDataForSessionContext(@NonNull
 String contextId)

Clear data for the given context ID. Use GeckoSessionSettings.Builder.contextId(java.lang.String).to set a context ID for a session.

Note: Any open session may re-accumulate previously cleared data. To ensure that no persistent data is left behind, you need to close all sessions for the given context prior to clearing data.

Parameters:

contextId - The context ID for the storage data to be deleted.

getAllPermissions

@AnyThread
@NonNull
public GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>> getAllPermissions()

Get all currently stored permissions.

Returns:

A GeckoResult that will complete with a list of all currently stored GeckoSession.PermissionDelegate.ContentPermissions.

getPermissions

@AnyThread
@NonNull
public GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>> getPermissions(@NonNull
 String uri)

Get all currently stored permissions for a given URI and default (unset) context ID, in normal mode This API will be deprecated in the future https://bugzilla.mozilla.org/show_bug.cgi?id=1797379

Parameters:

uri - A String representing the URI to get permissions for.

Returns:

A GeckoResult that will complete with a list of all currently stored GeckoSession.PermissionDelegate.ContentPermissions for the URI.

getPermissions

@AnyThread
@NonNull
public GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>> getPermissions(@NonNull
 String uri,
 boolean privateMode)

Get all currently stored permissions for a given URI and default (unset) context ID.

Parameters:

uri - A String representing the URI to get permissions for.

privateMode - indicate where the GeckoSession.PermissionDelegate.ContentPermissions should be in private or normal mode.

Returns:

A GeckoResult that will complete with a list of all currently stored GeckoSession.PermissionDelegate.ContentPermissions for the URI.

getPermissions

@AnyThread
@NonNull
public GeckoResult<List<GeckoSession.PermissionDelegate.ContentPermission>> getPermissions(@NonNull
 String uri,
 @Nullable
 String contextId,
 boolean privateMode)

Get all currently stored permissions for a given URI and context ID.

Parameters:

uri - A String representing the URI to get permissions for.

contextId - A String specifying the context ID.

privateMode - indicate where the GeckoSession.PermissionDelegate.ContentPermissions should be in private or normal mode

Returns:

A GeckoResult that will complete with a list of all currently stored GeckoSession.PermissionDelegate.ContentPermissions for the URI.

setPermission

@AnyThread
public void setPermission(@NonNull
 GeckoSession.PermissionDelegate.ContentPermission perm,
 int value)

Set a new value for an existing permission.

Note: in private browsing, this value will only be cleared at the end of the session to add permanent permissions in private browsing, you can use setPrivateBrowsingPermanentPermission(org.mozilla.geckoview.GeckoSession.PermissionDelegate.ContentPermission, int).

Parameters:

perm - A GeckoSession.PermissionDelegate.ContentPermission that you wish to update the value of.

value - The new value for the permission.

setPrivateBrowsingPermanentPermission

@AnyThread
public void setPrivateBrowsingPermanentPermission(@NonNull
 GeckoSession.PermissionDelegate.ContentPermission perm,
 int value)

Set a permanent value for a permission in a private browsing session.

Normally permissions in private browsing are cleared at the end of the session. This method allows you to set a permanent permission bypassing this behavior.

Note: permanent permissions in private browsing are web discoverable and might make the user more easily trackable.

Parameters:

perm - A GeckoSession.PermissionDelegate.ContentPermission that you wish to update the value of.

value - The new value for the permission.

See Also:

• setPermission(org.mozilla.geckoview.GeckoSession.PermissionDelegate.ContentPermission, int)

setCookieBannerModeForDomain

@AnyThread
@NonNull
public GeckoResult<Void> setCookieBannerModeForDomain(@NonNull
 String uri,
 int mode,
 boolean isPrivateBrowsing)

Set a permanent ContentBlocking.CBCookieBannerMode for the given uri and browsing mode.

Parameters:

uri - An uri for which you want change the ContentBlocking.CBCookieBannerMode value.

mode - A new ContentBlocking.CBCookieBannerMode for the given uri.

isPrivateBrowsing - Indicates in which browsing mode the given ContentBlocking.CBCookieBannerMode should be applied.

Returns:

A GeckoResult that will complete when the mode has been set.

setCookieBannerModeAndPersistInPrivateBrowsingForDomain

@AnyThread
@NonNull
public GeckoResult<Void> setCookieBannerModeAndPersistInPrivateBrowsingForDomain(@NonNull
 String uri,
 int mode)

Set a permanent ContentBlocking.CBCookieBannerMode for the given uri in private mode.

Parameters:

uri - for which you want to change the ContentBlocking.CBCookieBannerMode value.

mode - A new ContentBlocking.CBCookieBannerMode for the given uri.

Returns:

A GeckoResult that will complete when the mode has been set.

removeCookieBannerModeForDomain

@AnyThread
@NonNull
public GeckoResult<Void> removeCookieBannerModeForDomain(@NonNull
 String uri,
 boolean isPrivateBrowsing)

Removes a ContentBlocking.CBCookieBannerMode for the given uri and and browsing mode.

Parameters:

uri - An uri for which you want change the ContentBlocking.CBCookieBannerMode value.

isPrivateBrowsing - Indicates in which mode the given mode should be applied.

Returns:

A GeckoResult that will complete when the mode has been removed.

getCookieBannerModeForDomain

@AnyThread
@NonNull
public GeckoResult<Integer> getCookieBannerModeForDomain(@NonNull
 String uri,
 boolean isPrivateBrowsing)

Gets the actual ContentBlocking.CBCookieBannerMode for the given uri and browsing mode.

Parameters:

uri - An uri for which you want get the ContentBlocking.CBCookieBannerMode.

isPrivateBrowsing - Indicates in which browsing mode the given uri should be.

Returns:

A GeckoResult that resolves to a ContentBlocking.CBCookieBannerMode for the given uri and browsing mode.