com.netflix.spectator.ipc.http.HttpClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spectator-ext-ipc Show documentation
spectator-ext-ipc
There is a newer version: 1.8.2
/*
 * Copyright 2014-2019 Netflix, Inc.
 *
 * 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 com.netflix.spectator.ipc.http;

import com.netflix.spectator.api.Registry;
import com.netflix.spectator.api.Spectator;
import com.netflix.spectator.ipc.IpcLogger;
import org.slf4j.LoggerFactory;

import java.net.URI;

/**
 * Simple blocking http client using {@link IpcLogger} and {@link java.net.HttpURLConnection}.
 * This can be used as an example of the logging or for light use-cases where it is more desirable
 * not to have dependencies on a more robust HTTP library. Usage:
 *
 *  * HttpClient client = HttpClient.DEFAULT_CLIENT;
 * HttpResponse response = client.get(URI.create("http://example.com")).send();
 * 
 *
 * For testing an alternative client implementation can be used to customize the
 * send. For example to create a client that will always fail:
 *
 *  * HttpClient client = (n, u) -> new HttpRequestBuilder(n, u) {
 *   {@literal @}Override protected HttpResponse sendImpl() throws IOException {
 *     throw new ConnectException("could not connect to " + u.getHost());
 *   }
 * };
 * 
 */
public interface HttpClient {

  /**
   * Default {@link IpcLogger} instance. It will report metrics to
   * {@link Spectator#globalRegistry()}.
   */
  IpcLogger DEFAULT_LOGGER = new IpcLogger(
      Spectator.globalRegistry(),
      LoggerFactory.getLogger(HttpClient.class));

  /**
   * Default client instance that can be used in static contexts where it is not
   * possible to inject the {@link IpcLogger} instance. It will use {@link #DEFAULT_LOGGER}.
   */
  HttpClient DEFAULT_CLIENT = create(DEFAULT_LOGGER);

  /**
   * Create a new client instance.
   *
   * @param registry
   *     Registry to use for reporting metrics.
   * @return
   *     Client instance based on {@link java.net.HttpURLConnection}.
   */
  static HttpClient create(Registry registry) {
    return create(new IpcLogger(registry, LoggerFactory.getLogger(HttpClient.class)));
  }

  /**
   * Create a new client instance.
   *
   * @param logger
   *     Logger instance for recording metrics and providing an access log.
   * @return
   *     Client instance based on {@link java.net.HttpURLConnection}.
   */
  static HttpClient create(IpcLogger logger) {
    return uri -> new HttpRequestBuilder(logger, uri);
  }

  /**
   * Create a new request builder.
   *
   * @param uri
   *     URI to use for the request.
   * @return
   *     Builder for creating and executing a request.
   */
  HttpRequestBuilder newRequest(URI uri);

  /**
   * Create a new GET request builder. The client name will be selected based
   * on a prefix of the host name.
   *
   * @param uri
   *     URI to use for the request.
   * @return
   *     Builder for creating and executing a request.
   */
  default HttpRequestBuilder get(URI uri) {
    return newRequest(uri).withMethod("GET");
  }

  /**
   * Create a new POST request builder. The client name will be selected based
   * on a prefix of the host name.
   *
   * @param uri
   *     URI to use for the request.
   * @return
   *     Builder for creating and executing a request.
   */
  default HttpRequestBuilder post(URI uri) {
    return newRequest(uri).withMethod("POST");
  }

  /**
   * Create a new PUT request builder. The client name will be selected based
   * on a prefix of the host name.
   *
   * @param uri
   *     URI to use for the request.
   * @return
   *     Builder for creating and executing a request.
   */
  default HttpRequestBuilder put(URI uri) {
    return newRequest(uri).withMethod("PUT");
  }

  /**
   * Create a new DELETE request builder. The client name will be selected based
   * on a prefix of the host name.
   *
   * @param uri
   *     URI to use for the request.
   * @return
   *     Builder for creating and executing a request.
   */
  default HttpRequestBuilder delete(URI uri) {
    return newRequest(uri).withMethod("DELETE");
  }
}