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

Author:

Tiry (tdelprat@nuxeo.com), Antoine Taillefer

Method Summary

Methods

Modifier and Type	Method and Description
void	addStream(String batchId, String idx, InputStream is, String name, String mime) Add an inputStream in a batch Will create a new Batch if needed Streams are persisted as temporary files
void	clean(String batchId) Cleanup 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 fileIdx, 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 fileIdx.
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 fileId)
Blob	getBlob(String batchId, String fileId, int timeoutS)
List<Blob>	getBlobs(String batchId) Get Blobs associated to a given batch.
List<Blob>	getBlobs(String batchId, int timeoutS) Get Blobs associated to a given batch.
boolean	hasBatch(String batchId) Returns true if there is a batch for the given batchId, false otherwise.
String	initBatch(String batchId, String contextName) Initialize a batch with a given batchId and Context Name If batchId is not provided, it will be automatically generated

Method Detail

addStream

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

Add an inputStream in a batch Will create a new Batch if needed Streams are persisted as temporary files

Parameters:

batchId -

idx -

is -

name -

mime -

Throws:

IOException

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)

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

Parameters:

batchId -

Returns:

getBlobs

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

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

Parameters:

batchId -

Returns:

Since:

5.7

getBlob

Blob getBlob(String batchId,
           String fileId)

getBlob

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

clean

void clean(String batchId)

Cleanup the temporary storage associated to the batch

Parameters:

batchId -

initBatch

String initBatch(String batchId,
               String contextName)

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

Parameters:

batchId -

contextName -

Returns:

the batchId

execute

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

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

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

Throws:

ClientException

Since:

5.7

execute

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

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

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

Throws:

ClientException

Since:

5.7.2

executeAndClean

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

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

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

Throws:

ClientException

Since:

5.7