Clientcore: remove client options (Azure#44764)

* remove ClientOptions from clientcore

Author: Liudmila Molkova

sdk/clientcore/core/spotbugs-exclude.xml

@@ -79,7 +79,7 @@
       <Class name="io.clientcore.core.http.HttpPipelineBuilderJavaDocCodeSnippets" />
       <Class name="io.clientcore.core.http.pipeline.AddHeadersPolicyJavadocCodeSnippets" />
       <Class name="io.clientcore.core.http.pipeline.SetRequestIdPolicyJavadocCodeSnippets" />
-      <Class name="io.clientcore.core.http.pipeline.SetUserAgentPolicyJavadocCodeSnippets" />
+      <Class name="io.clientcore.core.http.pipeline.UserAgentPolicyJavadocCodeSnippets" />
       <Class name="io.clientcore.core.instrumentation.TelemetryForLibraryDevelopersJavaDocCodeSnippets" />
       <Class name="io.clientcore.core.models.CloudEventJavaDocCodeSnippet" />
       <Class name="io.clientcore.core.models.ContextJavaDocCodeSnippets" />
@@ -383,7 +383,7 @@
   </Match>
   <Match>
     <Bug pattern="UC_USELESS_VOID_METHOD" />
-    <Class name="io.clientcore.core.http.pipeline.SetUserAgentPolicyJavadocCodeSnippets" />
+    <Class name="io.clientcore.core.http.pipeline.UserAgentPolicyJavadocCodeSnippets" />
   </Match>
   <Match>
     <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD" />

sdk/clientcore/core/src/main/java/io/clientcore/core/http/pipeline/HttpInstrumentationPolicy.java

@@ -10,10 +10,10 @@
 import io.clientcore.core.http.models.HttpRequest;
 import io.clientcore.core.http.models.Response;
 import io.clientcore.core.implementation.http.HttpRequestAccessHelper;
-import io.clientcore.core.implementation.instrumentation.LibraryInstrumentationOptionsAccessHelper;
+import io.clientcore.core.implementation.instrumentation.SdkInstrumentationOptionsAccessHelper;
 import io.clientcore.core.instrumentation.Instrumentation;
 import io.clientcore.core.instrumentation.InstrumentationContext;
-import io.clientcore.core.instrumentation.LibraryInstrumentationOptions;
+import io.clientcore.core.instrumentation.SdkInstrumentationOptions;
 import io.clientcore.core.instrumentation.logging.ClientLogger;
 import io.clientcore.core.instrumentation.logging.LogLevel;
 import io.clientcore.core.instrumentation.logging.LoggingEvent;
@@ -145,26 +145,25 @@
 public final class HttpInstrumentationPolicy implements HttpPipelinePolicy {
     private static final ClientLogger LOGGER = new ClientLogger(HttpInstrumentationPolicy.class);
     private static final HttpInstrumentationOptions DEFAULT_OPTIONS = new HttpInstrumentationOptions();
-    private static final String LIBRARY_NAME;
-    private static final String LIBRARY_VERSION;
-    private static final LibraryInstrumentationOptions LIBRARY_OPTIONS;
+    private static final String SDK_NAME;
+    private static final String SDK_VERSION;
+    private static final SdkInstrumentationOptions SDK_OPTIONS;
     private static final TraceContextSetter<HttpHeaders> SETTER
         = (headers, name, value) -> headers.set(HttpHeaderName.fromString(name), value);
 
     static {
         Map<String, String> properties = getProperties("core.properties");
-        LIBRARY_NAME = properties.getOrDefault("name", "unknown");
-        LIBRARY_VERSION = properties.getOrDefault("version", "unknown");
-        LibraryInstrumentationOptions libOptions
-            = new LibraryInstrumentationOptions(LIBRARY_NAME).setLibraryVersion(LIBRARY_VERSION)
-                .setSchemaUrl("https://opentelemetry.io/schemas/1.29.0");
+        SDK_NAME = properties.getOrDefault("name", "unknown");
+        SDK_VERSION = properties.getOrDefault("version", "unknown");
+        SdkInstrumentationOptions sdkOptions = new SdkInstrumentationOptions(SDK_NAME).setSdkVersion(SDK_VERSION)
+            .setSchemaUrl("https://opentelemetry.io/schemas/1.29.0");
 
         // HTTP tracing is special - we suppress nested public API spans, but
         // preserve nested HTTP ones.
         // We might want to make it configurable for other cases, but let's hide the API for now.
-        LibraryInstrumentationOptionsAccessHelper.disableSpanSuppression(libOptions);
+        SdkInstrumentationOptionsAccessHelper.disableSpanSuppression(sdkOptions);
 
-        LIBRARY_OPTIONS = libOptions;
+        SDK_OPTIONS = sdkOptions;
     }
 
     private static final int MAX_BODY_LOG_SIZE = 1024 * 16;
@@ -203,7 +202,7 @@ public final class HttpInstrumentationPolicy implements HttpPipelinePolicy {
      * @param instrumentationOptions Application telemetry options.
      */
     public HttpInstrumentationPolicy(HttpInstrumentationOptions instrumentationOptions) {
-        this.instrumentation = Instrumentation.create(instrumentationOptions, LIBRARY_OPTIONS);
+        this.instrumentation = Instrumentation.create(instrumentationOptions, SDK_OPTIONS);
         this.tracer = instrumentation.getTracer();
         this.meter = instrumentation.getMeter();
         this.httpRequestDuration = meter.createDoubleHistogram(REQUEST_DURATION_METRIC_NAME,

sdk/clientcore/core/src/main/java/io/clientcore/core/http/pipeline/UserAgentOptions.java

@@ -0,0 +1,83 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package io.clientcore.core.http.pipeline;
+
+import io.clientcore.core.annotations.Metadata;
+import io.clientcore.core.annotations.MetadataProperties;
+
+/**
+ * The {@code UserAgentOptions} class is used to configure the user agent string for HTTP requests.
+ */
+@Metadata(properties = MetadataProperties.FLUENT)
+public final class UserAgentOptions {
+    private String sdkName;
+    private String sdkVersion;
+    private String applicationId;
+
+    /**
+     * Creates a new instance of {@link UserAgentOptions}.
+     */
+    public UserAgentOptions() {
+    }
+
+    /**
+     * Sets the SDK name to be used in the user agent.
+     *
+     * @param sdkName The SDK name to set.
+     * @return The updated {@link UserAgentOptions} instance.
+     */
+    public UserAgentOptions setSdkName(String sdkName) {
+        this.sdkName = sdkName;
+        return this;
+    }
+
+    /**
+     * Sets the SDK version to be used in the user agent.
+     *
+     * @param sdkVersion The SDK version to set.
+     * @return The updated {@link UserAgentOptions} instance.
+     */
+    public UserAgentOptions setSdkVersion(String sdkVersion) {
+        this.sdkVersion = sdkVersion;
+        return this;
+    }
+
+    /**
+     * Sets the application ID to be used in the user agent.
+     *
+     * @param applicationId The application ID to set.
+     * @return The updated {@link UserAgentOptions} instance.
+     */
+    public UserAgentOptions setApplicationId(String applicationId) {
+        this.applicationId = applicationId;
+        return this;
+    }
+
+    /**
+     * Gets the SDK name for the user agent.
+     *
+     * @return The SDK name.
+     */
+    public String getSdkName() {
+        return sdkName;
+    }
+
+    /**
+     * Gets the SDK version for the user agent.
+     *
+     * @return The SDK version.
+     */
+    public String getSdkVersion() {
+        return sdkVersion;
+    }
+
+    /**
+     * Gets the application ID for the user agent.
+     *
+     * @return The application ID.
+     */
+    public String getApplicationId() {
+        return applicationId;
+    }
+}

sdk/clientcore/core/src/main/java/io/clientcore/core/http/pipeline/UserAgentPolicy.java

@@ -28,11 +28,11 @@
  * Once added to the pipeline, requests will have their "User-Agent" header set to "MyApp/1.0" by the
  * {@code UserAgentPolicy}.</p>
  *
- * <!-- src_embed io.clientcore.core.http.pipeline.SetUserAgentPolicy.constructor -->
+ * <!-- src_embed io.clientcore.core.http.pipeline.UserAgentPolicy.constructor -->
  * <pre>
  * UserAgentPolicy policy = new UserAgentPolicy&#40;&quot;MyApp&#47;1.0&quot;&#41;;
  * </pre>
- * <!-- end io.clientcore.core.http.pipeline.SetUserAgentPolicy.constructor -->
+ * <!-- end io.clientcore.core.http.pipeline.UserAgentPolicy.constructor -->
  *
  * @see io.clientcore.core.http.pipeline
  * @see HttpPipelinePolicy
@@ -49,7 +49,7 @@ public class UserAgentPolicy implements HttpPipelinePolicy {
      * Creates a {@link UserAgentPolicy} with a default user agent string.
      */
     public UserAgentPolicy() {
-        this(null);
+        this((String) null);
     }
 
     /**
@@ -69,12 +69,10 @@ public UserAgentPolicy(String userAgent) {
     /**
      * Creates a UserAgentPolicy with the {@code sdkName} and {@code sdkVersion} in the User-Agent header value.
      *
-     * @param applicationId User specified application Id.
-     * @param sdkName Name of the client library.
-     * @param sdkVersion Version of the client library.
+     * @param userAgentOptions Options allowing to customize the user agent string.
      */
-    public UserAgentPolicy(String applicationId, String sdkName, String sdkVersion) {
-        this.userAgent = toUserAgentString(applicationId, sdkName, sdkVersion);
+    public UserAgentPolicy(UserAgentOptions userAgentOptions) {
+        this.userAgent = toUserAgentString(userAgentOptions);
     }
 
     @Override
@@ -88,11 +86,6 @@ public final HttpPipelinePosition getPipelinePosition() {
         return HttpPipelinePosition.BEFORE_REDIRECT;
     }
 
-    private static final int MAX_APPLICATION_ID_LENGTH = 24;
-    private static final String INVALID_APPLICATION_ID_LENGTH
-        = "'applicationId' length cannot be greater than " + MAX_APPLICATION_ID_LENGTH;
-    private static final String INVALID_APPLICATION_ID_SPACE = "'applicationId' cannot contain spaces.";
-
     /**
      * Default {@code UserAgent} header.
      */
@@ -101,29 +94,29 @@ public final HttpPipelinePosition getPipelinePosition() {
     /**
      * Return user agent string for the given sdk name and version.
      *
-     * @param applicationId Name of the application.
-     * @param sdkName Name of the SDK.
-     * @param sdkVersion Version of the SDK.
-     * @return User agent string as specified in design guidelines.
+     * @param userAgentOptions Options allowing to customize the user agent string.
      *
-     * @throws IllegalArgumentException If {@code applicationId} contains spaces or is larger than 24 characters in
-     * length.
+     * @throws IllegalArgumentException If {@code applicationId} contains spaces.
      */
-    private static String toUserAgentString(String applicationId, String sdkName, String sdkVersion) {
+    private static String toUserAgentString(UserAgentOptions userAgentOptions) {
         StringBuilder userAgentBuilder = new StringBuilder();
 
+        String applicationId = userAgentOptions.getApplicationId();
+
         if (!CoreUtils.isNullOrEmpty(applicationId)) {
-            if (applicationId.length() > MAX_APPLICATION_ID_LENGTH) {
-                throw new IllegalArgumentException(INVALID_APPLICATION_ID_LENGTH);
-            } else if (applicationId.contains(" ")) {
-                throw new IllegalArgumentException(INVALID_APPLICATION_ID_SPACE);
+            if (applicationId.contains(" ")) {
+                throw new IllegalArgumentException("'applicationid' cannot contain spaces.");
             } else {
                 userAgentBuilder.append(applicationId).append(" ");
             }
         }
 
         // Add the required default User-Agent string.
-        userAgentBuilder.append(DEFAULT_USER_AGENT_HEADER).append("-").append(sdkName).append("/").append(sdkVersion);
+        userAgentBuilder.append(DEFAULT_USER_AGENT_HEADER)
+            .append("-")
+            .append(userAgentOptions.getSdkName())
+            .append("/")
+            .append(userAgentOptions.getSdkVersion());
         appendPlatformInfo(userAgentBuilder);
 
         return userAgentBuilder.toString();

sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/instrumentation/InstrumentationUtils.java

@@ -3,7 +3,7 @@
 
 package io.clientcore.core.implementation.instrumentation;
 
-import io.clientcore.core.instrumentation.LibraryInstrumentationOptions;
+import io.clientcore.core.instrumentation.SdkInstrumentationOptions;
 import io.clientcore.core.instrumentation.metrics.DoubleHistogram;
 import io.clientcore.core.instrumentation.metrics.Meter;
 
@@ -23,19 +23,18 @@ public final class InstrumentationUtils {
     private static final List<Double> DURATION_BOUNDARIES_ADVICE = Collections.unmodifiableList(
         Arrays.asList(0.005d, 0.01d, 0.025d, 0.05d, 0.075d, 0.1d, 0.25d, 0.5d, 0.75d, 1d, 2.5d, 5d, 7.5d, 10d));
 
-    public static final LibraryInstrumentationOptions UNKNOWN_LIBRARY_OPTIONS
-        = new LibraryInstrumentationOptions("unknown");
+    public static final SdkInstrumentationOptions UNKNOWN_LIBRARY_OPTIONS = new SdkInstrumentationOptions("unknown");
 
     /**
      * Creates a new {@link DoubleHistogram} for measuring the duration of client operations.
-     * @param libraryName the name of the library - corresponds to artifact id and does not include group id
+     * @param sdkName the name of the library - corresponds to artifact id and does not include group id
      * @param meter the meter to use for creating the histogram
      * @return a new {@link DoubleHistogram} for measuring the duration of client operations
      */
-    public static DoubleHistogram createOperationDurationHistogram(String libraryName, Meter meter) {
-        if (meter.isEnabled() && libraryName != null) {
+    public static DoubleHistogram createOperationDurationHistogram(String sdkName, Meter meter) {
+        if (meter.isEnabled() && sdkName != null) {
             String metricDescription = "Duration of client operation";
-            String metricName = libraryName.replace("-", ".") + ".client.operation.duration";
+            String metricName = sdkName.replace("-", ".") + ".client.operation.duration";
             return meter.createDoubleHistogram(metricName, metricDescription, "s", DURATION_BOUNDARIES_ADVICE);
         }
 

sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/instrumentation/LibraryInstrumentationOptionsAccessHelper.java renamed to sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/instrumentation/SdkInstrumentationOptionsAccessHelper.java

@@ -3,41 +3,41 @@
 
 package io.clientcore.core.implementation.instrumentation;
 
-import io.clientcore.core.instrumentation.LibraryInstrumentationOptions;
+import io.clientcore.core.instrumentation.SdkInstrumentationOptions;
 
 /**
- * Helper class to access package-private members of {@link LibraryInstrumentationOptions}.
+ * Helper class to access package-private members of {@link SdkInstrumentationOptions}.
  */
-public final class LibraryInstrumentationOptionsAccessHelper {
+public final class SdkInstrumentationOptionsAccessHelper {
 
-    private static LibraryInstrumentationOptionsAccessor accessor;
+    private static SdkInstrumentationOptionsAccessor accessor;
 
     /**
-     * Defines the methods that can be called on an instance of {@link LibraryInstrumentationOptions}.
+     * Defines the methods that can be called on an instance of {@link SdkInstrumentationOptions}.
      */
-    public interface LibraryInstrumentationOptionsAccessor {
+    public interface SdkInstrumentationOptionsAccessor {
 
         /**
          * Disables span suppression for the given options.
          * @param options the options to disable span suppression for
          * @return the options with span suppression disabled
          */
-        LibraryInstrumentationOptions disableSpanSuppression(LibraryInstrumentationOptions options);
+        SdkInstrumentationOptions disableSpanSuppression(SdkInstrumentationOptions options);
 
         /**
          * Checks if span suppression is disabled for the given options.
          * @param options the options to check
          * @return true if span suppression is disabled, false otherwise
          */
-        boolean isSpanSuppressionDisabled(LibraryInstrumentationOptions options);
+        boolean isSpanSuppressionDisabled(SdkInstrumentationOptions options);
     }
 
     /**
      * Disables span suppression for the given options.
      * @param options the options to disable span suppression for
      * @return the options with span suppression disabled
      */
-    public static LibraryInstrumentationOptions disableSpanSuppression(LibraryInstrumentationOptions options) {
+    public static SdkInstrumentationOptions disableSpanSuppression(SdkInstrumentationOptions options) {
         return accessor.disableSpanSuppression(options);
     }
 
@@ -46,18 +46,18 @@ public static LibraryInstrumentationOptions disableSpanSuppression(LibraryInstru
      * @param options the options to check
      * @return true if span suppression is disabled, false otherwise
      */
-    public static boolean isSpanSuppressionDisabled(LibraryInstrumentationOptions options) {
+    public static boolean isSpanSuppressionDisabled(SdkInstrumentationOptions options) {
         return accessor.isSpanSuppressionDisabled(options);
     }
 
     /**
      * Sets the accessor.
      * @param accessor the accessor
      */
-    public static void setAccessor(LibraryInstrumentationOptionsAccessor accessor) {
-        LibraryInstrumentationOptionsAccessHelper.accessor = accessor;
+    public static void setAccessor(SdkInstrumentationOptionsAccessor accessor) {
+        SdkInstrumentationOptionsAccessHelper.accessor = accessor;
     }
 
-    private LibraryInstrumentationOptionsAccessHelper() {
+    private SdkInstrumentationOptionsAccessHelper() {
     }
 }

sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/instrumentation/fallback/FallbackInstrumentation.java

@@ -4,13 +4,13 @@
 package io.clientcore.core.implementation.instrumentation.fallback;
 
 import io.clientcore.core.http.models.RequestContext;
-import io.clientcore.core.implementation.instrumentation.LibraryInstrumentationOptionsAccessHelper;
 import io.clientcore.core.implementation.instrumentation.NoopMeter;
+import io.clientcore.core.implementation.instrumentation.SdkInstrumentationOptionsAccessHelper;
 import io.clientcore.core.instrumentation.Instrumentation;
 import io.clientcore.core.instrumentation.InstrumentationAttributes;
 import io.clientcore.core.instrumentation.InstrumentationContext;
 import io.clientcore.core.instrumentation.InstrumentationOptions;
-import io.clientcore.core.instrumentation.LibraryInstrumentationOptions;
+import io.clientcore.core.instrumentation.SdkInstrumentationOptions;
 import io.clientcore.core.instrumentation.metrics.Meter;
 import io.clientcore.core.instrumentation.tracing.Span;
 import io.clientcore.core.instrumentation.tracing.SpanBuilder;
@@ -44,16 +44,16 @@ public class FallbackInstrumentation implements Instrumentation {
     /**
      * Creates a new instance of {@link FallbackInstrumentation}.
      * @param instrumentationOptions the application instrumentation options
-     * @param libraryOptions the library instrumentation options
+     * @param sdkOptions the library instrumentation options
      * @param host the service host
      * @param port the service port
      */
-    public FallbackInstrumentation(InstrumentationOptions instrumentationOptions,
-        LibraryInstrumentationOptions libraryOptions, String host, int port) {
-        this.allowNestedSpans = libraryOptions != null
-            && LibraryInstrumentationOptionsAccessHelper.isSpanSuppressionDisabled(libraryOptions);
+    public FallbackInstrumentation(InstrumentationOptions instrumentationOptions, SdkInstrumentationOptions sdkOptions,
+        String host, int port) {
+        this.allowNestedSpans
+            = sdkOptions != null && SdkInstrumentationOptionsAccessHelper.isSpanSuppressionDisabled(sdkOptions);
         this.isTracingEnabled = instrumentationOptions == null || instrumentationOptions.isTracingEnabled();
-        this.tracer = new FallbackTracer(instrumentationOptions, libraryOptions);
+        this.tracer = new FallbackTracer(instrumentationOptions, sdkOptions);
         this.serviceHost = host;
         this.servicePort = port;
     }