org.openapitools.client.auth.Authentication 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);
}
 

/**
 * 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.
 * @param apiKeyPrefix the 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 username for the first HTTP basic authentication.
 */
public void setUsername(String username) {
  for (Authentication auth : authentications.values()) {
     if (auth instanceof HttpBasicAuth) {
         ((HttpBasicAuth) auth).setUsername(username);
         return;
     }
  }
  throw new RuntimeException("No HTTP basic 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!");
}
 

/**
 * Update query and header parameters based on authentication settings.
 *
 * @param authNames The authentications to apply
 */
private void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
  for (String authName : authNames) {
    Authentication auth = authentications.get(authName);
    if (auth == null) throw new RuntimeException("Authentication undefined: " + authName);
      auth.applyToParams(queryParams, headerParams);
  }
}
 

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 configure the token endpoint of the first oauth found in the apiAuthorizations (there should be only one)
 *
 * @return Token request builder
 */
public TokenRequestBuilder getTokenEndPoint() {
    for (Authentication apiAuth : authentications.values()) {
        if (apiAuth instanceof RetryingOAuth) {
            RetryingOAuth retryingOAuth = (RetryingOAuth) apiAuth;
            return retryingOAuth.getTokenRequestBuilder();
        }
    }
    return null;
}
 

/**
 * 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!");
}
 

/**
 * Update query and header parameters based on authentication settings.
 *
 * @param authNames The authentications to apply
 */
private void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
  for (String authName : authNames) {
    Authentication auth = authentications.get(authName);
    if (auth == null) throw new RuntimeException("Authentication undefined: " + authName);
      auth.applyToParams(queryParams, headerParams);
  }
}
 

/**
 * Helper method to set username for the first HTTP basic authentication.
 * @param username Username
 */
public void setUsername(String username) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof HttpBasicAuth) {
      ((HttpBasicAuth) auth).setUsername(username);
      return;
    }
  }
  throw new RuntimeException("No HTTP basic authentication configured!");
}
 

/**
 * Helper method to set password for the first HTTP basic authentication.
 * @param password Password
 */
public void setPassword(String password) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof HttpBasicAuth) {
      ((HttpBasicAuth) auth).setPassword(password);
      return;
    }
  }
  throw new RuntimeException("No HTTP basic authentication configured!");
}
 

/**
 * Helper method to set username for the first HTTP basic authentication.
 * @param username Username
 */
public void setUsername(String username) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof HttpBasicAuth) {
      ((HttpBasicAuth) auth).setUsername(username);
      return;
    }
  }
  throw new RuntimeException("No HTTP basic authentication configured!");
}
 

/**
 * Helper method to set password for the first HTTP basic authentication.
 */
public void setPassword(String password) {
  for (Authentication auth : authentications.values()) {
     if (auth instanceof HttpBasicAuth) {
        ((HttpBasicAuth) auth).setPassword(password);
        return;
     }
  }
  throw new RuntimeException("No HTTP basic authentication configured!");
}
 

/**
 * Update query and header parameters based on authentication settings.
 *
 * @param authNames The authentications to apply
 */
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, MultiMap headerParams, MultiMap cookieParams) {
    for (String authName : authNames) {
        Authentication auth = authentications.get(authName);
        if (auth == null) throw new RuntimeException("Authentication undefined: " + authName);
        auth.applyToParams(queryParams, headerParams, cookieParams);
    }
}
 

/**
 * Helper method to set access token for the first OAuth2 authentication.
 *
 * @param accessToken Access token
 */
