Package Torello.Browser

Class CacheStorage

java.lang.Object

Torello.Browser.CacheStorage

public class CacheStorage
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/CacheStorage.java
• Open New Browser-Tab: Torello/Browser/CacheStorage.java

File Size: 29,884 Bytes Line Count: 732 '\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
• 5 Method(s), 5 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: CacheStorage Domain Types
Modifier and Type	Inner-Class
static class	CacheStorage.Cache	Cache identifier.
static class	CacheStorage.CachedResponse	Cached response
static class	CacheStorage.DataEntry	Data entry.
static class	CacheStorage.Header	[No Description Provided by Google]

Field Summary

CacheStorage Domain Enumerated String Types
Modifier and Type	Field
static String[]	CachedResponseType	type of HTTP response cached

Method Summary

CacheStorage Domain Commands
Script Returns	Modifier and Type	Method
NONE (void)	static Script<>	deleteCache(String cacheId) Deletes a cache.
NONE (void)	static Script<>	deleteEntry(String cacheId, String request) Deletes a cache entry.
CacheStorage.CachedResponse	static Script<>	requestCachedResponse(String cacheId, String requestURL, CacheStorage.Header[] requestHeaders) Fetches cache entry.
CacheStorage.Cache[]	static Script<>	requestCacheNames(String securityOrigin) Requests cache names.
Ret2<CacheStorage.DataEntry[], Number>	static Script<>	requestEntries(String cacheId, Integer skipCount, Integer pageSize, String pathFilter) Requests data from cache.

Methods inherited from class java.lang.Object

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

Field Detail

CachedResponseType

🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final java.lang.String[] CachedResponseType

type of HTTP response cached

Method Detail

deleteCache

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> deleteCache
            (java.lang.String cacheId)

Deletes a cache.

Parameters:

cacheId - Id of cache for deletion.

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.

deleteEntry

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret0> deleteEntry
            (java.lang.String cacheId,
             java.lang.String request)

Deletes a cache entry.

Parameters:

cacheId - Id of cache where the entry will be deleted.

request - URL spec of the request.

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.

requestCacheNames

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,CacheStorage.Cache[]> requestCacheNames
            (java.lang.String securityOrigin)

Requests cache names.

Parameters:

securityOrigin - Security origin.

Returns:

An instance of Script<String, JsonObject, CacheStorage.Cache[]>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, CacheStorage.Cache[]> 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

• CacheStorage.Cache[] (caches)
  Caches for the security origin.

requestCachedResponse

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,CacheStorage.CachedResponse> requestCachedResponse
            (java.lang.String cacheId,
             java.lang.String requestURL,
             CacheStorage.Header[] requestHeaders)

Fetches cache entry.

Parameters:

cacheId - Id of cache that contains the entry.

requestURL - URL spec of the request.

requestHeaders - headers of the request.

Returns:

An instance of Script<String, JsonObject, CacheStorage.CachedResponse>

This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, CacheStorage.CachedResponse> 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

• CacheStorage.CachedResponse (response)
  Response read from the cache.

requestEntries

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static Script<java.lang.String,JsonObject,Ret2<CacheStorage.DataEntry[],java.lang.Number>> requestEntries
            (java.lang.String cacheId,
             java.lang.Integer skipCount,
             java.lang.Integer pageSize,
             java.lang.String pathFilter)

Requests data from cache.

Parameters:

cacheId - ID of cache to get entries from.

skipCount - Number of records to skip.
OPTIONAL

pageSize - Number of records to fetch.
OPTIONAL

pathFilter - If present, only return the entries containing this substring in the path
OPTIONAL

Returns:

An instance of Script<String, JsonObject, Ret2>

This Script may be executed (using Script.exec()), and a Promise returned.

When the Promise is awaited (using Promise.await()), the Ret2 will subsequently be returned from that call.

The returned values are encapsulated in an instance of Ret2

• Ret2.a: CacheStorage.DataEntry[] (cacheDataEntries)
  Array of object store data entries.
  
  
• Ret2.b: Number (returnCount)
  Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.