org.openqa.selenium.remote.http.okhttp.OkHttpClient Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-remote-driver 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.19.1

Show 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.remote.http.okhttp;

import com.google.auto.service.AutoService;

import okhttp3.ConnectionPool;

import org.openqa.selenium.internal.Require;
import org.openqa.selenium.remote.http.ClientConfig;
import org.openqa.selenium.remote.http.Filter;
import org.openqa.selenium.remote.http.HttpClient;
import org.openqa.selenium.remote.http.HttpClientName;
import org.openqa.selenium.remote.http.HttpHandler;
import org.openqa.selenium.remote.http.HttpRequest;
import org.openqa.selenium.remote.http.HttpResponse;
import org.openqa.selenium.remote.http.WebSocket;

import java.util.function.BiFunction;

/**
 * @deprecated We're switching to Netty.
 * Please use {@link org.openqa.selenium.remote.http.netty.NettyClient} instead.
 */
@Deprecated
public class OkHttpClient implements HttpClient {

  private final HttpHandler handler;
  private BiFunction toWebSocket;

  private OkHttpClient(HttpHandler handler, BiFunction toWebSocket) {
    this.handler = Require.nonNull("Handler", handler);
    this.toWebSocket = Require.nonNull("WebSocket creation function", toWebSocket);
  }

  @Override
  public HttpResponse execute(HttpRequest request) {
    return handler.execute(request);
  }

  @Override
  public WebSocket openSocket(HttpRequest request, WebSocket.Listener listener) {
    Require.nonNull("Request to send", request);
    Require.nonNull("WebSocket listener", listener);

    return toWebSocket.apply(request, listener);
  }

  @Override
  public HttpClient with(Filter filter) {
    Require.nonNull("Filter", filter);

    // TODO: We should probably ensure that websocket requests are run through the filter.
    return new OkHttpClient(handler.with(filter), toWebSocket);
  }

  @AutoService(HttpClient.Factory.class)
  @HttpClientName("okhttp")
  public static class Factory implements HttpClient.Factory {

    private final ConnectionPool pool = new ConnectionPool();

    @Override
    public HttpClient createClient(ClientConfig config) {
      Require.nonNull("Client config", config);

      return new OkHttpClient(new OkHandler(config).with(config.filter()), OkHttpWebSocket.create(config));
    }

    @Override
    public void cleanupIdleClients() {
      pool.evictAll();
    }
  }
}