com.zipwhip.api.NingHttpConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zipwhip-api Show documentation
Java client to support applications powered by the Zipwhip Cloud
The newest version!
package com.zipwhip.api;

import com.ning.http.client.*;
import com.ning.http.multipart.FilePart;
import com.zipwhip.api.request.RequestBuilder;
import com.zipwhip.concurrent.DefaultObservableFuture;
import com.zipwhip.concurrent.ObservableFuture;
import com.zipwhip.lifecycle.CascadingDestroyableBase;
import com.zipwhip.util.CollectionUtil;
import com.zipwhip.util.SignTool;
import com.zipwhip.util.StringUtil;
import com.zipwhip.util.UrlUtil;
import org.apache.log4j.Logger;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Executor;

/**
 * Provides a persistent connection to a User on Zipwhip.
 * 
 * You initialize this class with a sessionKey or apiKey and then can execute raw requests
 * on behalf of the user. If you want a more Object oriented way to interact
 * with Zipwhip, use Consumer instead of Connection.
 * 

 * This class is thread safe.
 */
public class NingHttpConnection extends CascadingDestroyableBase implements ApiConnection {

    private static final Logger LOGGER = Logger.getLogger(NingHttpConnection.class);

    private String apiVersion = DEFAULT_API_VERSION;
    private String host = ApiConnectionConfiguration.API_HOST;

    private String sessionKey;
    private SignTool authenticator;

    private AsyncHttpClient asyncHttpClient = null;
    private Executor workerExecutor = null;
    private ProxyServer proxyServer = null;

    /**
     * Create a new {@code NingHttpConnection}
     *
     * @param workerExecutor This importantTaskExecutor is what your code will execute in. Our recommendation is that it's large
     *                       because we have no idea how slow your code will be.
     * @throws IllegalArgumentException if workerExecutor is null
     */
    public NingHttpConnection(final Executor workerExecutor) {
        this(workerExecutor, (ProxyServer) null);
    }

    /**
     * Create a new {@code NingHttpConnection}
     *
     * @param apiKey Used by a {@code SignTool} to sign request URLs.
     * @param secret Used by a {@code SignTool} to sign request URLs.
     * @throws Exception If an error is encountered creating the {@code SignTool}.
     */
    public NingHttpConnection(final Executor workerExecutor, final String apiKey, final String secret) throws Exception {
        this(workerExecutor, new SignTool(apiKey, secret));
    }

    /**
     * Create a new {@code NingHttpConnection}
     *
     * @param workerExecutor This importantTaskExecutor is what your code will execute in. Our recommendation is that it's large
     *                       because we have no idea how slow your code will be.
     * @param authenticator  A {@code SignTool} to use for signing request URLs.
     * @throws IllegalArgumentException if workerExecutor is null
     */
    public NingHttpConnection(final Executor workerExecutor, final SignTool authenticator) {
        this(workerExecutor, null, authenticator);
    }

    /**
     * Create a new {@code NingHttpConnection}
     *
     * @param workerExecutor This importantTaskExecutor is what your code will execute in. Our recommendation is that it's large
     *                       because we have no idea how slow your code will be.
     * @throws IllegalArgumentException if workerExecutor is null
     */
    public NingHttpConnection(final Executor workerExecutor, final ProxyServer proxyServer) {
        this(workerExecutor, proxyServer, (SignTool) null);
    }

    /**
     * Create a new {@code NingHttpConnection}
     *
     * @param workerExecutor This importantTaskExecutor is what your code will execute in. Our recommendation is that it's large
     *                       because we have no idea how slow your code will be.
     * @param authenticator  A {@code SignTool} to use for signing request URLs.
     * @throws IllegalArgumentException if workerExecutor is null
     */
    public NingHttpConnection(final Executor workerExecutor, final ProxyServer proxyServer, final SignTool authenticator) {
        if (workerExecutor == null) throw new IllegalArgumentException("workerExecutor cannot be null");

        this.workerExecutor = workerExecutor;
        this.proxyServer = proxyServer;
        this.authenticator = authenticator;

        // init the http client
        init();
    }

