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
static String	CLIENT_BATCH_ID_FLAG
static String	DEFAULT_BATCH_HANDLER The default batch handler name.
static String	EP_BATCH_HANDLER
protected Map<String,BatchHandler>	handlers
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	activate(ComponentContext context) Activates the component.
void	addBlob(String batchId, String index, Blob blob, int chunkCount, int chunkIndex, String name, String mime, long fileSize) Adds a blob as a chunk to a batch.
void	addBlob(String batchId, String index, Blob blob, String name, String mime) Adds a blob to a batch.
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.
void	deactivate(ComponentContext context) Deactivates the component.
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) Fetches information about a batch.
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)
BatchHandler	getHandler(String handlerName) Gets a batch handler.
Set<String>	getSupportedHandlers() Returns the supported batch handler names.
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.
Batch	initBatch(String handlerName) Initiates a new batch with the given handler.
String	initBatch(String batchId, String contextName) Deprecated.
protected Batch	initBatchInternal(String batchId)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
boolean	removeFileEntry(String batchId, String filedIdx) Removes a file from a batch.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, start, stop, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

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

public static final String CLIENT_BATCH_ID_FLAG

See Also:

Constant Field Values

DEFAULT_BATCH_HANDLER

public static final String DEFAULT_BATCH_HANDLER

The default batch handler name.

Since:

10.1

See Also:

Constant Field Values

EP_BATCH_HANDLER

public static final String EP_BATCH_HANDLER

Since:

10.1

See Also:

Constant Field Values

handlers

protected Map<String,BatchHandler> handlers

uploadInProgress

protected final AtomicInteger uploadInProgress

Constructor Detail

BatchManagerComponent

public BatchManagerComponent()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getTransientStore

public TransientStore getTransientStore()

Description copied from interface: BatchManager

Returns the TransientStore backing the batches.

Specified by:

getTransientStore in interface BatchManager

getSupportedHandlers

public Set<String> getSupportedHandlers()

Description copied from interface: BatchManager

Returns the supported batch handler names.

Specified by:

getSupportedHandlers in interface BatchManager

Returns:

the supported batch handler names

getHandler

public BatchHandler getHandler(String handlerName)

Description copied from interface: BatchManager

Gets a batch handler.

Specified by:

getHandler in interface BatchManager

Parameters:

handlerName - the batch handler name

Returns:

the batch handler, or null if it doesn't exist

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)

initBatch

public Batch initBatch(String handlerName)

Description copied from interface: BatchManager

Initiates a new batch with the given handler.

Specified by:

initBatch in interface BatchManager

Parameters:

handlerName - the batch handler name

Returns:

the newly created batch

getBatch

public Batch getBatch(String batchId)

Description copied from interface: BatchManager

Fetches information about a batch.

Specified by:

getBatch in interface BatchManager

Parameters:

batchId - the batch id

Returns:

the batch, or null if it doesn't exist

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

addBlob

public void addBlob(String batchId,
                    String index,
                    Blob blob,
                    String name,
                    String mime)
             throws IOException

Description copied from interface: BatchManager

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

Specified by:

addBlob 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

addBlob

public void addBlob(String batchId,
                    String index,
                    Blob blob,
                    int chunkCount,
                    int chunkIndex,
                    String name,
                    String mime,
                    long fileSize)
             throws IOException

Description copied from interface: BatchManager

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

Specified by:

addBlob 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

removeFileEntry

public boolean removeFileEntry(String batchId,
                               String filedIdx)

Description copied from interface: BatchManager

Removes a file from a batch.

Specified by:

removeFileEntry in interface BatchManager