• Home
• com.opengamma.sdk
• sdk-common
• 2.4.0
• source code
• Credentials.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.opengamma.sdk.common.auth.Credentials Maven / Gradle / Ivy

/*
 * Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.sdk.common.auth;

/**
 * Credentials used to authenticate with the service.
 *
 * @deprecated Since 1.3.0. Replaced by an exact copy: {@link com.opengamma.sdk.common.auth.v3.Credentials}.
 *   The current interface will be removed in future versions.
 */
@Deprecated
public interface Credentials {

  /**
   * Obtains credentials using an API key and secret.
   * 

   * This is the recommended way to connect.
   * 
   * @param apiKey  the API key
   * @param secret  the secret
   * @return the credentials
   */
  public static Credentials ofApiKey(String apiKey, String secret) {
    return ApiKeyCredentials.of(apiKey, secret);
  }

  /**
   * Obtains credentials using username and password.
   * 
   * @param username  the username
   * @param password  the password
   * @return the credentials
   */
  public static Credentials ofUsernamePassword(String username, String password) {
    return UserPasswordCredentials.of(username, password);
  }

  //-------------------------------------------------------------------------
  /**
   * Authenticates, returning an access token.
   * 
   * @param client  the client to authenticate with
   * @return the access token result
   * @throws RuntimeException if the token cannot be obtained
   */
  public abstract AccessTokenResult authenticate(AuthClient client);

}