org.openapitools.client.auth.ApiKeyAuth Java Examples

protected void init() {
    // Use RFC3339 format for date and datetime.
    // See http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
    this.dateFormat = new RFC3339DateFormat();

    // Use UTC as the default time zone.
    this.dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));

    // Set default User-Agent.
    setUserAgent("Java-SDK");

    // Setup authentications (key: authentication name, value: authentication).
    authentications = new HashMap<String, Authentication>();
    authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
    authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
    authentications.put("http_basic_test", new HttpBasicAuth());
    authentications.put("petstore_auth", new OAuth());
    // Prevent the authentications from being modified.
    authentications = Collections.unmodifiableMap(authentications);
}
 

protected void init() {
    // Use RFC3339 format for date and datetime.
    // See http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
    this.dateFormat = new RFC3339DateFormat();

    // Use UTC as the default time zone.
    this.dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));

    // Set default User-Agent.
    setUserAgent("Java-SDK");

    // Setup authentications (key: authentication name, value: authentication).
    authentications = new HashMap<String, Authentication>();
    authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
    authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
    authentications.put("http_basic_test", new HttpBasicAuth());
    authentications.put("petstore_auth", new OAuth());
    // Prevent the authentications from being modified.
    authentications = Collections.unmodifiableMap(authentications);
}
 

public ApiClient() {
  json = new JSON();
  httpClient = buildHttpClient(debugging);

  this.dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX", Locale.ROOT);

  // Use UTC as the default time zone.
  this.dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));

  this.json.setDateFormat((DateFormat) dateFormat.clone());

  // Set default User-Agent.
  setUserAgent("OpenAPI-Generator/1.0.0/java");

  // Setup authentications (key: authentication name, value: authentication).
  authentications = new HashMap<String, Authentication>();
  authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
  authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
  authentications.put("http_basic_test", new HttpBasicAuth());
  authentications.put("petstore_auth", new OAuth());
  // Prevent the authentications from being modified.
  authentications = Collections.unmodifiableMap(authentications);
}
 

/**
 * Find pet by ID
 * <p>
 * Returns a single pet
 *
 * @throws ApiException if the Api call fails
 */
@Test
public void getPetByIdTest() throws ApiException {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://petstore.swagger.io:80/v2");

    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    PetApi apiInstance = new PetApi(defaultClient);
    Long petId = 56L; // Long | ID of pet to return
    try {
        Pet result = apiInstance.getPetById(petId);
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling PetApi#getPetById");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
    }

}
 

/**
 * Helper method to configure the first api key found
 * @param apiKey API key
 * @return ApiClient
 */
public ApiClient setApiKey(String apiKey) {
  for(Interceptor apiAuthorization : apiAuthorizations.values()) {
    if (apiAuthorization instanceof ApiKeyAuth) {
      ApiKeyAuth keyAuth = (ApiKeyAuth) apiAuthorization;
      keyAuth.setApiKey(apiKey);
      return this;
    }
  }
  return this;
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 * @param apiKey the API key
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 * @param apiKeyPrefix API key prefix
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 * @param apiKey the API key
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 * @param apiKeyPrefix API key prefix
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to configure the first api key found
 * @param apiKey API key
 * @return ApiClient
 */
public ApiClient setApiKey(String apiKey) {
  for(Interceptor apiAuthorization : apiAuthorizations.values()) {
    if (apiAuthorization instanceof ApiKeyAuth) {
      ApiKeyAuth keyAuth = (ApiKeyAuth) apiAuthorization;
      keyAuth.setApiKey(apiKey);
      return this;
    }
  }
  return this;
}
 

public ApiClient() {
    init();
    initHttpClient();

    // Setup authentications (key: authentication name, value: authentication).
    authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
    authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
    authentications.put("http_basic_test", new HttpBasicAuth());
    authentications.put("petstore_auth", new OAuth());
    // Prevent the authentications from being modified.
    authentications = Collections.unmodifiableMap(authentications);
}
 

public ApiClient(OkHttpClient client) {
    init();

    httpClient = client;

    // Setup authentications (key: authentication name, value: authentication).
    authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
    authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
    authentications.put("http_basic_test", new HttpBasicAuth());
    authentications.put("petstore_auth", new OAuth());
    // Prevent the authentications from being modified.
    authentications = Collections.unmodifiableMap(authentications);
}
 

public ApiClient(String basePath, String clientId, String clientSecret, Map<String, String> parameters) {
    init();
    if (basePath != null) {
        this.basePath = basePath;
    }

    String tokenUrl = "";
    if (!"".equals(tokenUrl) && !URI.create(tokenUrl).isAbsolute()) {
        URI uri = URI.create(getBasePath());
        tokenUrl = uri.getScheme() + ":" +
            (uri.getAuthority() != null ? "//" + uri.getAuthority() : "") +
            tokenUrl;
        if (!URI.create(tokenUrl).isAbsolute()) {
            throw new IllegalArgumentException("OAuth2 token URL must be an absolute URL");
        }
    }
    RetryingOAuth retryingOAuth = new RetryingOAuth(tokenUrl, clientId, OAuthFlow.implicit, clientSecret, parameters);
    authentications.put(
            "petstore_auth",
            retryingOAuth
    );
    initHttpClient(Collections.<Interceptor>singletonList(retryingOAuth));
    // Setup authentications (key: authentication name, value: authentication).
    authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
    authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
    authentications.put("http_basic_test", new HttpBasicAuth());

    // Prevent the authentications from being modified.
    authentications = Collections.unmodifiableMap(authentications);
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 *
 * @param apiKey API key
 */
public void setApiKey(String apiKey) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof ApiKeyAuth) {
            ((ApiKeyAuth) auth).setApiKey(apiKey);
            return;
        }
    }
    throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 *
 * @param apiKeyPrefix API key prefix
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof ApiKeyAuth) {
            ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
            return;
        }
    }
    throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 *
 * @param apiKey API key
 */
