com.softlayer.api.http.HttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation

API client for accessing the SoftLayer API

There is a newer version: 0.3.4

package com.softlayer.api.http;

import java.io.Closeable;
import java.io.OutputStream;
import java.util.concurrent.Callable;
import java.util.concurrent.Future;

import com.softlayer.api.ResponseHandler;

/**
 * This class is not thread-safe even when using invoke async. This class will only live for the
 * duration of one HTTP request.
 */
public interface HttpClient extends Closeable {

    /** Stream to write body contents to (if at all). When called, callers are expected to close it. */
    OutputStream getBodyStream();
    
    /** Make synchronous HTTP invocation. Throws if unable to connect. Errors from the API are returned normally. */
    HttpResponse invokeSync(Callable setupBody);
    
    /** Make asynchronous HTTP invocation. All errors (inability to connect or API errors) are in the future. */
    Future invokeAsync(Callable setupBody);
    
    /** Callback-form of {@link #invokeAsync(Callable)} */
    Future invokeAsync(Callable setupBody, ResponseHandler callback);
}