Package com.ning.http.client.generators

Class FileBodyGenerator

java.lang.Object

com.ning.http.client.generators.FileBodyGenerator

All Implemented Interfaces:

BodyGenerator

public class FileBodyGenerator
extends Object
implements BodyGenerator

Creates a request body from the contents of a file. Beware, Netty provider has its own way for uploading files and won't use the BodyGenerator API. If you want to use Netty and have a custom behavior while uploading a file through BodyGenerator, implement BodyGenerator instead of extending FileBodyGenerator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FileBodyGenerator.FileBody

Constructor Summary

Constructors

Constructor	Description
FileBodyGenerator(File file)
FileBodyGenerator(File file, long regionSeek, long regionLength)

Method Summary

Modifier and Type	Method	Description
RandomAccessBody	createBody()	Creates a new instance of the request body to be read.
File	getFile()
long	getRegionLength()
long	getRegionSeek()

Methods inherited from class java.lang.Object

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

Constructor Details

FileBodyGenerator

public FileBodyGenerator(File file)

FileBodyGenerator

public FileBodyGenerator(File file,
 long regionSeek,
 long regionLength)

Method Details

createBody

public RandomAccessBody createBody()
                            throws IOException

Description copied from interface: BodyGenerator

Creates a new instance of the request body to be read. While each invocation of this method is supposed to create a fresh instance of the body, the actual contents of all these body instances is the same. For example, the body needs to be resend after an authentication challenge of a redirect.

Specified by:

createBody in interface BodyGenerator

Returns:

The request body, never null.

Throws:

IOException - If the body could not be created.

getFile

public File getFile()

getRegionSeek

public long getRegionSeek()

getRegionLength

public long getRegionLength()