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

Class BatchManagerComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

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

All Implemented Interfaces:

BatchManager, Adaptable, Component, Extensible, TimestampedService

public class BatchManagerComponent
extends DefaultComponent
implements BatchManager

Runtime Component implementing the BatchManager service

Since:

5.4.2

Author:

Tiry (tdelprat@nuxeo.com), Antoine Taillefer

Constructor Summary

Constructors

Constructor and Description
BatchManagerComponent()

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

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchManagerComponent

public BatchManagerComponent()

Method Detail

initBatch

public String initBatch(String batchId,
               String contextName)

Description copied from interface: BatchManager

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

Specified by:

initBatch in interface BatchManager

Returns:

the batchId

addStream

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

Description copied from interface: BatchManager

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

Specified by:

addStream in interface BatchManager

Throws:

IOException

hasBatch

public boolean hasBatch(String batchId)

Description copied from interface: BatchManager

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

Specified by:

hasBatch in interface BatchManager

getBlobs

public List<Blob> getBlobs(String batchId)

Description copied from interface: BatchManager

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

Specified by:

getBlobs in interface BatchManager

Returns:

getBlobs

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

Description copied from interface: BatchManager

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

Specified by:

getBlobs in interface BatchManager

Returns:

getBlob

public Blob getBlob(String batchId,
           String fileId)

Specified by:

getBlob in interface BatchManager

getBlob

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

Specified by:

getBlob in interface BatchManager

clean

public void clean(String batchId)

Description copied from interface: BatchManager

Cleanup the temporary storage associated to the batch

Specified by:

clean in interface BatchManager

execute

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

Description copied from interface: BatchManager

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

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

Specified by:

execute in interface BatchManager

Throws:

ClientException

execute

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

Description copied from interface: BatchManager

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.

Specified by:

execute in interface BatchManager

Throws:

ClientException

executeAndClean

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

Description copied from interface: BatchManager

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.

Specified by:

executeAndClean in interface BatchManager

Throws:

ClientException