content: /*
   * Copyright The OpenTelemetry Authors
   * SPDX-License-Identifier: Apache-2.0
   */
  
  package io.opentelemetry.instrumentation.api.semconv.http;
  
  import static java.util.Collections.emptyList;
  
  import com.google.errorprone.annotations.CanIgnoreReturnValue;
  import io.opentelemetry.context.Context;
  import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
  import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
  import io.opentelemetry.instrumentation.api.internal.Experimental;
  import io.opentelemetry.instrumentation.api.internal.HttpConstants;
  import io.opentelemetry.instrumentation.api.semconv.network.internal.AddressAndPortExtractor;
  import io.opentelemetry.instrumentation.api.semconv.network.internal.InternalNetworkAttributesExtractor;
  import io.opentelemetry.instrumentation.api.semconv.network.internal.InternalServerAttributesExtractor;
  import io.opentelemetry.instrumentation.api.semconv.network.internal.ServerAddressAndPortExtractor;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.HashSet;
  import java.util.List;
  import java.util.Set;
  import java.util.function.ToIntFunction;
  
  /**
   * A builder of {@link HttpClientAttributesExtractor}.
   *
   * @since 2.0.0
   */
  public final class HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
  
    final HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter;
  
    final AddressAndPortExtractor<REQUEST> serverAddressAndPortExtractor;
    List<String> capturedRequestHeaders = emptyList();
    List<String> capturedResponseHeaders = emptyList();
    Set<String> knownMethods = HttpConstants.KNOWN_METHODS;
    ToIntFunction<Context> resendCountIncrementer = HttpClientRequestResendCount::getAndIncrement;
    boolean redactQueryParameters;
  
    static {
      Experimental.internalSetRedactHttpClientQueryParameters(
          (builder, redact) -> builder.redactQueryParameters = redact);
    }
  
    HttpClientAttributesExtractorBuilder(
        HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter) {
      this.httpAttributesGetter = httpAttributesGetter;
      serverAddressAndPortExtractor =
          new ServerAddressAndPortExtractor<>(
              httpAttributesGetter, new HostAddressAndPortExtractor<>(httpAttributesGetter));
    }
  
    /**
     * Configures the HTTP request headers that will be captured as span attributes as described in <a
     * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#http-client">HTTP
     * semantic conventions</a>.
     *
     * <p>The HTTP request header values will be captured under the {@code http.request.header.<key>}
     * attribute key. The {@code <key>} part in the attribute key is the lowercase header name.
     *
     * @param requestHeaders A list of HTTP header names.
     */
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
        Collection<String> requestHeaders) {
      this.capturedRequestHeaders = new ArrayList<>(requestHeaders);
      return this;
    }
  
    /**
     * Configures the HTTP request headers that will be captured as span attributes as described in <a
     * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#http-client">HTTP
     * semantic conventions</a>.
     *
     * <p>The HTTP request header values will be captured under the {@code http.request.header.<key>}
     * attribute key. The {@code <key>} part in the attribute key is the lowercase header name.
     *
     * @param requestHeaders A list of HTTP header names.
     */
    // don't deprecate this since users will get deprecation warning without a clean way to suppress
    // it if they're using List
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
        List<String> requestHeaders) {
      return setCapturedRequestHeaders((Collection<String>) requestHeaders);
    }
  
    /**
     * Configures the HTTP response headers that will be captured as span attributes as described in
     * <a
     * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#common-attributes">HTTP
     * semantic conventions</a>.
     *
     * <p>The HTTP response header values will be captured under the {@code
     * http.response.header.<key>} attribute key. The {@code <key>} part in the attribute key is the
     * lowercase header name.
     *
     * @param responseHeaders A list of HTTP header names.
     */
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
        Collection<String> responseHeaders) {
      this.capturedResponseHeaders = new ArrayList<>(responseHeaders);
      return this;
    }
  
    /**
     * Configures the HTTP response headers that will be captured as span attributes as described in
     * <a
     * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#common-attributes">HTTP
     * semantic conventions</a>.
     *
     * <p>The HTTP response header values will be captured under the {@code
     * http.response.header.<key>} attribute key. The {@code <key>} part in the attribute key is the
     * lowercase header name.
     *
     * @param responseHeaders A list of HTTP header names.
     */
    // don't deprecate this since users will get deprecation warning without a clean way to suppress
    // it if they're using List
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
        List<String> responseHeaders) {
      return setCapturedResponseHeaders((Collection<String>) responseHeaders);
    }
  
    /**
     * Configures the extractor to recognize an alternative set of HTTP request methods.
     *
     * <p>By default, this extractor defines "known" methods as the ones listed in <a
     * href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
     * method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>. If an
     * unknown method is encountered, the extractor will use the value {@value HttpConstants#_OTHER}
     * instead of it and put the original value in an extra {@code http.request.method_original}
     * attribute.
     *
     * <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
     * not supplement it.
     *
     * @param knownMethods A set of recognized HTTP request methods.
     */
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setKnownMethods(
        Collection<String> knownMethods) {
      this.knownMethods = new HashSet<>(knownMethods);
      return this;
    }
  
    /**
     * Configures the extractor to recognize an alternative set of HTTP request methods.
     *
     * <p>By default, this extractor defines "known" methods as the ones listed in <a
     * href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
     * method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>. If an
     * unknown method is encountered, the extractor will use the value {@value HttpConstants#_OTHER}
     * instead of it and put the original value in an extra {@code http.request.method_original}
     * attribute.
     *
     * <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
     * not supplement it.
     *
     * @param knownMethods A set of recognized HTTP request methods.
     */
    // don't deprecate this since users will get deprecation warning without a clean way to suppress
    // it if they're using Set
    @CanIgnoreReturnValue
    public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setKnownMethods(
        Set<String> knownMethods) {
      return setKnownMethods((Collection<String>) knownMethods);
    }
  
    // visible for tests
    @CanIgnoreReturnValue
    HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setResendCountIncrementer(
        ToIntFunction<Context> resendCountIncrementer) {
      this.resendCountIncrementer = resendCountIncrementer;
      return this;
    }
  
    /**
     * Returns a new {@link HttpClientAttributesExtractor} with the settings of this {@link
     * HttpClientAttributesExtractorBuilder}.
     *
     * @see InstrumenterBuilder#addAttributesExtractor(AttributesExtractor)
     */
    public AttributesExtractor<REQUEST, RESPONSE> build() {
      return new HttpClientAttributesExtractor<>(this);
    }
  
    InternalNetworkAttributesExtractor<REQUEST, RESPONSE> buildNetworkExtractor() {
      return new InternalNetworkAttributesExtractor<>(
          httpAttributesGetter,
          // network.{transport,type} are opt-in, network.protocol.* have HTTP-specific logic
          /* captureProtocolAttributes= */ false,
          /* captureLocalSocketAttributes= */ false);
    }
  
    InternalServerAttributesExtractor<REQUEST> buildServerExtractor() {
      return new InternalServerAttributesExtractor<>(serverAddressAndPortExtractor);
    }
  }
  