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

Interface BatchManager

All Known Implementing Classes:

BatchManagerComponent

public interface BatchManager

Service interface to collect inputs (Blobs) for an operation or operation chain.

Since:

5.4.2

Method Summary

Modifier and Type	Method and Description
void	addStream(String batchId, String index, InputStream is, int chunkCount, int chunkIndex, String name, String mime, long fileSize) Adds an inputStream as a chunk to a batch.
void	addStream(String batchId, String index, InputStream is, String name, String mime) Adds an inputStream as a blob to a batch.
void	clean(String batchId) Cleans up the temporary storage associated to the batch.
Object	execute(String batchId, String chainOrOperationId, CoreSession session, Map<String,Object> contextParams, Map<String,Object> operationParams) Executes the chain or operation on the Blobs from the given batchId.
Object	execute(String batchId, String fileIndex, String chainOrOperationId, CoreSession session, Map<String,Object> contextParams, Map<String,Object> operationParams) Executes the chain or operation on the Blob from the given batchId and fileIndex.
Object	executeAndClean(String batchId, String chainOrOperationId, CoreSession session, Map<String,Object> contextParams, Map<String,Object> operationParams) Executes the chain or operation on the Blobs from the given batchId.
Blob	getBlob(String batchId, String fileIndex)
Blob	getBlob(String batchId, String fileIndex, int timeoutS)
List<Blob>	getBlobs(String batchId) Gets Blobs associated to a given batch.
List<Blob>	getBlobs(String batchId, int timeoutS) Gets Blobs associated to a given batch.
List<BatchFileEntry>	getFileEntries(String batchId)
BatchFileEntry	getFileEntry(String batchId, String fileIndex)
TransientStore	getTransientStore() Returns the TransientStore backing the batches.
boolean	hasBatch(String batchId) Returns true if there is a batch for the given batchId, false otherwise.
String	initBatch() Initializes a batch by with an automatically generated id.
String	initBatch(String batchId, String contextName) Deprecated. since 7.10, use initBatch() instead.
boolean	removeFileEntry(String batchId, String filedIdx) Removes a file from a batch.

Method Detail

getTransientStore

TransientStore getTransientStore()

Returns the TransientStore backing the batches.

Since:

7.4

addStream

void addStream(String batchId,
               String index,
               InputStream is,
               String name,
               String mime)
        throws IOException

Adds an inputStream as a blob to a batch. Will create a new Batch if needed.

Streams are persisted as temporary files.

Throws:

IOException

addStream

void addStream(String batchId,
               String index,
               InputStream is,
               int chunkCount,
               int chunkIndex,
               String name,
               String mime,
               long fileSize)
        throws IOException

Adds an inputStream as a chunk to a batch. Will create a new Batch if needed.

Streams are persisted as temporary files.

Throws:

IOException

Since:

7.4

hasBatch

boolean hasBatch(String batchId)

Returns true if there is a batch for the given batchId, false otherwise.

Since:

5.7.2

getBlobs

List<Blob> getBlobs(String batchId)

Gets Blobs associated to a given batch. Returns null if batch does not exist.

getBlobs

List<Blob> getBlobs(String batchId,
                    int timeoutS)

Gets Blobs associated to a given batch. Returns null if batch does not exist. Waits for upload in progress if needed.

Since:

5.7

getBlob

Blob getBlob(String batchId,
             String fileIndex)

getBlob

Blob getBlob(String batchId,
             String fileIndex,
             int timeoutS)

getFileEntries

List<BatchFileEntry> getFileEntries(String batchId)

Since:

7.4

getFileEntry

BatchFileEntry getFileEntry(String batchId,
                            String fileIndex)

Since:

7.4

clean

void clean(String batchId)

Cleans up the temporary storage associated to the batch.

initBatch

String initBatch()

Initializes a batch by with an automatically generated id.

Returns:

the batch id

Since:

7.4

initBatch

@Deprecated
String initBatch(String batchId,
                             String contextName)

Deprecated. since 7.10, use initBatch() instead.

Initializes a batch with a given batchId and Context Name. If batchId is not provided, it will be automatically generated.

Returns:

the batchId

execute

Object execute(String batchId,
               String chainOrOperationId,
               CoreSession session,
               Map<String,Object> contextParams,
               Map<String,Object> operationParams)

Executes the chain or operation on the Blobs from the given batchId.

This method does not clean the temporary storage associated to the batchId.

Since:

5.7

execute

Object execute(String batchId,
               String fileIndex,
               String chainOrOperationId,
               CoreSession session,
               Map<String,Object> contextParams,
               Map<String,Object> operationParams)

Executes the chain or operation on the Blob from the given batchId and fileIndex.

This method does not clean the temporary storage associated to the batchId.

Since:

5.7.2

executeAndClean

Object executeAndClean(String batchId,
                       String chainOrOperationId,
                       CoreSession session,
                       Map<String,Object> contextParams,
                       Map<String,Object> operationParams)

Executes the chain or operation on the Blobs from the given batchId.

This method cleans the temporary storage associated to the batchId after the execution.

Since:

5.7

removeFileEntry

boolean removeFileEntry(String batchId,
                        String filedIdx)

Removes a file from a batch.

Since:

8.4