org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueFlags 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.
The newest version!
// 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.sessionqueue.config;

import static org.openqa.selenium.grid.config.StandardGridRoles.SESSION_QUEUE_ROLE;
import static org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueOptions.DEFAULT_BATCH_SIZE;
import static org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueOptions.DEFAULT_REQUEST_TIMEOUT;
import static org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueOptions.DEFAULT_REQUEST_TIMEOUT_PERIOD;
import static org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueOptions.DEFAULT_RETRY_INTERVAL;
import static org.openqa.selenium.grid.sessionqueue.config.NewSessionQueueOptions.SESSION_QUEUE_SECTION;

import com.beust.jcommander.Parameter;
import com.google.auto.service.AutoService;
import java.net.URI;
import java.util.Collections;
import java.util.Set;
import org.openqa.selenium.grid.config.ConfigValue;
import org.openqa.selenium.grid.config.HasRoles;
import org.openqa.selenium.grid.config.Role;

@SuppressWarnings("FieldMayBeFinal")
@AutoService(HasRoles.class)
public class NewSessionQueueFlags implements HasRoles {

  @Parameter(
      names = {"--sq", "--sessionqueue"},
      description = "Address of the session queue server.")
  @ConfigValue(section = "sessionqueue", name = "host", example = "\"http://localhost:1237\"")
  private URI sessionQueueServer;

  @Parameter(
      names = "--sessionqueue-port",
      description = "Port on which the session queue server is listening.")
  @ConfigValue(section = "sessionqueue", name = "port", example = "1234")
  private Integer sessionQueueServerPort;

  @Parameter(
      names = "--sessionqueue-host",
      description = "Host on which the session queue server is listening.")
  @ConfigValue(section = "sessionqueue", name = "hostname", example = "\"localhost\"")
  private String sessionQueueServerHost;

  @Parameter(
      names = {"--session-request-timeout"},
      description =
          "Timeout in seconds. New incoming session request is added to the queue. "
              + "Requests sitting in the queue for longer than the configured time will timeout.")
  @ConfigValue(section = SESSION_QUEUE_SECTION, name = "session-request-timeout", example = "5")
  private int sessionRequestTimeout = DEFAULT_REQUEST_TIMEOUT;

  @Parameter(
      names = {"--session-request-timeout-period"},
      description = "In seconds, how often the timeout for new session requests is checked.")
  @ConfigValue(
      section = SESSION_QUEUE_SECTION,
      name = "session-request-timeout-period",
      example = "5")
  private int sessionRequestTimeoutPeriod = DEFAULT_REQUEST_TIMEOUT_PERIOD;

  @Parameter(
      names = {"--session-retry-interval"},
      description =
          "Session creation interval in milliseconds. If all slots are busy, new session "
              + "request will be retried after the given interval.")
  @ConfigValue(section = SESSION_QUEUE_SECTION, name = "session-retry-interval", example = "15")
  private int sessionRetryInterval = DEFAULT_RETRY_INTERVAL;

  @Parameter(
      names = {"--sessionqueue-batch-size"},
      description = "Maximum batch size that can consumed from queue based on the available slots.")
  @ConfigValue(section = SESSION_QUEUE_SECTION, name = "sessionqueue-batch-size", example = "20")
  private int batchSize = DEFAULT_BATCH_SIZE;

  @Override
  public Set getRoles() {
    return Collections.singleton(SESSION_QUEUE_ROLE);
  }
}