Package Torello.Browser

Allows a user to start up a headless browser, and use the API that it exports to manipulate the browser. Commands may be sent to the browser using any one of the Primary Domain classes provided in this package. The methods in each of these Primary Domains return results, and can also generate events that the user may receive. Each domain has a long list of events and types that may be used with these methods.

This API is entirely auto-generated Java Code that has been produced from the Headless Google Chrome API that Chrome provides. This API may be used Chrome, or with Interne Explorer which now also uses the same Chrome Engine in its browser core.

This package can also be used to drive / control a non-headless browser that is sitting, open, on your desktop.

Simple Examples
Java Entity	Description
Example01	An example of this package's utility
Example02	This example code saves a picture of the Sam Altman Web Page to disk
Example03	Demonstrates several CDP browser features without using JavaScript evaluation
Printing	Simple printer for the example classes in this package
Browser Web-Sockets
Java Entity	Description
BrowserConn	A Connection to a Browser, rather than an individual Page within the Browser
PageConn	A class which represents a connection to a particular Page or Tab that has been opened within the Browser, rather than a connection to the Browser itself
ConnRecord	Central record, log collector, and user-callback router for a CDP browser session
Promise<RESULT>	Primarily a wrapper around Java's CompletableFuture that provides two or three simplified methods for awaiting a promise
Script<RESULT>	The class script simply sends an asynchronous request, and returns an instance of Promise which may be awaited
WebSocketSender	This class implements a connection to a Web-Browser using the Remote Debug Protocol over Web-Sockets
Classes
Java Entity	Description
BaseType<DOMAIN_NESTED extends BaseType<DOMAIN_NESTED>>	This class is declared 'abstract' and serves as the root ancestor clas for all data record types & events in all domains in within the Chrome DevTools Protocol (CDP) API
BrowserEvent<DOMAIN_NESTED extends BrowserEvent<DOMAIN_NESTED>>	All events fired by the headless-browser extend this abstract class
MarkerEvent	Marker Events are events which the browser fires, and transmits over the Web-Socket Wall, that do not possess any data or state whatsoever
BrowserError	Represents an Error Sent by the Chrome Browser over WebSocket
RDPError	Represents an Internal Java-Side Failure During WebSocket Communication
ReadAPI
Advanced Builder Classes
Java Entity	Description
AbstractDescriptor	Serves as the parent class for both NestedDescriptor and CommandDescriptor
CommandDescriptor<T>	Reflected information / data which has been extracted from one of the generated CDP domain command methods
NestedDescriptor<DOMAIN_NESTED extends BaseType<DOMAIN_NESTED>>	Reflected information / data which has been extracted from one of the nested CDP types declared inside a generated domain class
AbstractBuilder<T>	An abstract base class for builder-style objects that collect named assignments before producing a final CDP-related object
CommandBuilder<T>	A 'Builder' software design pattern that may be used to construct Script instances for CDP browser commands whose method signatures contain long lists of input parameters
TypeBuilder<CDP_TYPE extends BaseType<CDP_TYPE>>	A 'Builder' software design pattern that may be used to construct instances of any of the nested domain types & classes in CDP
Internal Use & Reference
Java Entity	Description
CDPToString	Converts Chrome DevTools Protocol data objects and builders into readable diagnostic text
CDPTypes	💡 Primarily, this class is used by the Code Generator to produce the classes that comprise the Java Browser-Automation Library
HandleDispatch	Top level dispatch handler for all messages received from the browser, via websocket
NestedHelper<DOMAIN_NESTED extends BaseType<DOMAIN_NESTED>>	Defines the singleton helper contract that supplies metadata, validation, and JSON conversion logic for a nested CDP type, event, or command-return class
NumberCrap	Yes, this is a great name for a class
WriteJSON	Generates JSON Requests from lists of Parameter-Names, Parameter-Types and Parameter-Values
Enums
Java Entity	Description
Domains	A simple way of representing the various Browser Domains offered by the Remote Browser
Exceptions
Java Entity	Description
AsynchronousException	A general purpose exception used to indicate there have been problems with an asynchronous communications system or channel
BrowserErrorException
BrowserException
RDPException	Internally used exception for any unexpected problems with the Web-Sockets Protocol
UnknownPropertyException	If an attempt is made to look up the array index of a type or event class field which is does not exist in the nested type, then this exception shall throw
UncheckedExecutionException	Convert Java's ExecutionException into an unchecked RuntimeException
UncheckedTimeoutException	Convert Java's TimeoutException into an unchecked RuntimeException
UncheckedInterruptedException	Convert Java's InterruptedException into an unchecked RuntimeException
DataIntegrityException	Abstract ancestor exception class for exceptions which check the integrity of instances of both CDP types and CDP events
InvalidEnumStrException	Used to indicate that a field within a CDP type or event has been constructed is a string field, and has a pre-defined & pre-specified enumeration of valid strings, but whose value does not actually equal one of the listed, pre-defined strings
NullNonOptionalException	This exception is thrown by the BaseType
TypeAssignmentException	Thrown by AbstractBuilder when a programmer attempts to assign a value using a Java type that is incompatible with the builder property's expected type
AssignmentNameException	This exception throws if, when building a CDP instance with the 'advanced' TypeBuilder class, but a unknown field name has been passed by the user
Errors
Java Entity	Description
InvalidNumberTypeError	Error used to indicate that an internal problem involving JSON number conversion from Java into JSON has occured
UnknownWebSocketsError	An issue with the Web-Sockets Transport Layer has occured
UnrecognizedCTABError	Indicates that a class has received a Java 'byte' which isn't among the recognized "Computed Type as Byte" constant values, as listed within static-constant class CDPTypes
UnrecognizedCTASError	Indicates that the class CDPTypes has received a Java String which isn't among the recognized "Computed Type as String" types