com.unbxd.client.Unbxd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unbxd-java-sdk Show documentation
The project is a Unbxd Java Library
The newest version!
package com.unbxd.client;

import com.unbxd.client.autosuggest.AutoSuggestClient;
import com.unbxd.client.autosuggest.AutoSuggestClientFactory;
import com.unbxd.client.feed.FeedClient;
import com.unbxd.client.feed.FeedClientFactory;
import com.unbxd.client.recommendations.RecommendationsClient;
import com.unbxd.client.recommendations.RecommendationsClientFactory;
import com.unbxd.client.search.SearchClient;
import com.unbxd.client.search.SearchClientFactory;
import org.apache.http.client.HttpClient;
import org.apache.http.impl.client.CloseableHttpClient;

/**
 * Created with IntelliJ IDEA.
 * User: sourabh
 * Date: 07/07/14
 * Time: 3:21 PM
 *
 * http://unbxd.com/docs/
 *
 * Class to configure and retrieve clients.
 */
public class Unbxd {

    private static boolean _configured = false;

    private static String siteKey;
    private static String apiKey;
    private static String secretKey;
    private static boolean secure = false;
    private static CloseableHttpClient httpClient;

    private Unbxd(){}

    /**
     * Configure Unbxd Client. This method should be called while initializing you application.
     * If you don't know the configuration details please get in touch with [email protected]
     *
     * @param siteKey The Unique Identifier for Site created on Unbxd Platform
     * @param apiKey API key for calling read APIs
     * @param secretKey API key for calling Feed APIs
     */
    public static void configure(String siteKey, String apiKey, String secretKey){
        Unbxd.siteKey = siteKey;
        Unbxd.apiKey = apiKey;
        Unbxd.secretKey = secretKey;
        Unbxd.httpClient = HttpClientManager.getHttpClient(ConnectionManager.getConnectionManager());

        _configured = true;
    }

    /**
     * Configure Unbxd Client. This method should be called while initializing you application.
     * If you don't know the configuration details please get in touch with [email protected]
     *
     * @param siteKey The Unique Identifier for Site created on Unbxd Platform
     * @param apiKey API key for calling read APIs
     * @param secretKey API key for calling Feed APIs
     * @param secure True to use HTTPS while making REST API calls
     */
    public static void configure(String siteKey, String apiKey, String secretKey, boolean secure){
        Unbxd.configure(siteKey, apiKey, secretKey);
        Unbxd.secure = secure;
    }

    /**
     * Should return a new Feed Client
     * @return {@link FeedClient}
     * @throws ConfigException
     */
    public static FeedClient getFeedClient() throws ConfigException {
        if(!_configured)
            throw new ConfigException("Please configure first with Unbxd.configure()");
        return FeedClientFactory.getFeedClient(siteKey, secretKey, secure);
    }

    /**
     * Should return a new Search Client
     * @return {@link SearchClient}
     * @throws ConfigException
     */
    public static SearchClient getSearchClient() throws ConfigException {
        if(!_configured)
            throw new ConfigException("Please configure first with Unbxd.configure()");
        return SearchClientFactory.getSearchClient(siteKey, apiKey, secure, httpClient);
    }

    /**
     * Should return a new Autosuggest Client
     * @return {@link AutoSuggestClient}
     * @throws ConfigException
     */
    public static AutoSuggestClient getAutoSuggestClient() throws ConfigException {
        if(!_configured)
            throw new ConfigException("Please configure first with Unbxd.configure()");
        return AutoSuggestClientFactory.getAutoSuggestClient(siteKey, apiKey, secure, httpClient);
    }

    /**
     * Should return a new Recommendations Client
     * @return {@link RecommendationsClient}
     * @throws ConfigException
     */
    public static RecommendationsClient getRecommendationsClient() throws ConfigException {
        if(!_configured)
            throw new ConfigException("Please configure first with Unbxd.configure()");
        return RecommendationsClientFactory.getRecommendationsClient(siteKey, apiKey, secure, httpClient);
    }
}