java.lang.Object
- Torello.Browser.Storage

```
public class Storage
extends java.lang.Object
```
Class created by Automatic Code-Generator.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

Node.js RDP-API Implementation:
You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM
[No Description Provided by Google]
This class is intended to be used with a Headless Browser
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:
1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object
Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".
Hi-Lited Source-Code:
- View Here: Torello/Browser/Storage.java
- Open New Browser-Tab: Torello/Browser/Storage.java
File Size: 44,960 Bytes Line Count: 1,128 '\n' Characters Found
Stateless Class:
This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 12 Method(s), 12 declared static
- 6 Field(s), 6 declared static, 5 declared final
- Fields excused from final modifier (with explanation):
  
  Field 'counter' is not final. Reason: CONFIGURATION

Nested Class Summary

Type Classes: Storage Domain Types

Modifier and Type	Inner-Class
`static class`	`Storage.TrustTokens`	Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.
`static class`	`Storage.UsageForType`	Usage for a storage type.

Event Classes: Storage Domain Events
Modifier and Type	Inner-Class
`static class`	`Storage.cacheStorageContentUpdated`	A cache's contents have been modified.
`static class`	`Storage.cacheStorageListUpdated`	A cache has been added/deleted.
`static class`	`Storage.indexedDBContentUpdated`	The origin's IndexedDB object store has been modified.
`static class`	`Storage.indexedDBListUpdated`	The origin's IndexedDB database list has been modified.

Field Summary

Storage Domain Enumerated String Types

Modifier and Type Field

static String[] StorageType
Enum of possible storage types.

Method Summary

Storage Domain Commands

Script Returns	Modifier and Type	Method
NONE (`void`)	`static Script<>`	`clearCookies(String browserContextId)` Clears cookies.
NONE (`void`)	`static Script<>`	`clearDataForOrigin(String origin, String storageTypes)` Clears storage for origin.
`Boolean`	`static Script<>`	`clearTrustTokens(String issuerOrigin)` Removes all Trust Tokens issued by the provided issuerOrigin.
`Network.Cookie[]`	`static Script<>`	`getCookies(String browserContextId)` Returns all browser cookies.
`Storage.TrustTokens[]`	`static Script<>`	`getTrustTokens()` Returns the number of stored Trust Tokens per issuer for the current browsing context.
`Ret4<Number, Number, Boolean, Storage.UsageForType[]>`	`static Script<>`	`getUsageAndQuota(String origin)` Returns usage and quota in bytes.
NONE (`void`)	`static Script<>`	`overrideQuotaForOrigin(String origin, Number quotaSize)` Override quota for the specified origin EXPERIMENTAL
NONE (`void`)	`static Script<>`	`setCookies(Network.CookieParam[] cookies, String browserContextId)` Sets given cookies.
NONE (`void`)	`static Script<>`	`trackCacheStorageForOrigin(String origin)` Registers origin to be notified when an update occurs to its cache storage list.
NONE (`void`)	`static Script<>`	`trackIndexedDBForOrigin(String origin)` Registers origin to be notified when an update occurs to its IndexedDB.
NONE (`void`)	`static Script<>`	`untrackCacheStorageForOrigin(String origin)` Unregisters origin from receiving notifications for cache storage.
NONE (`void`)	`static Script<>`	`untrackIndexedDBForOrigin(String origin)` Unregisters origin from receiving notifications for IndexedDB.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - StorageType
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static final java.lang.String[] StorageType
    
    Enum of possible storage types.