    private void init() {
        final AsyncHttpClientConfig.Builder builder = new AsyncHttpClientConfig.Builder();
        if (getProxyServer() != null) builder.setProxyServer(getProxyServer());
        builder.setConnectionTimeoutInMs(10000);
        asyncHttpClient = new AsyncHttpClient(builder.build());
    }

    @Override
    public void setAuthenticator(SignTool authenticator) {
        this.authenticator = authenticator;
    }

    @Override
    public SignTool getAuthenticator() {
        return this.authenticator;
    }

    @Override
    public void setHost(String host) {
        this.host = host;
    }

    @Override
    public String getHost() {
        return host;
    }

    @Override
    public void setApiVersion(String apiVersion) {
        this.apiVersion = apiVersion;
    }

    @Override
    public String getApiVersion() {
        return apiVersion;
    }

    @Override
    public void setSessionKey(String sessionKey) {
        LOGGER.debug("Setting sessionKey to " + sessionKey);
        this.sessionKey = sessionKey;
    }

    @Override
    public String getSessionKey() {
        LOGGER.debug("Getting sessionKey " + sessionKey);
        return sessionKey;
    }

    @Override
    public boolean isAuthenticated() {
        return StringUtil.exists(sessionKey) || (authenticator != null && authenticator.prepared());
    }

    @Override
    public boolean isConnected() {
        return isAuthenticated();
    }

    /**
     * @param method Each method has a name, example: user/get. See {@link ZipwhipNetworkSupport} for fields.
     * @param params Map of query params to append to the method
     * @return NetworkFuture  where the String result is the raw serer response.
     */
    @Override
    public ObservableFuture send(final String method, Map params) throws Exception {
        return send(method, params, null);
    }

    /**
     * @param method Each method has a name, example: user/get. See {@link ZipwhipNetworkSupport} for fields.
     * @param params Map of query params to append to the method
     * @param files  A list of Files to be added as parts for a multi part upload.
     * @return NetworkFuture  where the String result is the raw serer response.
     */
    @Override
    public ObservableFuture send(String method, Map params, List files) throws Exception {

        final RequestBuilder rb = new RequestBuilder();

        // convert the map into a key/value HTTP params string
        rb.params(params);

        final ObservableFuture responseFuture = new DefaultObservableFuture(this, workerExecutor);

        try {
            com.ning.http.client.RequestBuilder builder = new com.ning.http.client.RequestBuilder();

            /**
             * The next 4 lines are needed because of a bug in Ning in NettyAsyncHttpProvider.java.
             * Ning has not implemented multipart upload over SSH. If we are using HTTPS some files
             * will result in a loop which can crash the JVM with an out of memory exception.
             *
             * https://issues.sonatype.org/browse/AHC-78
             */
            String toUseHost = host;

            if (toUseHost.startsWith("https")) {
                toUseHost = toUseHost.replaceFirst("https", "http");
            }

            builder.setUrl(UrlUtil.getSignedUrl(toUseHost, apiVersion, method, rb.build(), sessionKey, authenticator));

            if (CollectionUtil.exists(files)) {

                builder.setMethod("POST");

                for (File file : files) {
                    /**
                     * TODO The first argument "data" is required for the TinyUrlController to work.
                     * Unfortunately this breaks the HostedContentController if more than one file
                     * is being uploaded. TinyUrlController needs to be fixed to get the file names
                     * from the fileMap as HostedContentController does.
                     */
                    Part part = new FilePart("data", file, "multipart/form-data", null);
                    builder.addBodyPart(part);
                }
            }

            final Request request = builder.build();
            LOGGER.debug("==> Cloud Request: " + request.getUrl());
            asyncHttpClient.prepareRequest(request).execute(new AsyncCompletionHandler