com.xeiam.xchange.ExchangeSpecification Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xchange-core Show documentation
Core functionality used by all other modules.
There is a newer version: 3.1.0
/**
 * Copyright (C) 2012 - 2013 Xeiam LLC http://xeiam.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.xeiam.xchange;

import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * 
 * Specification to provide the following to {@link ExchangeFactory}:
 * 
 * 
 * Provision of required exchangeSpecificParameters for creating an {@link Exchange}
 * Provision of optional exchangeSpecificParameters for additional configuration
 * 
 */
public class ExchangeSpecification {

  @JsonProperty
  private String exchangeName;

  @JsonProperty
  private String exchangeDescription;

  @JsonProperty
  private Double tradeFeePercent = Double.valueOf(0.0);

  @JsonProperty
  private String minTradeFee;

  @JsonProperty
  private String userName;

  @JsonProperty
  private String password;

  @JsonProperty
  private String secretKey;

  @JsonProperty
  private String apiKey;

  @JsonProperty
  private String sslUri;

  @JsonProperty
  private String plainTextUri;

  @JsonProperty
  private String host;

  @JsonProperty
  private int port = 80;

  private final String exchangeClassName;

  @JsonProperty
  private Map exchangeSpecificParameters = new HashMap();

  /**
   * Dynamic binding
   * 
   * @param exchangeClassName The exchange class name (e.g. "com.xeiam.xchange.mtgox.v1.MtGoxExchange")
   */
  @JsonCreator
  public ExchangeSpecification(@JsonProperty("exchangeClassName") String exchangeClassName) {

    this.exchangeClassName = exchangeClassName;
  }

  /**
   * Static binding
   * 
   * @param exchangeClass The exchange class
   */
  public ExchangeSpecification(Class exchangeClass) {

    this.exchangeClassName = exchangeClass.getCanonicalName();
  }

  /**
   * @return The exchange class name for loading at runtime
   */
  public String getExchangeClassName() {

    return exchangeClassName;
  }

  /**
   * @param key The key into the parameter map (recommend using the provided standard static entries)
   * @return Any additional exchangeSpecificParameters that the {@link Exchange} may consume to configure services
   */
  public Object getParameter(String key) {

    return exchangeSpecificParameters.get(key);
  }

  /**
   * The host name of the server providing data (e.g. "intersango.com")
   */
  public String getHost() {

    return host;
  }

  public void setHost(String host) {

    this.host = host;
  }

  /**
   * The API key. For MtGox this would be the "Rest-Key" field
   */
  public String getApiKey() {

    return apiKey;
  }

  public void setApiKey(String apiKey) {

    this.apiKey = apiKey;
  }

  /**
   * The port number of the server providing direct socket data (e.g. "1337")
   */
  public int getPort() {

    return port;
  }

  public void setPort(int port) {

    this.port = port;
  }

  /**
   * The API secret key typically used in HMAC signing of requests. For MtGox this would be the "Rest-Sign" field
   */
  public String getSecretKey() {

    return secretKey;
  }

  public void setSecretKey(String secretKey) {

    this.secretKey = secretKey;
  }

  /**
   * The URI to reach the root of the exchange API for SSL queries

   * (e.g. use "https://example.com:8443/exchange", not "https://example.com:8443/exchange/api/v3/trades")
   */
  public String getSslUri() {

    return sslUri;
  }

  public void setSslUri(String uri) {

    this.sslUri = uri;
  }

  /**
   * The URI to reach the root of the exchange API for plaintext (non-SSL) queries

   * (e.g. use "http://example.com:8443/exchange", not "http://example.com:8443/exchange/api/v3/trades")
   */
  public String getPlainTextUri() {

    return plainTextUri;
  }

  public void setPlainTextUri(String plainTextUri) {

    this.plainTextUri = plainTextUri;
  }

  /**
   * Allows arbitrary exchange-specific parameters to be passed to the exchange implementation
   */
  public Map getExchangeSpecificParameters() {

    return exchangeSpecificParameters;
  }

  public void setExchangeSpecificParameters(Map exchangeSpecificParameters) {

    this.exchangeSpecificParameters = exchangeSpecificParameters;
  }

  /**
   * The password for authentication
   */
  public String getPassword() {

    return password;
  }

  public void setPassword(String password) {

    this.password = password;
  }

  /**
   * The username for authentication
   */
  public String getUserName() {

    return userName;
  }

  public void setUserName(String userName) {

    this.userName = userName;
  }

  /**
   * @return The exchange name (e.g. "Mt Gox")
   */
  public String getExchangeName() {

    return exchangeName;
  }

  public void setExchangeName(String exchangeName) {

    this.exchangeName = exchangeName;
  }

  /**
   * @return The exchange description (e.g. "Major exchange specialising in USD, EUR, GBP")
   */
  public String getExchangeDescription() {

    return exchangeDescription;
  }

  public void setExchangeDescription(String exchangeDescription) {

    this.exchangeDescription = exchangeDescription;
  }

  /**
   * Some exchanges offer a sliding scale that is earned based on trade history so this is normally set externally
   * 
   * @return The fee per trade expressed as a percentage (e.g. 0.6 is 0.6%)
   */
  public Double getTradeFeePercent() {

    return tradeFeePercent;
  }

  public void setTradeFeePercent(Double tradeFeePercent) {

    this.tradeFeePercent = tradeFeePercent;
  }

  /**
   * Some exchanges offer a sliding scale that is earned based on trade history so this is normally set externally
   * 
   * @return The minimum fee per trade expressed in the exchange's local currency (e.g. "USD 0.25")
   */
  public String getMinTradeFee() {

    return minTradeFee;
  }

  public void setMinTradeFee(String minTradeFee) {

    this.minTradeFee = minTradeFee;
  }
}