com.wirefreethought.geodb.client.net.auth.ApiKeyAuth Maven / Gradle / Ivy

Go to download
/*
 * GeoDB API
 * The GeoDB API focuses on getting global city and region data. Easily obtain country, region, and city data for use in your apps! Filter cities by name prefix, country, location, time-zone, and even minimum population.
Sort cities by name, country code, elevation, and population - or any combination of these.
 Get all country regions.
 Get all cities in a given region.
Display results in multiple languages (currently, English, French, German, Russian, and Spanish).
 RESTful API adheres to industry best-practices, including HATEOAS-style links to facilitate paging results.
 Backed by cloud-based load-balanced infrastructure for resiliency and performance!
 Data is periodically refreshed from GeoNames and WikiData.
Notes:
All endpoints implicitly support JSONP-style invocation via an optional callback param.
Since the database is periodically updated, this may very rarely result in certain cities being marked deleted (e.g., duplicates removed). By default, endpoints returning city data will exclude cities marked deleted. However, in the unlikely event that this occurs while your app is paging through a set of affected results - and you care about the paged results suddenly changing underneath - specify includeDeleted=SINCE_YESTERDAY (or SINCE_LAST_WEEK if you're really paranoid!).
Useful Resources
SDKsAngular, Sample App
Java
JavaScript
Swagger Docs
Usage License
 *
 * OpenAPI spec version: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */


package com.wirefreethought.geodb.client.net.auth;

import com.wirefreethought.geodb.client.net.Pair;

import java.util.Map;
import java.util.List;

@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2018-05-16T19:24:37.995-07:00")
public class ApiKeyAuth implements Authentication {
  private final String location;
  private final String paramName;

  private String apiKey;
  private String apiKeyPrefix;

  public ApiKeyAuth(String location, String paramName) {
    this.location = location;
    this.paramName = paramName;
  }

  public String getLocation() {
    return location;
  }

  public String getParamName() {
    return paramName;
  }

  public String getApiKey() {
    return apiKey;
  }

  public void setApiKey(String apiKey) {
    this.apiKey = apiKey;
  }

  public String getApiKeyPrefix() {
    return apiKeyPrefix;
  }

  public void setApiKeyPrefix(String apiKeyPrefix) {
    this.apiKeyPrefix = apiKeyPrefix;
  }

  @Override
  public void applyToParams(List queryParams, Map headerParams) {
    if (apiKey == null) {
      return;
    }
    String value;
    if (apiKeyPrefix != null) {
      value = apiKeyPrefix + " " + apiKey;
    } else {
      value = apiKey;
    }
    if ("query".equals(location)) {
      queryParams.add(new Pair(paramName, value));
    } else if ("header".equals(location)) {
      headerParams.put(paramName, value);
    }
  }
}