com.amadeus.Configuration Maven / Gradle / Ivy

Go to download
package com.amadeus;

import java.util.Map;
import java.util.logging.Logger;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.Accessors;

/**
 * 
 * The configuration for the Amadeus API client. To initialize, use the builder as follows:
 * 
 *
 *  * Amadeus amadeus =
 *     Amadeus.builder("REPLACE_BY_YOUR_API_KEY", "REPLACE_BY_YOUR_API_SECRET").build();
 * 
 *
 * 
 * Or pass in environment variables directly:
 * 
 *
 *  * Amadeus.builder(System.getenv()).build();
 * 
 */
@Accessors(chain = true)
@ToString
public class Configuration {
  private static final Params HOSTS =
      Params.with("production", "api.amadeus.com").and("test", "test.api.amadeus.com");

  /**
   * The client ID used to authenticate the API calls.
   *
   * @return The client ID
   */
  private @Getter String clientId;
  /**
   * The client secret used to authenticate the API calls.
   *
   * @return The client secret
   */
  private @Getter String clientSecret;
  /**
   * The logger that will be used to debug or warn to.
   *
   * @param logger The logger object
   * @return The logger object
   */
  private @Getter @Setter Logger logger = Logger.getLogger("Amadeus");
  /**
   * The log level. Can be 'silent', 'warn', or 'debug'. Defaults to 'silent'.
   *
   * @param logLevel The log level for the logger
   * @return The log level for the logger
   */
  private @Getter @Setter String logLevel = "silent";
  /**
   * The the name of the server API calls are made to, 'production' or 'test'. Defaults to 'test'
   *
   * @param hostname The name of the server API calls are made to
   * @return The name of the server API calls are made to
   */
  private @Getter String hostname = "test";
  /**
   * The optional custom host domain to use for API calls. Defaults to internal value for
   * 'hostname'.
   *
   * @param host The optional custom host domain to use for API calls.
   * @return The optional custom host domain to use for API calls.
   */
  private @Getter @Setter String host = "test.api.amadeus.com";
  /**
   * Wether to use SSL. Defaults to True
   *
   * @param ssl A boolean specifying if the connection should use SSL
   * @return A boolean specifying if the connection should use SSL
   */
  private @Getter boolean ssl = true;
  /**
   * The port to use. Defaults to 443 for an SSL connection, and 80 for a non SSL connection.
   *
   * @param port The port to use for the connection
   * @return The port to use for the connection
   */
  private @Getter @Setter int port = 443;
  /**
   * An optional custom App ID to be passed in the User Agent to the server (Defaults to null).
   *
   * @param customAppId An optional custom App ID
   * @return The optional custom App ID
   */
  private @Getter @Setter String customAppId;
  /**
   * An optional custom App version to be passed in the User Agent to the server (Defaults to null).
   *
   * @param customAppVersion An optional custom App version
   * @return The optional custom App version
   */
  private @Getter @Setter String customAppVersion;

  protected Configuration(String clientId, String clientSecret) {
    this.clientId = clientId;
    this.clientSecret = clientSecret;
  }

  /**
   * Builds an Amadeus client with the provided credentials.
   *
   * @return an Amadeus client
   * @throws IllegalArgumentException when a client ID or client secret is missing
   */
  public Amadeus build() throws IllegalArgumentException {
    return new Amadeus(this);
  }

  /**
   * The the name of the server API calls are made to, 'production' or 'test'. Defaults to 'test'.
   *
   * @param hostname The name of the server API calls are made to
   * @return The name of the server API calls are made to
   */
  public Configuration setHostname(String hostname) {
    if (!HOSTS.containsKey(hostname)) {
      throw new IllegalArgumentException(
          String.format("Hostname %s not found in %s", hostname, HOSTS.keySet().toString()));
    }
    this.hostname = hostname;
    this.host = HOSTS.get(hostname);
    return this;
  }

  /**
   * Whether to use SSL. Defaults to True.
   *
   * @param ssl A boolean specifying if the connection should use SSL
   * @return A boolean specifying if the connection should use SSL
   */
  public Configuration setSsl(Boolean ssl) {
    this.ssl = ssl;
    if (!ssl && port == 443) {
      setPort(80);
    }
    return this;
  }

  // Parses environment variables and initializes the values.
  protected Configuration parseEnvironment(Map environment) {
    setHostname(getOrDefault(environment, "HOSTNAME", hostname));
    setHost(getOrDefault(environment, "HOST", host));
    setLogLevel(getOrDefault(environment, "LOG_LEVEL", logLevel));
    setSsl(Boolean.parseBoolean(getOrDefault(environment, "SSL", String.valueOf(ssl))));
    setPort(Integer.parseInt(getOrDefault(environment, "PORT", String.valueOf(port))));
    setCustomAppId(getOrDefault(environment, "CUSTOM_APP_ID", customAppId));
    setCustomAppVersion(getOrDefault(environment, "CUSTOM_APP_VERSION", customAppVersion));
    return this;
  }

  // Helper method for Java 7, as it's missing the getOrDefault method for Maps
  private String getOrDefault(Map environment, String key, String defaultValue) {
    String value = environment.get(String.format("AMADEUS_%s", key));
    return (value == null) ? defaultValue : value;
  }
}