org.openqa.selenium.grid.server.BaseServerOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-grid 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.26.0
// 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.grid.server;

import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Optional;
import java.util.logging.Logger;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.grid.config.Config;
import org.openqa.selenium.grid.config.ConfigException;
import org.openqa.selenium.grid.jmx.JMXHelper;
import org.openqa.selenium.grid.jmx.ManagedAttribute;
import org.openqa.selenium.grid.jmx.ManagedService;
import org.openqa.selenium.net.HostIdentifier;
import org.openqa.selenium.net.NetworkUtils;
import org.openqa.selenium.net.PortProber;

@ManagedService(
    objectName = "org.seleniumhq.grid:type=Config,name=BaseServerConfig",
    description = "Server config")
public class BaseServerOptions {

  private static final String SERVER_SECTION = "server";

  private static final Logger LOG = Logger.getLogger(BaseServerOptions.class.getName());
  private final Config config;
  private int port = -1;

  public BaseServerOptions(Config config) {
    this.config = config;
    new JMXHelper().register(this);
  }

  public Optional getHostname() {
    return config.get(SERVER_SECTION, "host");
  }

  @ManagedAttribute(name = "Port")
  public int getPort() {
    if (port == -1) {
      int newPort = config.getInt(SERVER_SECTION, "port").orElseGet(PortProber::findFreePort);
      if (newPort == -1) {
        newPort = PortProber.findFreePort();
      }
      if (newPort < 0) {
        throw new ConfigException("Port cannot be less than 0: " + port);
      }

      port = newPort;
    }
    return port;
  }

  @ManagedAttribute(name = "MaxServerThreads")
  public int getMaxServerThreads() {
    int count =
        config
            .getInt(SERVER_SECTION, "max-threads")
            .orElse(Runtime.getRuntime().availableProcessors() * 3);

    if (count < 0) {
      throw new ConfigException("Maximum number of server threads cannot be less than 0: " + count);
    }

    return count;
  }

  @ManagedAttribute(name = "Uri")
  public URI getExternalUri() {
    // Assume the host given is addressable if it's been set
    String host =
        getHostname()
            .orElseGet(
                () -> {
                  try {
                    return new NetworkUtils().getNonLoopbackAddressOfThisMachine();
                  } catch (WebDriverException e) {
                    String name = HostIdentifier.getHostName();
                    LOG.info("No network connection, guessing name: " + name);
                    return name;
                  }
                });

    int port = getPort();

    try {
      return new URI(
          (isSecure() || isSelfSigned()) ? "https" : "http", null, host, port, null, null, null);
    } catch (URISyntaxException e) {
      throw new ConfigException("Cannot determine external URI: " + e.getMessage());
    }
  }

  public boolean getAllowCORS() {
    return config.getBool(SERVER_SECTION, "allow-cors").orElse(false);
  }

  public boolean getBindHost() {
    return config.getBool(SERVER_SECTION, "bind-host").orElse(true);
  }

  public boolean isSecure() {
    return config.get(SERVER_SECTION, "https-private-key").isPresent()
        && config.get(SERVER_SECTION, "https-certificate").isPresent();
  }

  public File getPrivateKey() {
    String privateKey = config.get(SERVER_SECTION, "https-private-key").orElse(null);
    if (privateKey != null) {
      return new File(privateKey);
    }
    throw new ConfigException(
        "Please provide a private key via --https-private-key " + "when using --https");
  }

  public File getCertificate() {
    String certificatePath = config.get(SERVER_SECTION, "https-certificate").orElse(null);
    if (certificatePath != null) {
      return new File(certificatePath);
    }
    throw new ConfigException(
        "Please provide a certificate via --https-certificate " + "when using --https");
  }

  public boolean isSelfSigned() {
    return config.getBool(SERVER_SECTION, "https-self-signed").orElse(false);
  }
}