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 and Description
static class	StorageController.ClearFlags Flags used for data clearing operations.

Constructor Summary

Constructors

Constructor and Description
StorageController()

Method Summary

Modifier and Type	Method and Description
GeckoResult<Void>	clearData(long flags) Clear data for all hosts.
void	clearDataForSessionContext(String contextId) Clear data for the given context ID.
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<List<GeckoSession.PermissionDelegate.ContentPermission>>	getPermissions(String uri) Get all currently stored permissions for a given URI.

Methods inherited from class Object

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

Constructor Detail

StorageController

public StorageController()

Method Detail

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.

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.

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.