Class ApiClient.TelemetryHeaderGenerator

java.lang.Object
com.cyberark.conjur.sdk.ApiClient.TelemetryHeaderGenerator
Enclosing class:
ApiClient

public static class ApiClient.TelemetryHeaderGenerator extends Object
A utility class responsible for generating the telemetry header used in HTTP requests.

The telemetry header is constructed using the integration name, type, version, and vendor name. These values are URL-encoded and Base64-encoded to ensure safe transmission over HTTP.

  • Constructor Details

    • TelemetryHeaderGenerator

      public TelemetryHeaderGenerator()
  • Method Details

    • generateTelemetryHeader

      public static String generateTelemetryHeader(String integrationName, String integrationType, String integrationVersion, String vendorName)
      Generates the telemetry header used for monitoring integration data.

      The generated header is a Base64 URL-encoded string containing the integration name, type, version, and vendor name.

      Parameters:
      integrationName - the name of the integration (e.g., "SecretsManagerJava SDK").
      integrationType - the type of integration (e.g., "cybr-secretsmanager-java-sdk").
      integrationVersion - the version of the integration (e.g., "4.2.0").
      vendorName - the vendor name (e.g., "CyberArk").
      Returns:
      a Base64 URL-encoded telemetry header string.