org.nuxeo.ecm.automation.server.jaxrs.batch

Class Batch

java.lang.Object

org.nuxeo.ecm.automation.server.jaxrs.batch.Batch

public class Batch
extends Object

Batch Object to encapsulate all data related to a batch, especially the temporary files used for Blobs.

Since 7.4 a batch is backed by the TransientStore.

Since:

5.4.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHUNKED_PARAM_NAME
protected Map<String,Serializable>	fileEntries
protected String	key
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
Batch(String key)
Batch(String key, Map<String,Serializable> fileEntries)

Method Summary

Modifier and Type	Method and Description
String	addChunk(String index, InputStream is, int chunkCount, int chunkIndex, String fileName, String mimeType, long fileSize) Adds a chunk with the given chunkIndex to the batch file with the given index.
String	addFile(String index, InputStream is, String name, String mime) Adds a file with the given index to the batch.
void	clean()
Blob	getBlob(String index)
List<Blob>	getBlobs() Returns the uploaded blobs in the order the user chose to upload them.
List<BatchFileEntry>	getFileEntries()
BatchFileEntry	getFileEntry(String index)
BatchFileEntry	getFileEntry(String index, boolean fetchBlobs)
String	getKey()
protected List<String>	getOrderedFileIndexes()
protected Blob	retrieveBlob(String index)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

CHUNKED_PARAM_NAME

public static final String CHUNKED_PARAM_NAME

See Also:

Constant Field Values

key

protected String key

fileEntries

protected Map<String,Serializable> fileEntries

Constructor Detail

Batch

public Batch(String key)

Batch

public Batch(String key,
             Map<String,Serializable> fileEntries)

Method Detail

getKey

public String getKey()

getBlobs

public List<Blob> getBlobs()

Returns the uploaded blobs in the order the user chose to upload them.

getBlob

public Blob getBlob(String index)

getOrderedFileIndexes

protected List<String> getOrderedFileIndexes()

retrieveBlob

protected Blob retrieveBlob(String index)

getFileEntries

public List<BatchFileEntry> getFileEntries()

getFileEntry

public BatchFileEntry getFileEntry(String index)

getFileEntry

public BatchFileEntry getFileEntry(String index,
                                   boolean fetchBlobs)

addFile

public String addFile(String index,
                      InputStream is,
                      String name,
                      String mime)
               throws IOException

Adds a file with the given index to the batch.

Returns:

The key of the new BatchFileEntry.

Throws:

IOException

addChunk

public String addChunk(String index,
                       InputStream is,
                       int chunkCount,
                       int chunkIndex,
                       String fileName,
                       String mimeType,
                       long fileSize)
                throws IOException

Adds a chunk with the given chunkIndex to the batch file with the given index.

Returns:

The key of the BatchFileEntry.

Throws:

IOException

Since:

7.4

clean

public void clean()

Since:

7.4