Class Browser

  • public class Browser
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 Browser domain defines methods and events for browser managing.

    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 a Remote 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 the Web-Socket RDP-Port 9223. See the examples available in package Torello.Browser to undertand how to build a PageConn and BrowserConn Web-Socket Connection, and how to build a WebSocketSender instance 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:

    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 Connection
    3. Receive BOTH that Command-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 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 the Chrome 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, an Integer, instead of a primitive int. Just to remind the readiner, in Java Programs a Boxed Type is 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 an Integer, 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 as Optional on the Java-Doc Page description for that parameter.



    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
    • 20 Method(s), 20 declared static
    • 7 Field(s), 7 declared static, 7 declared final


    • Field Detail

      • BrowserContextID

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String BrowserContextID
        [No Description Provided by Google]
        EXPERIMENTAL

        The Type BrowserContextID has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simple String Constant, for documentation & reference purposes only.

        The code which is generated which employs this type replaces its use with the Standard Java-Type: String

        Eliminated Type
        See Also:
        Constant Field Values

      • WindowID

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String WindowID
        [No Description Provided by Google]
        EXPERIMENTAL

        The Type WindowID has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simple String Constant, for documentation & reference purposes only.

        The code which is generated which employs this type replaces its use with the Standard Java-Type: int

        Eliminated Type
        See Also:
        Constant Field Values

    • Method Detail

      • addPrivacySandboxCoordinatorKeyConfig

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> addPrivacySandboxCoordinatorKeyConfig​
            (java.lang.String api,
             java.lang.String coordinatorOrigin,
             java.lang.String keyConfig,
             java.lang.String browserContextId)
        Configures encryption keys used with a given privacy sandbox API to talk to a trusted coordinator. Since this is intended for test automation only, coordinatorOrigin must be a .test domain. No existing coordinator configuration for the origin may exist.
        Parameters:
        api - -
        coordinatorOrigin - -
        keyConfig - -
        browserContextId - BrowserContext to perform the action in. When omitted, default browser context is used.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • addPrivacySandboxEnrollmentOverride

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> addPrivacySandboxEnrollmentOverride​
            (java.lang.String url)
        Allows a site to use privacy sandbox features that require enrollment without the site actually being enrolled. Only supported on page targets.
        Parameters:
        url - -
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • cancelDownload

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> cancelDownload​
            (java.lang.String guid,
             java.lang.String browserContextId)
        Cancel a download if in progress
        EXPERIMENTAL
        Parameters:
        guid - Global unique identifier of the download.
        browserContextId - BrowserContext to perform the action in. When omitted, default browser context is used.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • close

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> close()
        Close browser gracefully.
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • crash

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> crash()
        Crashes browser on the main thread.
        EXPERIMENTAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • crashGpuProcess

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> crashGpuProcess()
        Crashes GPU process.
        EXPERIMENTAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • executeBrowserCommand

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> executeBrowserCommand​
            (java.lang.String commandId)
        Invoke custom browser commands used by telemetry.
        EXPERIMENTAL
        Parameters:
        commandId - -
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • getBrowserCommandLine

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String[]> getBrowserCommandLine()
        Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.
        EXPERIMENTAL
        Returns:
        An instance of Script<String[]>

        This script may be executed, using Script.exec, and afterwards, a Promise <String[]> will be returned

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may be retrieved.

        This Browser Function's Promise returns: String[] (arguments)
        Commandline parameters

      • getHistograms

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<Browser.Histogram[]> getHistograms​
            (java.lang.String query,
             java.lang.Boolean delta)
        Get Chrome histograms.
        EXPERIMENTAL
        Parameters:
        query - Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
        OPTIONAL
        delta - If true, retrieve delta since last delta call.
        OPTIONAL
        Returns:
        An instance of Script<Browser.Histogram[]>

        This script may be executed, using Script.exec, and afterwards, a Promise <Browser.Histogram[]> will be returned

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may be retrieved.

        This Browser Function's Promise returns: Browser.Histogram[] (histograms)
        Histograms.

      • grantPermissions

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> grantPermissions​
            (java.lang.String[] permissions,
             java.lang.String origin,
             java.lang.String browserContextId)
        Grant specific permissions to the given origin and reject all others.
        EXPERIMENTAL
        Parameters:
        permissions - -
        origin - Origin the permission applies to, all origins if not specified.
        OPTIONAL
        browserContextId - BrowserContext to override permissions. When omitted, default browser context is used.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • resetPermissions

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> resetPermissions​
            (java.lang.String browserContextId)
        Reset all permission management for all origins.
        Parameters:
        browserContextId - BrowserContext to reset permissions. When omitted, default browser context is used.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • setContentsSize

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> setContentsSize​
            (int windowId,
             java.lang.Integer width,
             java.lang.Integer height)
        Set size of the browser contents resizing browser window as necessary.
        EXPERIMENTAL
        Parameters:
        windowId - Browser window id.
        width - The window contents width in DIP. Assumes current width if omitted. Must be specified if 'height' is omitted.
        OPTIONAL
        height - The window contents height in DIP. Assumes current height if omitted. Must be specified if 'width' is omitted.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • setDockTile

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> setDockTile​
            (java.lang.String badgeLabel,
             java.lang.String image)
        Set dock tile details, platform-specific.
        EXPERIMENTAL
        Parameters:
        badgeLabel - -
        OPTIONAL
        image - Png encoded image. (Encoded as a base64 string when passed over JSON)
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • setDownloadBehavior

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> setDownloadBehavior​
            (java.lang.String behavior,
             java.lang.String browserContextId,
             java.lang.String downloadPath,
             java.lang.Boolean eventsEnabled)
        Set the behavior when downloading a file.
        EXPERIMENTAL
        Parameters:
        behavior - Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). |allowAndName| allows download and names files according to their download guids.
        Acceptable Values: ["allow", "allowAndName", "default", "deny"]
        browserContextId - BrowserContext to set download behavior. When omitted, default browser context is used.
        OPTIONAL
        downloadPath - The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.
        OPTIONAL
        eventsEnabled - Whether to emit download events (defaults to false).
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • setPermission

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> setPermission​
            (Browser.PermissionDescriptor permission,
             java.lang.String setting,
             java.lang.String origin,
             java.lang.String browserContextId)
        Set permission settings for given origin.
        EXPERIMENTAL
        Parameters:
        permission - Descriptor of permission to override.
        setting - Setting of the permission.
        origin - Origin the permission applies to, all origins if not specified.
        OPTIONAL
        browserContextId - Context to override. When omitted, default browser context is used.
        OPTIONAL
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.

      • setWindowBounds

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.Void> setWindowBounds​(int windowId,
                                                     Browser.Bounds bounds)
        Set position and/or size of the browser window.
        EXPERIMENTAL
        Parameters:
        windowId - Browser window id.
        bounds - New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
        Returns:
        An instance of Script<Void>

        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<Void> to ensure that the Browser Function has run to completion.