public void setApiKey(String apiKey) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof ApiKeyAuth) {
            ((ApiKeyAuth) auth).setApiKey(apiKey);
            return;
        }
    }
    throw new RuntimeException("No API key authentication configured!");
}
 

public ApiClient() {
  objectMapper = new ObjectMapper();
  objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
  objectMapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false);
  objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
  objectMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
  objectMapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
  ThreeTenModule module = new ThreeTenModule();
  module.addDeserializer(Instant.class, CustomInstantDeserializer.INSTANT);
  module.addDeserializer(OffsetDateTime.class, CustomInstantDeserializer.OFFSET_DATE_TIME);
  module.addDeserializer(ZonedDateTime.class, CustomInstantDeserializer.ZONED_DATE_TIME);
  objectMapper.registerModule(module);
  objectMapper.setDateFormat(ApiClient.buildDefaultDateFormat());

  dateFormat = ApiClient.buildDefaultDateFormat();

  // Set default User-Agent.
  setUserAgent("OpenAPI-Generator/1.0.0/java");

  // Setup authentications (key: authentication name, value: authentication).
  authentications = new HashMap<String, Authentication>();
  authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
  authentications.put("api_key_query", new ApiKeyAuth("query", "api_key_query"));
  authentications.put("http_basic_test", new HttpBasicAuth());
  authentications.put("petstore_auth", new OAuth());
  // Prevent the authentications from being modified.
  authentications = Collections.unmodifiableMap(authentications);

  rebuildHttpClient();
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 * @param apiKey the API key
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 * @param apiKeyPrefix API key prefix
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

public static void initializeInstance(Cache cache, Network network, int threadPoolSize, ResponseDelivery delivery, int connectionTimeout) {
  INSTANCE = new ApiInvoker(cache, network, threadPoolSize, delivery, connectionTimeout);
  setUserAgent("OpenAPI-Generator/1.0.0/android");

  // Setup authentications (key: authentication name, value: authentication).
  INSTANCE.authentications = new HashMap<String, Authentication>();
  INSTANCE.authentications.put("api_key", new ApiKeyAuth("header", "api_key"));
  // TODO: comment out below as OAuth does not exist
  //INSTANCE.authentications.put("petstore_auth", new OAuth());
  // Prevent the authentications from being modified.
  INSTANCE.authentications = Collections.unmodifiableMap(INSTANCE.authentications);
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

public static void initializeInstance(Cache cache, Network network, int threadPoolSize, ResponseDelivery delivery, int connectionTimeout) {
  INSTANCE = new ApiInvoker(cache, network, threadPoolSize, delivery, connectionTimeout);
  setUserAgent("OpenAPI-Generator/1.0.0/android");

  // Setup authentications (key: authentication name, value: authentication).
  INSTANCE.authentications = new HashMap<String, Authentication>();
  INSTANCE.authentications.put("jenkins_auth", new HttpBasicAuth());
  INSTANCE.authentications.put("jwt_auth", new ApiKeyAuth("header", "Authorization"));
  // Prevent the authentications from being modified.
  INSTANCE.authentications = Collections.unmodifiableMap(INSTANCE.authentications);
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 */
public void setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to set API key prefix for the first API key authentication.
 */
public void setApiKeyPrefix(String apiKeyPrefix) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
      return;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to configure authentications which respects aliases of API keys.
 *
 * @param secrets Hash map from authentication name to its secret.
 */
public ApiClient configureApiKeys(HashMap<String, String> secrets) {
  for (Map.Entry<String, Authentication> authEntry : authentications.entrySet()) {
    Authentication auth = authEntry.getValue();
    if (auth instanceof ApiKeyAuth) {
      String name = authEntry.getKey();
      // respect x-auth-id-alias property
      name = authenticationLookup.containsKey(name) ? authenticationLookup.get(name) : name;
      if (secrets.containsKey(name)) {
        ((ApiKeyAuth) auth).setApiKey(secrets.get(name));
      }
    }
  }
  return this;
}
 

/**
 * Helper method to set API key value for the first API key authentication.
 *
 * @param apiKey API key
 */
public ApiClient setApiKey(String apiKey) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof ApiKeyAuth) {
      ((ApiKeyAuth) auth).setApiKey(apiKey);
      return this;
    }
  }
  throw new RuntimeException("No API key authentication configured!");
}
 

/**
 * Helper method to configure authentications which respects aliases of API keys.
 *
 * @param secrets Hash map from authentication name to its secret.
 */
public ApiClient configureApiKeys(HashMap<String, String> secrets) {
  for (Map.Entry<String, Authentication> authEntry : authentications.entrySet()) {
    Authentication auth = authEntry.getValue();
    if (auth instanceof ApiKeyAuth) {
      String name = authEntry.getKey();
      // respect x-auth-id-alias property
      name = authenticationLookup.containsKey(name) ? authenticationLookup.get(name) : name;
      if (secrets.containsKey(name)) {
        ((ApiKeyAuth) auth).setApiKey(secrets.get(name));
      }
    }
  }
  return this;
}