net.gotev.uploadservice.http

Class BodyWriter

java.lang.Object

net.gotev.uploadservice.http.BodyWriter

Direct Known Subclasses:

HurlBodyWriter

public abstract class BodyWriter
extends Object

Exposes the methods to be implemented to write the request body. If you want to use an internal cache or buffer, remember to always get its size value from UploadService.BUFFER_SIZE and to clear everything when not needed to prevent memory leaks

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BodyWriter.OnStreamWriteListener Receives the stream write progress and has the ability to cancel it.

Constructor Summary

Constructors

Constructor and Description
BodyWriter()

Method Summary

Modifier and Type	Method and Description
abstract void	flush() Ensures the bytes written to the body are all transmitted to the server and clears the local buffer.
abstract void	write(byte[] bytes) Write a byte array into the request body.
abstract void	write(byte[] bytes, int lengthToWriteFromStart) Write a portion of a byte array into the request body.
void	writeStream(InputStream stream, BodyWriter.OnStreamWriteListener listener) Writes an input stream to the request body.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BodyWriter

public BodyWriter()

Method Detail

writeStream

public final void writeStream(InputStream stream,
                              BodyWriter.OnStreamWriteListener listener)
                       throws IOException

Writes an input stream to the request body. The stream will be automatically closed after successful write or if an exception is thrown.

Parameters:

stream - input stream from which to read

listener - listener which gets notified when bytes are written and which controls if the transfer should continue

Throws:

IOException - if an I/O error occurs

write

public abstract void write(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

write

public abstract void write(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

flush

public abstract void flush()
                    throws IOException

Ensures the bytes written to the body are all transmitted to the server and clears the local buffer.

Throws:

IOException - if an error occurs while flushing the buffer