net.gotev.uploadservice.http

Interface HttpConnection

All Known Implementing Classes:

HurlStackConnection

public interface HttpConnection

Defines the methods that has to be implemented by an HTTP connection. If you're implementing your custom HTTP connection, remember to never cache anything, especially in BodyWriter methods, as this will surely cause memory issues when uploading large files. The only things which you are allowed to cache are the response code and body from the server, which must not be large though.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpConnection.RequestBodyDelegate Delegate called when the body is ready to be written.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection and frees all the allocated resources.
ServerResponse	getResponse(HttpConnection.RequestBodyDelegate delegate) Gets the server response.
HttpConnection	setHeaders(List<NameValue> requestHeaders) Set request headers.
HttpConnection	setTotalBodyBytes(long totalBodyBytes, boolean isFixedLengthStreamingMode) Sets the total body bytes.

Method Detail

setHeaders

HttpConnection setHeaders(List<NameValue> requestHeaders)
                   throws IOException

Set request headers.

Parameters:

requestHeaders - request headers to set

Returns:

instance

Throws:

IOException - if an error occurs while setting request headers

setTotalBodyBytes

HttpConnection setTotalBodyBytes(long totalBodyBytes,
                                 boolean isFixedLengthStreamingMode)

Sets the total body bytes.

Parameters:

totalBodyBytes - total number of bytes

isFixedLengthStreamingMode - true if the fixed length streaming mode must be used. If it's false, chunked streaming mode has to be used

Returns:

instance

getResponse

ServerResponse getResponse(HttpConnection.RequestBodyDelegate delegate)
                    throws IOException

Gets the server response.

Parameters:

delegate - delegate which handles the writing of the request body

Returns:

object containing the server response status, headers and body.

Throws:

IOException - if an error occurs while getting the server response

close

void close()

Closes the connection and frees all the allocated resources.