public ApiClient setAccessToken(String accessToken) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof OAuth) {
            ((OAuth) auth).setAccessToken(accessToken);
            return this;
        }
    }
    throw new RuntimeException("No OAuth2 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.
 *
 * @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 set password for the first HTTP basic authentication.
 *
 * @param password Password
 */
public ApiClient setPassword(String password) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof HttpBasicAuth) {
            ((HttpBasicAuth) auth).setPassword(password);
            return this;
        }
    }
    throw new RuntimeException("No HTTP basic 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 access token for the first Bearer authentication.
 * @param bearerToken Bearer token
 */
public ApiClient setBearerToken(String bearerToken) {
    for (Authentication auth : authentications.values()) {
        if (auth instanceof HttpBearerAuth) {
            ((HttpBearerAuth) auth).setBearerToken(bearerToken);
            return this;
        }
    }
    throw new RuntimeException("No Bearer authentication configured!");
}
 

/**
 * Helper method to set access token for the first OAuth2 authentication.
 * @param accessToken Access token
 */
public void setAccessToken(String accessToken) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof OAuth) {
      ((OAuth) auth).setAccessToken(accessToken);
      return;
    }
  }
  throw new RuntimeException("No OAuth2 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!");
}
 

/**
 * Update query and header parameters based on authentication settings.
 *
 * @param authNames The authentications to apply
 * @param queryParams List of query parameters
 * @param headerParams Map of header parameters
 * @param cookieParams Map of cookie parameters
 * @param method HTTP method (e.g. POST)
 * @param uri HTTP URI
 */
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams,
                                   Map<String, String> cookieParams, String payload, String method, URI uri) throws ApiException {
  for (String authName : authNames) {
    Authentication auth = authentications.get(authName);
    if (auth == null) {
      continue;
    }
    auth.applyToParams(queryParams, headerParams, cookieParams, payload, method, uri);
  }
}
 

/**
 * Helper method to set the scopes for the first OAuth2 authentication.
 *
 * @param scope the oauth scope
 */
public ApiClient setOauthScope(String scope) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof OAuth) {
      ((OAuth) auth).setScope(scope);
      return this;
    }
  }
  throw new RuntimeException("No OAuth2 authentication configured!");
}
 

/**
 * Helper method to set the authorization code flow for the first OAuth2 authentication.
 *
 * @param code the authorization code
 */
public ApiClient setOauthAuthorizationCodeFlow(String code) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof OAuth) {
      ((OAuth) auth).useAuthorizationCodeFlow(code);
      return this;
    }
  }
  throw new RuntimeException("No OAuth2 authentication configured!");
}
 

/**
 * Helper method to set the password flow for the first OAuth2 authentication.
 *
 * @param username the user name
 * @param password the user password
 */
public ApiClient setOauthPasswordFlow(String username, String password) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof OAuth) {
      ((OAuth) auth).usePasswordFlow(username, password);
      return this;
    }
  }
  throw new RuntimeException("No OAuth2 authentication configured!");
}
 

/**
 * Helper method to set the credentials for the first OAuth2 authentication.
 *
 * @param clientId the client ID
 * @param clientSecret the client secret
 */
public ApiClient setOauthCredentials(String clientId, String clientSecret) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof OAuth) {
      ((OAuth) auth).setCredentials(clientId, clientSecret, isDebugging());
      return this;
    }
  }
  throw new RuntimeException("No OAuth2 authentication configured!");
}
 

/**
 * Helper method to set bearer token for the first Bearer authentication.
 *
 * @param bearerToken Bearer token
 */
public ApiClient setBearerToken(String bearerToken) {
  for (Authentication auth : authentications.values()) {
    if (auth instanceof HttpBearerAuth) {
      ((HttpBearerAuth) auth).setBearerToken(bearerToken);
      return this;
    }
  }
  throw new RuntimeException("No Bearer authentication configured!");
}
 

/**
 * Helper method to set password for the first HTTP basic authentication.
 */
public void setPassword(String password) {
  for (Authentication auth : authentications.values()) {
     if (auth instanceof HttpBasicAuth) {
        ((HttpBasicAuth) auth).setPassword(password);
        return;
     }
  }
  throw new RuntimeException("No HTTP basic authentication configured!");
}