org.openqa.selenium.chromium.ChromiumDriverCommandExecutor Maven / Gradle / Ivy

Go to download
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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.

package org.openqa.selenium.chromium;

import static java.util.Collections.unmodifiableMap;

import java.util.HashMap;
import java.util.Map;

import org.openqa.selenium.remote.CommandInfo;
import org.openqa.selenium.remote.http.HttpMethod;
import org.openqa.selenium.remote.service.DriverCommandExecutor;
import org.openqa.selenium.remote.service.DriverService;

/**
 * {@link DriverCommandExecutor} that understands ChromiumDriver specific commands.
 *
 * @see List of ChromeWebdriver commands
 */
public class ChromiumDriverCommandExecutor extends DriverCommandExecutor {

  private static Map buildChromiumCommandMappings(String vendorKeyword) {
    String sessionPrefix = "/session/:sessionId/";
    String chromiumPrefix = sessionPrefix + "chromium";
    String vendorPrefix = sessionPrefix + vendorKeyword;

    HashMap mappings = new HashMap<>();

    mappings.put(ChromiumDriverCommand.LAUNCH_APP,
      new CommandInfo(chromiumPrefix + "/launch_app", HttpMethod.POST));

    String networkConditions = chromiumPrefix + "/network_conditions";
    mappings.put(ChromiumDriverCommand.GET_NETWORK_CONDITIONS,
      new CommandInfo(networkConditions, HttpMethod.GET));
    mappings.put(ChromiumDriverCommand.SET_NETWORK_CONDITIONS,
      new CommandInfo(networkConditions, HttpMethod.POST));
    mappings.put(ChromiumDriverCommand.DELETE_NETWORK_CONDITIONS,
      new CommandInfo(networkConditions, HttpMethod.DELETE));

    mappings.put( ChromiumDriverCommand.EXECUTE_CDP_COMMAND,
      new CommandInfo(vendorPrefix + "/cdp/execute", HttpMethod.POST));

    // Cast / Media Router APIs
    String cast = vendorPrefix + "/cast";
    mappings.put(ChromiumDriverCommand.GET_CAST_SINKS,
      new CommandInfo(cast + "/get_sinks", HttpMethod.GET));
    mappings.put(ChromiumDriverCommand.SET_CAST_SINK_TO_USE,
      new CommandInfo(cast + "/set_sink_to_use", HttpMethod.POST));
    mappings.put(ChromiumDriverCommand.START_CAST_TAB_MIRRORING,
      new CommandInfo(cast + "/start_tab_mirroring", HttpMethod.POST));
    mappings.put(ChromiumDriverCommand.GET_CAST_ISSUE_MESSAGE,
      new CommandInfo(cast + "/get_issue_message", HttpMethod.GET));
    mappings.put(ChromiumDriverCommand.STOP_CASTING,
      new CommandInfo(cast + "/stop_casting", HttpMethod.POST));

    mappings.put(ChromiumDriverCommand.SET_PERMISSION,
      new CommandInfo(sessionPrefix + "/permissions", HttpMethod.POST));

    return unmodifiableMap(mappings);
  }

  public ChromiumDriverCommandExecutor(String vendorPrefix, DriverService service) {
    super(service, buildChromiumCommandMappings(vendorPrefix));
  }
}