org.openqa.grid.common.SeleniumProtocol Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-server Show documentation

Selenium automates browsers. That's it! What you do with that power is entirely up to you.

There is a newer version: 4.0.0-alpha-2

// 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.grid.common;

import static org.openqa.grid.common.RegistrationRequest.PATH;
import static org.openqa.grid.common.RegistrationRequest.SELENIUM_PROTOCOL;

import org.openqa.grid.common.exception.GridException;

import java.util.Arrays;
import java.util.Map;

public enum SeleniumProtocol {
  Selenium("/selenium-server/driver"),
  WebDriver("/wd/hub");
  private String path;

  SeleniumProtocol(String path) {
    this.path = path;
  }

  /**
   * Get the protocol considering the capabilities provided which may define the property
   * {@link RegistrationRequest#SELENIUM_PROTOCOL}
   *
   * @param capabilities map of capabilities to consider
   * @return the {@link SeleniumProtocol} or throws a {@link GridException} if the capabilities
   * does not define a recognized protocol.
   */
  public static SeleniumProtocol fromCapabilitiesMap(Map capabilities) {
    String type = (String) capabilities.get(SELENIUM_PROTOCOL);
    if (type == null || type.trim().isEmpty()) {
      return WebDriver;
    }
    try {
      return SeleniumProtocol.valueOf(type);
    } catch (IllegalArgumentException e) {
      throw new GridException(type + " isn't a valid protocol type for grid. Valid values :[" +
                              Arrays.toString(values()) + "]", e);
    }
  }

  /**
   * Get the protocol path considering the capabilities provided which may define a new
   * path via the property {@link RegistrationRequest#PATH}
   *
   * @param capabilities map of capabilities to consider
   * @return the protocol path defined by the capabilities or the value of {@link #getPath}.
   */
  public String getPathConsideringCapabilitiesMap(Map capabilities) {
    String localPath = (String) capabilities.get(PATH);
    if (localPath != null) {
      return localPath;
    }
    return path;
  }

  /**
   * Get the protocol path
   *
   * @return the protocol path
   */
  public String getPath() {
    return path;
  }

  /**
   * @deprecated use {@link SeleniumProtocol#Selenium#equals(Object)}
   */
  @Deprecated
  public boolean isSelenium() {
    return Selenium.equals(this);
  }
}