com.coinbase.api.CoinbaseBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coinbase-java Show documentation
A first-party java wrapper around the Coinbase API
There is a newer version: 1.10.0
package com.coinbase.api;

import java.net.URL;

import javax.net.ssl.SSLContext;

public class CoinbaseBuilder {

    String access_token;
    String api_key;
    String api_secret;
    String acct_id;
    SSLContext ssl_context;
    URL base_oauth_url;
    URL base_api_url;

    /**
     * Build a new Coinbase client object with the specified options
     * 
     * @return a new Coinbase client object
     */
    public Coinbase build() {
	return new CoinbaseImpl(this);
    }

    /**
     * Specify an access token to be used for authenticated requests
     * 
     * Coinbase client objects built using an access token are thread-safe
     * 
     * @param access_token the OAuth access token
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withAccessToken(String access_token) {
	this.access_token = access_token;
	return this;
    }

    /**
     * Specify the HMAC api key and secret to be used for authenticated requests
     * 
     * Having more than one client with the same api/secret globally is unsupported
     * and will result in sporadic auth errors as the nonce is calculated from the system time.
     * 
     * @param api_key the HMAC API Key
     * @param api_secret the HMAC API Secret
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withApiKey(String api_key, String api_secret) {
	this.api_key = api_key;
	this.api_secret = api_secret;
	return this;
    }

    /**
     * Specify the account id to be used for account-specific requests
     * 
     * @param acct_id the account id
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withAccountId(String acct_id) {
	this.acct_id = acct_id;
	return this;
    }
    
    /**
     * Specify the ssl context to be used when creating SSL sockets
     * 
     * @param ssl_context the SSLContext to be used
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withSSLContext(SSLContext ssl_context) {
        this.ssl_context = ssl_context;
        return this;
    }
    
    /**
     * Specify the base URL to be used for API requests
     * 
     * By default, this is 'https://coinbase.com/api/v1/'
     * 
     * @param base_api_url the base URL to use for API requests. Must return an instance of javax.net.ssl.HttpsURLConnection on openConnection.
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withBaseApiURL(URL base_api_url) {
        this.base_api_url = base_api_url;
        return this;
    }
    
    /**
     * Specify the base URL to be used for OAuth requests
     * 
     * By default, this is 'https://coinbase.com/oauth/'
     * 
     * @param base_oauth_url the base URL to use for OAuth requests. Must return an instance of javax.net.ssl.HttpsURLConnection on openConnection.
     * 
     * @return this CoinbaseBuilder object
     */
    public CoinbaseBuilder withBaseOAuthURL(URL base_oauth_url) {
        this.base_oauth_url = base_oauth_url;
        return this;
    }
    
}