com.groupbyinc.api.CloudBridge Maven / Gradle / Ivy

Go to download
package com.groupbyinc.api;

import com.groupbyinc.api.model.AbstractRecord;
import com.groupbyinc.api.model.Record;
import com.groupbyinc.api.model.RefinementsResult;
import com.groupbyinc.api.model.Results;
import com.groupbyinc.api.request.Request;
import com.groupbyinc.common.jackson.core.Version;
import com.groupbyinc.common.jackson.databind.Module;
import com.groupbyinc.common.jackson.databind.module.SimpleModule;
import com.groupbyinc.common.jackson.Mappers;

import java.io.IOException;
import java.io.InputStream;

/**
 * ==============================================================================
 * All addition to this class should also be made to Bridge until such time
 * that the documentation server can handle more than two levels of inheritance
 * ==============================================================================
 *
 * @author Ben Teichman
 */
public class CloudBridge extends AbstractBridge {

    public static Module RECORD_MAPPER = new SimpleModule("RecordModule", new Version(1, 0, 0, null, null, null)).addAbstractTypeMapping(AbstractRecord.class, Record.class);
    private static final String DOT = ".";
    private static final String CLOUD_HOST = "groupbycloud.com";
    private static final int CLOUD_PORT = 443;
    private static final String CLOUD_PATH = "/api/v1";
    private static final String URL_SUFFIX = DOT + CLOUD_HOST + COLON + CLOUD_PORT + CLOUD_PATH;

    /**
     * 
     * Constructor to create a bridge object that connects to the search api.
     * JSON Reference:
     * The key as found in your key management page in the command center
     * {"clientKey": "--clientKey--"}
     * 
     *
     * @param clientKey
     *         The key as found in your key management page in the command
     *         center.
     * @param customerId
     *         The name of your subdomain.  For example, https://--customerId--.groupbycloud.com
     */
    public CloudBridge(String clientKey, String customerId) {
        super(clientKey, HTTPS + customerId + URL_SUFFIX);
    }

    @Override
    protected Results map(InputStream data, boolean returnBinary) {
        return Mappers.readValue(data, Results.class, returnBinary, RECORD_MAPPER);
    }

    @Override
    protected RefinementsResult mapRefinements(InputStream data, boolean returnBinary) {
        return Mappers.readValue(data, RefinementsResult.class, returnBinary, RECORD_MAPPER);
    }

    /**
     * 
     * Connects to the refinements service, parses the response into a model
     * Retrieves at most 10,000 refinements for the navigation specified.
     * 
     *
     * @param query
     *         A query representing the search.
     * @param navigationName
     *         The name of the navigation to get more refinements for.
     *
     * @return RefinementsResult object from the refinements service
     *
     * @throws IOException
     */
    @Override
    public RefinementsResult refinements(Query query, String navigationName) throws IOException {
        return super.refinements(query, navigationName);
    }

}