Package org.nuxeo.ecm.automation.server.jaxrs.batch.handler.impl

Class DefaultBatchHandler

java.lang.Object

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

org.nuxeo.ecm.automation.server.jaxrs.batch.handler.impl.DefaultBatchHandler

All Implemented Interfaces:

BatchHandler

public class DefaultBatchHandler
extends AbstractBatchHandler

Default batch handler,

Since:

10.1

Field Summary

Fields inherited from class org.nuxeo.ecm.automation.server.jaxrs.batch.handler.AbstractBatchHandler

BATCH_HANDLER_NAME, name, PROP_TRANSIENT_STORE_NAME, transientStoreName

Constructor Summary

Constructors

Constructor	Description
DefaultBatchHandler()

Method Summary

Modifier and Type	Method	Description
boolean	completeUpload(String batchId, String fileIndex, BatchFileInfo fileInfo)	Callback for the batch handler to execute post-upload actions.
Batch	getBatch(String batchId)	Attempts to fetch a batch with the given id.
Map<String,Object>	refreshToken(String batchId)	Attempts to renew the credentials associated to this batch handler.

Methods inherited from class org.nuxeo.ecm.automation.server.jaxrs.batch.handler.AbstractBatchHandler

generateBatchId, getBatchParameters, getName, getTransientStore, initialize, initialize, newBatch

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBatchHandler

public DefaultBatchHandler()

Method Details

getBatch

public Batch getBatch(String batchId)

Description copied from interface: BatchHandler

Attempts to fetch a batch with the given id.

Parameters:

batchId - the batch id to fetch

Returns:

the batch with the given id, or null if not found

completeUpload

public boolean completeUpload(String batchId,
 String fileIndex,
 BatchFileInfo fileInfo)

Description copied from interface: BatchHandler

Callback for the batch handler to execute post-upload actions. This is only typically used in third-party batch handlers.

Parameters:

batchId - the batch id

fileIndex - the file index within the batch

fileInfo - file information regarting the uploaded file

Returns:

true if the action was success

refreshToken

public Map<String,Object> refreshToken(String batchId)

Description copied from interface: BatchHandler

Attempts to renew the credentials associated to this batch handler. This is only typically used in third-party batch handlers.

Parameters:

batchId - the batch id

Returns:

the new credentials