org.waarp.http.protocol

Class HttpResumableInfo

java.lang.Object

org.waarp.http.protocol.HttpResumableInfo

public class HttpResumableInfo
extends Object

Http Resumable information

Constructor Summary

Constructors

Constructor and Description
HttpResumableInfo(int chunkNumber, int chunkSize, long totalSize, String identifier, String filename, String relativePath)

Method Summary

Modifier and Type	Method and Description
int	getChunkNumber() The index of the chunk in the current upload.
int	getChunkSize() The general chunk size.
String	getFilename() The original file name (since a bug in Firefox results in the file name not being transmitted in chunk multipart posts).
String	getIdentifier() A unique identifier for the file contained in the request.
String	getRelativePath() The file's relative path when selecting a directory (defaults to file name in all browsers except Chrome).
int	getTotalChunks() The total number of chunks.
long	getTotalSize() The total file size.
boolean	isCompatible(HttpResumableInfo resumableInfo)
HttpResumableInfo	setChunkNumber(int chunkNumber)
HttpResumableInfo	setChunkSize(int chunkSize)
HttpResumableInfo	setFilename(String filename)
HttpResumableInfo	setIdentifier(String identifier)
HttpResumableInfo	setRelativePath(String relativePath)
HttpResumableInfo	setTotalChunks(int totalChunks)
HttpResumableInfo	setTotalSize(long totalSize)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResumableInfo

public HttpResumableInfo(int chunkNumber,
                         int chunkSize,
                         long totalSize,
                         String identifier,
                         String filename,
                         String relativePath)

Method Detail

getFilename

public final String getFilename()

The original file name (since a bug in Firefox results in the file name not being transmitted in chunk multipart posts).

setFilename

public final HttpResumableInfo setFilename(String filename)

getRelativePath

public final String getRelativePath()

The file's relative path when selecting a directory (defaults to file name in all browsers except Chrome).

setRelativePath

public final HttpResumableInfo setRelativePath(String relativePath)

isCompatible

public final boolean isCompatible(HttpResumableInfo resumableInfo)

Parameters:

resumableInfo -

Returns:

True if both HttpResumableInfo are compatible (size, chunk size, total number of chunks, identifier and current chunk vs max chunk number)

getChunkSize

public final int getChunkSize()

The general chunk size. Using this value and resumableTotalSize you can calculate the total number of chunks. Please note that the size of the data received in the HTTP might be higher than resumableChunkSize for the last chunk for a file. Max being 2^31, preferably 2^20 (1 MB)

setChunkSize

public final HttpResumableInfo setChunkSize(int chunkSize)

getTotalSize

public final long getTotalSize()

The total file size. Max being theoretically 2^63, but in practice being resumableChunkSize x resumableTotalChunks, therefore 2^20 x 2^31 = 2^51

setTotalSize

public final HttpResumableInfo setTotalSize(long totalSize)

getIdentifier

public final String getIdentifier()

A unique identifier for the file contained in the request.

getTotalChunks

public final int getTotalChunks()

The total number of chunks. Max being 2^31

getChunkNumber

public final int getChunkNumber()

The index of the chunk in the current upload. First chunk is 1 (no base-0 counting here). Max being 2^31

setChunkNumber

public final HttpResumableInfo setChunkNumber(int chunkNumber)

setTotalChunks

public final HttpResumableInfo setTotalChunks(int totalChunks)

setIdentifier

public final HttpResumableInfo setIdentifier(String identifier)

toString

public String toString()

Overrides:

toString in class Object