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 with the TransientStore.

Since:

5.4.2

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLIENT_BATCH_ID_FLAG
protected static org.apache.commons.logging.Log	log
protected static String	TRANSIENT_STORE_NAME
protected AtomicInteger	uploadInProgress

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

lastModified

Constructor Summary

Constructors

Constructor and Description
BatchManagerComponent()

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.
protected Object	execute(Object blobInput, String chainOrOperationId, CoreSession session, Map<String,Object> contextParams, Map<String,Object> operationParams)
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.
Batch	getBatch(String batchId)
protected Blob	getBatchBlob(String batchId, String fileIndex)
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.
protected int	getUploadWaitTimeout()
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.
protected Batch	initBatchInternal(String batchId)

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

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

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

TRANSIENT_STORE_NAME

protected static final String TRANSIENT_STORE_NAME

See Also:

Constant Field Values

CLIENT_BATCH_ID_FLAG

protected static final String CLIENT_BATCH_ID_FLAG

See Also:

Constant Field Values

uploadInProgress

protected final AtomicInteger uploadInProgress

Constructor Detail

BatchManagerComponent

public BatchManagerComponent()

Method Detail

getTransientStore

public TransientStore getTransientStore()

Description copied from interface: BatchManager

Returns the TransientStore backing the batches.

Specified by:

getTransientStore in interface BatchManager

initBatch

public String initBatch()

Description copied from interface: BatchManager

Initializes a batch by with an automatically generated id.

Specified by:

initBatch in interface BatchManager

Returns:

the batch id

initBatch

@Deprecated
public String initBatch(String batchId,
                                    String contextName)

Deprecated.

Description copied from interface: BatchManager

Initializes 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

initBatchInternal

protected Batch initBatchInternal(String batchId)

getBatch

public Batch getBatch(String batchId)

addStream

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

Description copied from interface: BatchManager

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

Streams are persisted as temporary files.

Specified by:

addStream in interface BatchManager

Throws:

IOException

addStream

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

Description copied from interface: BatchManager

Adds an inputStream as a chunk to 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

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

Specified by:

getBlobs in interface BatchManager

getBlobs

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

Description copied from interface: BatchManager

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

Specified by:

getBlobs in interface BatchManager

getBlob

public Blob getBlob(String batchId,
                    String fileIndex)

Specified by:

getBlob in interface BatchManager

getBlob

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

Specified by:

getBlob in interface BatchManager

getBatchBlob

protected Blob getBatchBlob(String batchId,
                            String fileIndex)

getFileEntries

public List<BatchFileEntry> getFileEntries(String batchId)

Specified by:

getFileEntries in interface BatchManager

getFileEntry

public BatchFileEntry getFileEntry(String batchId,
                                   String fileIndex)

Specified by:

getFileEntry in interface BatchManager

clean

public void clean(String batchId)

Description copied from interface: BatchManager

Cleans up 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)

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

execute

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

Description copied from interface: BatchManager

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.

Specified by:

execute in interface BatchManager

execute

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

getUploadWaitTimeout

protected int getUploadWaitTimeout()

executeAndClean

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

Description copied from interface: BatchManager

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.

Specified by:

executeAndClean in interface BatchManager