All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.algorithmia.Algorithmia Maven / Gradle / Ivy

There is a newer version: 1.0.16
Show newest version
package com.algorithmia;

import com.algorithmia.algo.*;
import com.algorithmia.client.*;
import com.algorithmia.data.*;

/**
 * Instantiate Algorithmia clients for calling algorithms and accessing data
 */
public final class Algorithmia {
    private static final int DEFAULT_MAX_CONNECTIONS = 10;
    private static AlgorithmiaClient defaultClient = null;

    private Algorithmia() {} // Not instantiable

    /**
     * Returns the default Algorithmia client which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client() {
        return getDefaultClient();
    }

    /**
     * Returns the default Algorithmia client which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @param maxConnections max number of concurrent connections to hold open to Algorithmia
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client(int maxConnections) {
        return new AlgorithmiaClient(null, null, maxConnections);
    }

    /**
     * Builds an Algorithmia client that makes all requests with your API key
     * If API key is null, the default client is returned, which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @param simpleKey API Key for simple authentication (prefixed with "sim")
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client(String simpleKey) {
        return new AlgorithmiaClient(new SimpleAuth(simpleKey), null, DEFAULT_MAX_CONNECTIONS);
    }

    /**
     * Builds an Algorithmia client that makes all requests with your API key
     * If API key is null, the default client is returned, which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @param simpleKey API Key for simple authentication (prefixed with "sim")
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client(String simpleKey, String apiAddress) {
        return new AlgorithmiaClient(new SimpleAuth(simpleKey), apiAddress, DEFAULT_MAX_CONNECTIONS);
    }

    /**
     * Builds an Algorithmia client that makes all requests with your API key
     * If API key is null, the default client is returned, which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @param simpleKey API Key for simple authentication (prefixed with "sim")
     * @param maxConnections max number of concurrent connections to hold open to Algorithmia
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client(String simpleKey, int maxConnections) {
        return new AlgorithmiaClient(new SimpleAuth(simpleKey), null, maxConnections);
    }

    /**
     * Builds an Algorithmia client that makes all requests with your API key
     * If API key is null, the default client is returned, which will
     * look for ALGORITHMIA_API_KEY environment variable or java property
     * If no key is found, then requests will be unauthenticated which only works
     * when making requests from an algorithm running within the Algorithmia cluster
     * @param simpleKey API Key for simple authentication (prefixed with "sim")
     * @param maxConnections max number of concurrent connections to hold open to Algorithmia
     * @return an Algorithmia client
     */
    public static AlgorithmiaClient client(String simpleKey, String apiAddress, int maxConnections) {
        return new AlgorithmiaClient(new SimpleAuth(simpleKey), apiAddress, maxConnections);
    }

    /**
     * Initialize an Algorithm object using the default client
     * @param algoUri the algorithm's URI, e.g., algo://user/algoname
     * @return an Algorithm client for the specified algorithm
     */
    public static Algorithm algo(String algoUri) {
        return getDefaultClient().algo(algoUri);
    }

   /**
     * Initialize a DataDirectory object using the default client
     * @param path to a data directory, e.g., data://.my/foo
     * @return a DataDirectory client for the specified directory
     */
    public static DataDirectory dir(String path) {
        return getDefaultClient().dir(path);
    }

    /**
     * Initialize an DataFile object using the default client
     * @param path to a data file, e.g., data://.my/foo/bar.txt
     * @return a DataFile client for the specified file
     */
    public static DataFile file(String path) {
        return getDefaultClient().file(path);
    }

    private static AlgorithmiaClient getDefaultClient() {
        if(defaultClient == null) {
            defaultClient = new AlgorithmiaClient(null, null, DEFAULT_MAX_CONNECTIONS);
        }
        return defaultClient;
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy