com.launchdarkly.sdk.server.integrations.ApplicationInfoBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of launchdarkly-java-server-sdk Show documentation

Official LaunchDarkly SDK for Java

There is a newer version: 7.5.0

Show newest version

package com.launchdarkly.sdk.server.integrations;

import com.launchdarkly.sdk.server.Components;
import com.launchdarkly.sdk.server.interfaces.ApplicationInfo;

/**
 * Contains methods for configuring the SDK's application metadata.
 * 
 * Application metadata may be used in LaunchDarkly analytics or other product features, but does not affect feature flag evaluations.
 * 

 * If you want to set non-default values for any of these fields, create a builder with
 * {@link Components#applicationInfo()}, change its properties with the methods of this class,
 * and pass it to {@link com.launchdarkly.sdk.server.LDConfig.Builder#applicationInfo(ApplicationInfoBuilder)}:
 * 

 *     LDConfig config = new LDConfig.Builder()
 *         .applicationInfo(
 *             Components.applicationInfo()
 *                 .applicationId("authentication-service")
 *                 .applicationVersion("1.0.0")
 *         )
 *         .build();
 * 
 * 
 *
 * @since 5.8.0
 */
public final class ApplicationInfoBuilder {
  private String applicationId;
  private String applicationVersion;

  /**
   * Create an empty ApplicationInfoBuilder.
   *
   * @see Components#applicationInfo()
   */
  public ApplicationInfoBuilder() {}

  /**
   * Sets a unique identifier representing the application where the LaunchDarkly SDK is running.
   * 

   * This can be specified as any string value as long as it only uses the following characters: ASCII
   * letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be
   * ignored.
   *
   * @param applicationId the application identifier
   * @return the builder
   */
  public ApplicationInfoBuilder applicationId(String applicationId) {
    this.applicationId = applicationId;
    return this;
  }

  /**
   * Sets a unique identifier representing the version of the application where the LaunchDarkly SDK
   * is running.
   * 
   * This can be specified as any string value as long as it only uses the following characters: ASCII
   * letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be
   * ignored.
   *
   * @param applicationVersion the application version
   * @return the builder
   */
  public ApplicationInfoBuilder applicationVersion(String applicationVersion) {
    this.applicationVersion = applicationVersion;
    return this;
  }

  /**
   * Called internally by the SDK to create the configuration object.
   *
   * @return the configuration object
   */
  public ApplicationInfo createApplicationInfo() {
    return new ApplicationInfo(applicationId, applicationVersion);
  }
}