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

Class BatchFileEntry

java.lang.Object

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

public class BatchFileEntry
extends Object

Represents a batch file backed by the TransientStore.

The file can be chunked or not. If it is chunked it references its chunks as TransientStore entry keys.

Since:

7.4

See Also:

Batch

Field Summary

Fields

Modifier and Type	Field and Description
protected Blob	blob
protected Blob	chunkedBlob
protected String	key
protected static org.apache.commons.logging.Log	log
protected Map<String,Serializable>	params

Constructor Summary

Constructors

Modifier	Constructor and Description
	BatchFileEntry(String key, Blob blob) Returns a file entry that holds the given blob, not chunked.
protected	BatchFileEntry(String key, boolean chunked)
	BatchFileEntry(String key, int chunkCount, String fileName, String mimeType, long fileSize) Returns a file entry that references the file chunks.
	BatchFileEntry(String key, Map<String,Serializable> params) Returns a file entry that holds the given parameters.

Method Summary

Modifier and Type	Method and Description
String	addChunk(int index, Blob blob)
void	beforeRemove()
Blob	getBlob()
protected Blob	getChunk(TransientStore ts, String key)
int	getChunkCount()
Collection<String>	getChunkEntryKeys()
Map<Integer,String>	getChunks()
String	getFileName()
long	getFileSize()
String	getKey()
String	getMimeType()
List<Integer>	getOrderedChunkIndexes()
Map<String,Serializable>	getParams()
boolean	isChunked()
boolean	isChunksCompleted()
protected void	transferTo(Blob blob, File file) Appends the given blob to the given file.

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

key

protected String key

params

protected Map<String,Serializable> params

blob

protected Blob blob

chunkedBlob

protected Blob chunkedBlob

Constructor Detail

BatchFileEntry

public BatchFileEntry(String key,
                      Blob blob)

Returns a file entry that holds the given blob, not chunked.

BatchFileEntry

public BatchFileEntry(String key,
                      int chunkCount,
                      String fileName,
                      String mimeType,
                      long fileSize)

Returns a file entry that references the file chunks.

See Also:

BatchChunkEntry

BatchFileEntry

public BatchFileEntry(String key,
                      Map<String,Serializable> params)

Returns a file entry that holds the given parameters.

BatchFileEntry

protected BatchFileEntry(String key,
                         boolean chunked)

Method Detail

getKey

public String getKey()

getParams

public Map<String,Serializable> getParams()

isChunked

public boolean isChunked()

getFileName

public String getFileName()

getMimeType

public String getMimeType()

getFileSize

public long getFileSize()

getChunkCount

public int getChunkCount()

getChunks

public Map<Integer,String> getChunks()

getOrderedChunkIndexes

public List<Integer> getOrderedChunkIndexes()

getChunkEntryKeys

public Collection<String> getChunkEntryKeys()

isChunksCompleted

public boolean isChunksCompleted()

getBlob

public Blob getBlob()

getChunk

protected Blob getChunk(TransientStore ts,
                        String key)

transferTo

protected void transferTo(Blob blob,
                          File file)
                   throws IOException

Appends the given blob to the given file.

Throws:

IOException

addChunk

public String addChunk(int index,
                       Blob blob)

beforeRemove

public void beforeRemove()