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

Go to download

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.selenium.grid.server;

import org.openqa.selenium.grid.component.HasLifecycle;
import org.openqa.selenium.grid.web.CommandHandler;
import org.openqa.selenium.grid.web.Route;
import org.openqa.selenium.grid.web.Routes;

import java.net.URL;
import java.util.Objects;

import javax.servlet.Servlet;

public interface Server extends HasLifecycle {

  boolean isStarted();

  /**
   * Until we can migrate to {@link CommandHandler}s for everything, we leave this escape hatch.
   *
   * @deprecated
   */
  @Deprecated
  void addServlet(Class servlet, String pathSpec);

  /**
   * Until we can migrate to {@link CommandHandler}s for everything, we leave this escape hatch.
   *
   * @deprecated
   */
  @Deprecated
  void addServlet(Servlet servlet, String pathSpec);

  void addRoute(Routes route);

  default void addRoute(Route route) {
    Objects.requireNonNull(route, "Route must not be null");
    addRoute(route.build());
  }

  URL getUrl();
}