- Method Detail
  - clearDataForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> clearDataForOrigin (java.lang.String origin, java.lang.String storageTypes)
    
    Clears storage for origin.
    
    Parameters:
    
    origin - Security origin.
    
    storageTypes - Comma separated list of StorageType to clear.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - getCookies
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Network.Cookie[]> getCookies (java.lang.String browserContextId)
    
    Returns all browser cookies.
    
    Parameters:
    
    browserContextId - Browser context to use when called on the browser endpoint.
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Network.Cookie[]>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Network.Cookie[]> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    Network.Cookie[] (cookies)
    Array of cookie objects.
  - setCookies
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> setCookies (Network.CookieParam[] cookies, java.lang.String browserContextId)
    
    Sets given cookies.
    
    Parameters:
    
    cookies - Cookies to be set.
    
    browserContextId - Browser context to use when called on the browser endpoint.
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - clearCookies
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> clearCookies (java.lang.String browserContextId)
    
    Clears cookies.
    
    Parameters:
    
    browserContextId - Browser context to use when called on the browser endpoint.
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - getUsageAndQuota
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret4<java.lang.Number,java.lang.Number,java.lang.Boolean,Storage.UsageForType[]>> getUsageAndQuota (java.lang.String origin)
    
    Returns usage and quota in bytes.
    
    Parameters:
    
    origin - Security origin.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret4>
    
    This Script may be executed (using Script.exec()), and a Promise returned.
    
    When the Promise is awaited (using Promise.await()), the Ret4 will subsequently be returned from that call.
    
    The returned values are encapsulated in an instance of Ret4
    
    Ret4.a: Number (usage)
    Storage usage (bytes).
    
    Ret4.b: Number (quota)
    Storage quota (bytes).
    
    Ret4.c: Boolean (overrideActive)
    Whether or not the origin has an active storage quota override
    
    Ret4.d: Storage.UsageForType[] (usageBreakdown)
    Storage usage per type (bytes).
  - overrideQuotaForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> overrideQuotaForOrigin (java.lang.String origin, java.lang.Number quotaSize)
    
    Override quota for the specified origin
    EXPERIMENTAL
    
    Parameters:
    
    origin - Security origin.
    
    quotaSize - The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - trackCacheStorageForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> trackCacheStorageForOrigin (java.lang.String origin)
    
    Registers origin to be notified when an update occurs to its cache storage list.
    
    Parameters:
    
    origin - Security origin.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - trackIndexedDBForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> trackIndexedDBForOrigin (java.lang.String origin)
    
    Registers origin to be notified when an update occurs to its IndexedDB.
    
    Parameters:
    
    origin - Security origin.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - untrackCacheStorageForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> untrackCacheStorageForOrigin (java.lang.String origin)
    
    Unregisters origin from receiving notifications for cache storage.
    
    Parameters:
    
    origin - Security origin.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - untrackIndexedDBForOrigin
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> untrackIndexedDBForOrigin (java.lang.String origin)
    
    Unregisters origin from receiving notifications for IndexedDB.
    
    Parameters:
    
    origin - Security origin.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - getTrustTokens
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Storage.TrustTokens[]> getTrustTokens ()
    
    Returns the number of stored Trust Tokens per issuer for the current browsing context.
    EXPERIMENTAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Storage.TrustTokens[]>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Storage.TrustTokens[]> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    Storage.TrustTokens[] (tokens)
    -
  - clearTrustTokens
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,java.lang.Boolean> clearTrustTokens (java.lang.String issuerOrigin)
    
    Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.
    EXPERIMENTAL
    
    Parameters:
    
    issuerOrigin - -
    
    Returns:
    
    An instance of Script<String, JsonObject, Boolean>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, Boolean> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    Boolean (didDeleteTokens)
    True if any tokens were deleted, false otherwise.

Storage Domain Enumerated String Types

Modifier and Type	Field
`static String[]`	`StorageType`	Enum of possible storage types.

Fields
String[]	StorageType
Methods
Script	clearCookies(String browserContextId)
Script	clearDataForOrigin(String origin, String storageTypes)
Script	clearTrustTokens(String issuerOrigin)
Script	getCookies(String browserContextId)
Script	getTrustTokens()
Script	getUsageAndQuota(String origin)
Script	overrideQuotaForOrigin(String origin, Number quotaSize)
Script	setCookies(CookieParam[] cookies, String browserContextId)
Script	trackCacheStorageForOrigin(String origin)
Script	trackIndexedDBForOrigin(String origin)
Script	untrackCacheStorageForOrigin(String origin)
Script	untrackIndexedDBForOrigin(String origin)

Class Storage

This class is intended to be used with a Headless Browser

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

StorageType

Method Detail

clearDataForOrigin

getCookies

setCookies

clearCookies

getUsageAndQuota

overrideQuotaForOrigin

trackCacheStorageForOrigin

trackIndexedDBForOrigin

untrackCacheStorageForOrigin

untrackIndexedDBForOrigin

getTrustTokens

clearTrustTokens