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 writeBody 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.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection and frees all the allocated resources.
byte[]	getServerResponseBody() Gets the server response body.
int	getServerResponseCode() Gets the HTTP response code from the server.
void	setHeaders(List<NameValue> requestHeaders, boolean isFixedLengthStreamingMode, long totalBodyBytes) Set request headers.
void	writeBody(byte[] bytes) Write a byte array into the request body.
void	writeBody(byte[] bytes, int lengthToWriteFromStart) Write a portion of a byte array into the request body.

Method Detail

setHeaders

void setHeaders(List<NameValue> requestHeaders,
                boolean isFixedLengthStreamingMode,
                long totalBodyBytes)
         throws IOException

Set request headers.

Parameters:

requestHeaders - request headers to set

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

totalBodyBytes - total number of bytes

Throws:

IOException - if an error occurs while setting request headers

writeBody

void writeBody(byte[] bytes)
        throws IOException

Write a byte array into the request body.

Parameters:

bytes - array with the bytes to write

Throws:

IOException - if an error occurs while writing

writeBody

void writeBody(byte[] bytes,
               int lengthToWriteFromStart)
        throws IOException

Write a portion of a byte array into the request body.

Parameters:

bytes - array with the bytes to write

lengthToWriteFromStart - how many bytes to write, starting from the first one in the array

Throws:

IOException - if an error occurs while writing

getServerResponseCode

int getServerResponseCode()
                   throws IOException

Gets the HTTP response code from the server.

Returns:

an integer representing the HTTP response code (e.g. 200)

Throws:

IOException - if an error occurs while getting the server response code

getServerResponseBody

byte[] getServerResponseBody()
                      throws IOException

Gets the server response body.

Returns:

response body bytes

Throws:

IOException - if an error occurs while getting the server response body

close

void close()

Closes the connection and frees all the allocated resources.