Package com.teamdev.jxbrowser.profile

Interface Profile

public interface Profile
A profile allows keeping all browser info separately, like history, proxy settings, spellchecker configurations.

For working with this info each profile provides different services such as plugins, spellchecker configurations, cookie store, etc.

Profiles are managed by the separate engine service.

The default profile is initialized when the engine is created. It can not be removed.

Any attempt to use an already removed profile or profile whose engine is closed will lead to the IllegalStateException.

  • Method Details

    • engine

      Engine engine()
      Returns the engine for this profile.

    • newBrowser

      Browser newBrowser()
      Creates a new Browser instance under this profile and navigates it to the "about:blank" web page within the Navigation.defaultTimeout().
      Returns:
      a new Browser instance
      Throws:
      TimeoutException - if the engine failed to create a browser instance within the timeout
      NavigationException - if the navigation to the "about:blank" has failed
      ObjectClosedException - if the profile is deleted or its engine is closed

    • browsers

      List<Browser> browsers()
      Returns an immutable list of alive Browser instances including child popup browsers for this profile or an empty list if the profile does not have any alive Browser.

    • path

      String path()
      Returns a system path to the folder with the profiles`s info.
      Throws:
      ObjectClosedException - if the profile is deleted or its engine is closed

    • isIncognito

      boolean isIncognito()
      Returns true if this profile is in incognito mode.
      Throws:
      ObjectClosedException - if the profile is deleted or its engine is closed

    • isDefault

      boolean isDefault()
      Returns true if this profile is default.
      Throws:
      ObjectClosedException - if the profile is deleted or its engine is closed

    • name

      String name()
      Returns a name of this profile.
      Throws:
      ObjectClosedException - if the profile is deleted or its engine is closed

    • zoomLevels

      ZoomLevels zoomLevels()
      Returns a service that allows working with zoom.

    • plugins

      Plugins plugins()
      Returns a service that allows configuring plugins.

    • proxy

      Proxy proxy()
      Returns a service that allows working with proxy.

    • extensions

      Extensions extensions()
      Returns a service for working with extensions.
      Since:
      8.0.0

    • network

      Network network()
      Returns a service that allows working with network.

    • spellChecker

      SpellChecker spellChecker()
      Returns a service that allows working with spell checking functionality.

    • cookieStore

      CookieStore cookieStore()
      Returns the cookie store that allows managing cookies.

    • passwordStore

      PasswordStore passwordStore()
      Returns a service for working with the password store.
      Since:
      7.20

    • httpCache

      HttpCache httpCache()
      Returns a service for working with HTTP cache.

    • httpAuthCache

      HttpAuthCache httpAuthCache()
      Returns a service for working with HTTP authentication cache.

    • downloads

      Downloads downloads()
      Returns a service that allows managing downloads.

    • permissions

      Permissions permissions()
      Returns a service that allows managing permissions.

    • preferences

      ProfilePreferences preferences()
      Returns the preferences for this profile.
      Since:
      7.20

    • userDataProfiles

      UserDataProfiles userDataProfiles()
      Returns a service that allows managing the user data profiles. The stored user data profiles can be used during web form autofill.
      Since:
      7.23

    • creditCards

      CreditCards creditCards()
      Returns a service that allows managing credit cards. The stored credit cards can be used during web form autofill.
      Since:
      7.23

    • mediaCasting

      MediaCasting mediaCasting()
      Returns a service that provides access to all the required media casting services.
      Since:
      7.29