io.keen.client.java.http.OutputSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keen-client-java-core Show documentation

Java Client Core Library for Keen

There is a newer version: 6.0.0

Show newest version

package io.keen.client.java.http;

import java.io.IOException;
import java.io.OutputStream;

/**
 * Interface to allow writing to an {@link java.io.OutputStream} - in particular the output stream
 * of an HTTP request - directly from a source. This avoids having to write into a buffer, pass the
 * buffer to the request handler, and then have the handler copy the buffer to the connection's
 * output stream.
 *
 * @author Kevin Litwack ([email protected])
 * @since 2.0.0
 */
public interface OutputSource {

    /**
     * Writes data to the given {@link java.io.OutputStream}. This method is used to send the body
     * of an HTTP request.
     * 
     * Implementers of this method should NOT close {@code out}; the calling code will ensure
     * that it is closed.
     *
     * @param out The {@link java.io.OutputStream} to which the request body should be written.
     * @throws java.io.IOException Implementers may throw an IOException if an error is encountered
     *                     while writing.
     */
    void writeTo(OutputStream out) throws IOException;

}