com.launchdarkly.sdk.server.StandardEndpoints 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;

import java.net.URI;

import com.launchdarkly.logging.LDLogger;

abstract class StandardEndpoints {
  private StandardEndpoints() {}

  static URI DEFAULT_STREAMING_BASE_URI = URI.create("https://stream.launchdarkly.com");
  static URI DEFAULT_POLLING_BASE_URI = URI.create("https://app.launchdarkly.com");
  static URI DEFAULT_EVENTS_BASE_URI = URI.create("https://events.launchdarkly.com");

  static String STREAMING_REQUEST_PATH = "/all";
  static String POLLING_REQUEST_PATH = "/sdk/latest-all";
  static String ANALYTICS_EVENTS_POST_REQUEST_PATH = "/bulk";
  static String DIAGNOSTIC_EVENTS_POST_REQUEST_PATH = "/diagnostic";

  /**
   * Internal method to decide which URI a given component should connect to.
   * 
   * Always returns some URI, falling back on the default if necessary, but logs a warning if we detect that the application
   * set some custom endpoints but not this one.
   * 
   * @param serviceEndpointsValue the value set in ServiceEndpoints (this is either the default URI, a custom URI, or null)
   * @param overrideValue the value overridden via the deprecated .baseURI() method (this is either a custom URI or null)
   * @param defaultValue the constant default URI value defined in StandardEndpoints
   * @param description a human-readable string for the type of endpoint being selected, for logging purposes
   * @param logger the logger to which we should print the warning, if needed
   * @return the base URI we should connect to
   */
  static URI selectBaseUri(URI serviceEndpointsValue, URI overrideValue, URI defaultValue, String description, LDLogger logger) {
    if (overrideValue != null) {
      return overrideValue;
    }
    if (serviceEndpointsValue != null) {
      return serviceEndpointsValue;
    }
    logger.warn("You have set custom ServiceEndpoints without specifying the {} base URI; connections may not work properly", description);
    return defaultValue;
  }

  /**
   * Internal method to determine whether a given base URI was set to a custom value or not.
   * 
   * This boolean value is only used for our diagnostic events. We only check if the value
   * differs from the default; if the base URI was "overridden" in configuration, but
   * happens to be equal to the default URI, we don't count that as custom
   * for the purposes of this diagnostic.
   *
   * @param serviceEndpointsValue the value set in ServiceEndpoints
   * @param overrideValue the value overridden via the deprecated .baseURI() method
   * @param defaultValue the constant default URI value defined in StandardEndpoints
   * @return true iff the base URI was customized
   */
  static boolean isCustomBaseUri(URI serviceEndpointsValue, URI overrideValue, URI defaultValue) {
    return (overrideValue != null && !overrideValue.equals(defaultValue)) ||
      (serviceEndpointsValue != null && !serviceEndpointsValue.equals(defaultValue));
  }
}