com.github.testsmith.cdt.services.ChromeService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
The newest version!
package com.github.testsmith.cdt.services;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2024 Kenan Klisura
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.github.testsmith.cdt.services.config.ChromeDevToolsServiceConfiguration;
import com.github.testsmith.cdt.services.exceptions.ChromeServiceException;
import com.github.testsmith.cdt.services.types.ChromeTab;
import com.github.testsmith.cdt.services.types.ChromeVersion;
import java.util.List;

/**
 * Chrome service definition.
 *
 * @author Kenan Klisura
 * @version $Id: $Id
 */
public interface ChromeService {
  /**
   * Gets the list of opened chrome tabs.
   *
   * @return List of chrome tabs.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException the chrome service
   *     exception
   */
  List getTabs() throws ChromeServiceException;

  /**
   * Creates a new chrome tab that points to about:blank
   *
   * @return Chrome tab.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException If creation fails
   *     for any reason.
   */
  ChromeTab createTab() throws ChromeServiceException;

  /**
   * Creates a new chrome tab.
   *
   * @param url the url
   * @return Created chrome tab.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException the chrome service
   *     exception
   */
  ChromeTab createTab(String url) throws ChromeServiceException;

  /**
   * Activates a tab.
   *
   * @param tab the tab
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException the chrome service
   *     exception
   */
  void activateTab(ChromeTab tab) throws ChromeServiceException;

  /**
   * Closes a chrome tab.
   *
   * @param ta the ta
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException the chrome service
   *     exception
   */
  void closeTab(ChromeTab ta) throws ChromeServiceException;

  /**
   * Gets the version info.
   *
   * @return Version info.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException If request fails
   *     for any reason.
   */
  ChromeVersion getVersion() throws ChromeServiceException;

  /**
   * Creates a dev tools service to specified tab.
   *
   * @param tab Tab.
   * @param chromeDevToolsServiceConfiguration Service configuration.
   * @return Dev tools.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException if any.
   */
  ChromeDevToolsService createDevToolsService(
      ChromeTab tab, ChromeDevToolsServiceConfiguration chromeDevToolsServiceConfiguration)
      throws ChromeServiceException;

  /**
   * Creates a dev tools service to specified tab with default service configuration.
   *
   * @param tab Tab.
   * @return Dev tools.
   * @throws com.github.testsmith.cdt.services.exceptions.ChromeServiceException if any.
   */
  ChromeDevToolsService createDevToolsService(ChromeTab tab) throws ChromeServiceException;
}