ratpack.http.client.Proxy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ratpack-core Show documentation

null

There is a newer version: 2.0.0-rc-1

/*
 * Copyright 2019 the original author or authors.
 *
 * Licensed 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 ratpack.http.client;

import ratpack.api.Nullable;

import java.util.Collection;

/**
 * Configuration data for an HTTP proxy to utilize for outbound requests using {@link HttpClient}.
 *
 * @since 1.8.0
 */
public interface Proxy {

  enum ProxyProtocol {
    HTTP, HTTPS
  }

  /**
   * The protocol that should be used when connecting to the proxy server itself.
   *
   * @return the protocol to use to connect to the proxy server
   */
  ProxyProtocol getProtocol();

  /**
   * The host that proxied requests will be sent.
   *
   * @return The host that proxied requests will be sent.
   */
  String getHost();

  /**
   * The port on the proxy where proxied requests will be sent.
   *
   * @return The port on the proxy where proxied requests will be sent.
   */
  int getPort();

  /**
   * The credentials to use when connecting to the proxy.
   *
   * @return The credentials to use when connecting to the HTTP proxy, or null if authentication should not be used when connecting to the HTTP proxy.
   */
  @Nullable
  ProxyCredentials getCredentials();

  /**
   * A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.
   * 
   * The format of the values in this list follow the standard
   * Java Networking and Proxies standards.
   *
   * @return A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.
   */
  Collection getNonProxyHosts();
}