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

Go to download
package com.zipwhip.api;

import com.zipwhip.concurrent.ObservableFuture;
import com.zipwhip.lifecycle.Destroyable;

import java.io.File;
import java.io.InputStream;
import java.util.List;
import java.util.Map;

/**
 * A connection encapsulates the way to communicate on behalf of user.
 * 
 * A connection needs to be authenticated as a specific user.
 *
 * @author Michael
 */
public interface Connection extends Destroyable {

    /**
     * Determines if this connection is authenticated with Zipwhip, if it has the
     * necessary communication fields.
     *
     * @return true if authenticated otherwise false
     */
    boolean isAuthenticated();

    /**
     * Determines if the connection is available/stable.
     *
     * @return true if connected otherwise false.
     */
    boolean isConnected();

    /**
     * Execute a call to the Zipwhip API ASYNCHRONOUSLY.
     *
     * @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 A ObservableFuture task which will return the response body as a String on completion.
     * @throws Exception is an error is encountered communicating with Zipwhip or parsing a response
     */
    ObservableFuture send(String method, Map params) throws Exception;

}