Package Torello.Browser.BrowserAPI
Class SystemInfo
- java.lang.Object
-
- Torello.Browser.BrowserAPI.SystemInfo
-
public class SystemInfo extends java.lang.Object
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.
These files were converted into this Java-Browser (CDP) Library. The intention is to have them function in a similar fasion to the Node.js Tool known as 'Puppeteer', Microsoft's 'Playwright' and of course the Main-Stay 'Selenium.' The Java-HTML JAR Library merely implements the Java Types & Commands defined by Google's DevTools Protocol.
🧠View the Google CDP API:
The SystemInfo domain defines methods and events for querying low-level system information.
The top-level description and explanation for this class (this comment, at the top this Java-Doc Page) is repeated, verbatim, across all of the domain classes which comprise Google's CDP API.This class is intended to be used with a Browser Instance
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 aRemote Debugging Port. Google-Corporation is the developer of this API, but any browser which accepts a Remote Debug Port Connection over Web-Sockets.
Google-Chrome was used during the development process of the classes in this particular package. Lately, it has been asserted Microsoft has switched to using the Chrome Browser-Engine for its Microsoft Edge Internal Code-Base. Therefore, there may some functionality available when running the methods in this class with Microsoft-Edge.
Check whether the your Web-Browser will allow itself to be driven by theWeb-Socket RDP-Port 9223. See the examples available in packageTorello.Browserto undertand how to build aPageConnandBrowserConnWeb-Socket Connection, and how to build aWebSocketSenderinstance in order to execute the methods in this class.
Web-Socket & JSON API:
Every one of the methods that reside in this class are designed to do nothing more than:- Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
- Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket Connection
- Receive BOTH that Command-Results AND any Browser Event-Firings from the Web-Socket
- Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
- Report these Method-Results and Browser-Events to the User via a User-Registered, Event-Listener (Events) or a Promise Object (Command Responses / Results)
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".
Asking Chat-GPT for Help:
The LLM otherwise known as "Chat-GPT" does, indeed, have an expert level of knowledge about the "Remote DevTools Protocol". The API that theChrome DevTools Protocl (CDP)exports is extremely well understood by the LLM, and generally I have found that Chat-GPT understands (by 2 or 3 orders of magnitude) better what my Auto-Generated JSON-Wrappers can do in controlling a Web-Browser than I could ever possibly hope to understand.
Though not available today, there will soon be an automatically downloadable Token-Stream (AI Embeddings) BUTTON available on my Java-Doc Pages that should hopefully make it extremely easy to post my code-base, RAG Style, to Chat-GPT and other LLM's when 'interogating' them. Presently, because my "Get Token Stream Button" does not exist yet on any of my pages, what you can do is copy-and-paste any Method-Signature from any one of these pages and then ask Chat-GPT to explain what that Browser or Java-Script Function is actually doing. It is very likely to give you some pretty neat answers.
I have found that every single one of the Domains, Types & Events which are offered by the CDP Protocol (though not documented very well by Google), are perfectly understood by the A.I. LLM - literally to the point where it does know (much better than I ever could) what my own code base actually does!
Try it out, it's a lot of fun. Note that this package and these classes were originally developed solely to be able to execute the Java-Script that a browser executes when visiting a Web-Site. Complete HTML-Page Content can be scraped (using the HTML Data-Scraping Tools in Java-HTML) off of Web-Sites that have dynamic / Java-Script Generated Content.
Conspicuous Boxed-Types Usage:
You may notice that there are many methods that have parameters which accept, for instance, anInteger, instead of a primitiveint. Just to remind the readiner, in Java Programs aBoxed Typeis a standard Java-Primitive which has been converted into an Object-Reference. The use of Boxed-Types in this code base is an easy-and-fast-way to allow for the concept of "Optional Parameters" or "Optional Field Value."
Whenever you see a method that accepts anInteger, the reason for this Parameter-Type choice is actually to allow a user to pass 'null' to it. This is a simple way to ELIDE passing any value at all to parameters which Google-Chrome would otherwise assert are "Optional." Whenever you pass 'null' to a Boxed-Types in this class, the Json-Processor will simply eliminate that Object-Property from the command altogether; and the browser will simply not receive any value for that parameter when that command is invoked.
The Java Language Specification does not have an easy or well defined means of accepting optional method parameters; so Boxed-Types and 'null' are utilized here. Note that 'null' may be passed to any Command Method-Parameter that is listed asOptionalon the Java-Doc Page description for that parameter.
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/SystemInfo.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/SystemInfo.java
File Size: 27,741 Bytes Line Count: 681 '\n' Characters Found
Helper: Command Invocation Helpers
- View Here: SystemInfo$$Commands.java
- Open New Browser-Tab: SystemInfo$$Commands.java
File Size: 1,469 Bytes Line Count: 41 '\n' Characters Found
Stateless Class:This class neither contains any program-state, nor can it be instantiated. The@StaticFunctionalAnnotation may also be called 'The Spaghetti Report'.Static-Functionalclasses are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's@StatelessAnnotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 3 Method(s), 3 declared static
- 2 Field(s), 2 declared static, 2 declared final
-
-
Nested Class Summary
Type Nested Classes: Types / Classes that Are Used & Exported by this Domain Modifier and Type Class Description static classSystemInfo.GPUDeviceDescribes a single graphics processor (GPU).static classSystemInfo.GPUInfoProvides information about the GPU(s) on the system.static classSystemInfo.ImageDecodeAcceleratorCapabilityDescribes a supported image decoding profile with its associated minimum and maximum resolutions and subsampling.static classSystemInfo.ProcessInfoRepresents process info.static classSystemInfo.SizeDescribes the width and height dimensions of an entity.static classSystemInfo.VideoDecodeAcceleratorCapabilityDescribes a supported video decoding profile with its associated minimum and maximum resolutions.static classSystemInfo.VideoEncodeAcceleratorCapabilityDescribes a supported video encoding profile with its associated maximum resolution and maximum framerate.Command-Returns Nested Classes: Domain-Commands with Multiple Return-Values, and a Dedicated Inner-Class Modifier and Type Class Description static classSystemInfo.getInfo$$RETReturns information about the system.
-
Field Summary
Enumerated Strings: Like Java 'enum' Types, but Converted to Read-Only String-Lists Modifier and Type Field Description static ReadOnlyList<String>ImageTypeImage format of a given image.static ReadOnlyList<String>SubsamplingFormatYUV subsampling type of the pixels of a given image.
-
Method Summary
SystemInfo Domain Commands Script Returns Modifier and Type Method Booleanstatic Script<>getFeatureState(String featureState)
Returns information about the feature state.SystemInfo.getInfo$$RETstatic Script<>getInfo()
Returns information about the system.SystemInfo.ProcessInfo[]static Script<>getProcessInfo()
Returns information about all running processes.
-
-
-
Field Detail
-
ImageType
public static final ReadOnlyList<java.lang.String> ImageType
Image format of a given image.
String-Enumeration Type
-
SubsamplingFormat
public static final ReadOnlyList<java.lang.String> SubsamplingFormat
YUV subsampling type of the pixels of a given image.
String-Enumeration Type
-
-
Method Detail
-
getFeatureState
public static Script<java.lang.Boolean> getFeatureState (java.lang.String featureState)
Returns information about the feature state.- Parameters:
featureState- -- Returns:
- An instance of
Script<Boolean>
This script may be executed, usingScript.exec, and afterwards, aPromise<Boolean>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Boolean (featureEnabled)
-
getInfo
public static Script<SystemInfo.getInfo$$RET> getInfo()
Returns information about the system.- Returns:
- An instance of
Script<SystemInfo.getInfo$$RET>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedSystemInfo.getInfo$$RET>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:SystemInfo.getInfo$$RETA dedicated return type implies that the browser may return more than 1 datum
-
getProcessInfo
public static Script<SystemInfo.ProcessInfo[]> getProcessInfo()
Returns information about all running processes.- Returns:
- An instance of
Script<SystemInfo.ProcessInfo[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedSystemInfo.ProcessInfo[]>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:SystemInfo.ProcessInfo[] (processInfo)
An array of process info blocks.
-
-