Package org.nuxeo.ecm.restapi.server

Class BatchUploadObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.restapi.server.BatchUploadObject

All Implemented Interfaces:

Resource, Adaptable

public class BatchUploadObject
extends AbstractResource<ResourceTypeImpl>

Batch upload endpoint.

Provides the APIs listed below:

• POST /upload, see initBatch()
• POST /upload/{batchId}/{fileIdx}, see upload(HttpServletRequest, String, String)
• GET /upload/{batchId}, see getBatchInfo(String)
• GET /upload/{batchId}/{fileIdx}, see getFileInfo(String, String)
• POST /upload/{batchId}/execute/{operationId}, see execute(String, String, ExecutionRequest)
• POST /upload/{batchId}/refreshToken, see refreshToken(String)
• POST /upload/{batchId}/{fileIdx}/execute/{operationId}, see execute(String, String, String, ExecutionRequest)
• DELETE /upload/{batchId}, see cancel(String)
• DELETE /upload/{batchId}/{fileIdx}, see removeFile(String, String)

Largely inspired by the excellent Google Drive REST API documentation about resumable upload.

Since:

7.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_SIZE
static final String	KEY
static final String	MD5
static final String	MIMETYPE
static final String	NAME
protected static final String	OPERATION_ID
protected jakarta.servlet.http.HttpServletRequest	request
protected static final String	REQUEST_BATCH_ID
protected static final String	REQUEST_FILE_IDX
protected static final String	REQUEST_HANDLER_NAME
protected jakarta.servlet.http.HttpServletResponse	response
static final String	UPLOAD_TYPE_CHUNKED
static final String	UPLOAD_TYPE_NORMAL

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
BatchUploadObject()

Method Summary

Modifier and Type	Method	Description
protected void	addBlob(String uploadType, String batchId, String fileIdx, Blob blob, String fileName, String mimeType, long uploadedSize, int chunkCount, int uploadChunkIndex, long fileSize)
protected jakarta.ws.rs.core.Response	buildEmptyResponse(jakarta.ws.rs.core.Response.StatusType status)
protected jakarta.ws.rs.core.Response	buildHTMLResponse(jakarta.ws.rs.core.Response.StatusType status, String message)	Deprecated. since 11.2, not used anymore
protected jakarta.ws.rs.core.Response	buildJSONResponse(jakarta.ws.rs.core.Response.StatusType status, String message)	Deprecated. since 11.2, not used anymore
protected jakarta.ws.rs.core.Response	buildResponse(jakarta.ws.rs.core.Response.StatusType status, Object object)
protected jakarta.ws.rs.core.Response	buildResponse(jakarta.ws.rs.core.Response.StatusType status, Object object, boolean html)	Deprecated. since 11.2, not used anymore
protected jakarta.ws.rs.core.Response	buildResponse(jakarta.ws.rs.core.Response.StatusType status, String type, String message)
protected jakarta.ws.rs.core.Response	buildTextResponse(jakarta.ws.rs.core.Response.StatusType status, String message)
jakarta.ws.rs.core.Response	cancel(String batchId)
jakarta.ws.rs.core.Response	complete(String batchId, String fileIdx, String body)
protected jakarta.ws.rs.core.Response	completeNoTransaction(String batchId, String fileIdx, String body)
jakarta.ws.rs.core.Response	createNewBatch(String handlerName)
protected Object	execute(Object blobInput, String chainOrOperationId, CoreSession session, Map<String,Object> contextParams, Map<String,Object> operationParams)
jakarta.ws.rs.core.Response	execute(String batchId, String fileIdx, String operationId, ExecutionRequest xreq)
jakarta.ws.rs.core.Response	execute(String batchId, String operationId, ExecutionRequest xreq)
protected jakarta.ws.rs.core.Response	executeBatch(String batchId, String fileIdx, String operationId, jakarta.servlet.http.HttpServletRequest request, ExecutionRequest xreq)
jakarta.ws.rs.core.Response	getBatchExtraInfo(String batchId)
jakarta.ws.rs.core.Response	getBatchInfo(String batchId)
jakarta.ws.rs.core.Response	getFileInfo(String batchId, String fileIdx)
protected Map<String,Object>	getFileInfo(BatchFileEntry fileEntry)
jakarta.ws.rs.core.Response	getHandlerInfo(String handlerName)
protected long	getUploadedSize(jakarta.servlet.http.HttpServletRequest request)
protected int	getUploadWaitTimeout()
jakarta.ws.rs.core.Response	handlers()
jakarta.ws.rs.core.Response	initBatch()
protected Map<String,String>	mapWithName(String name)
jakarta.ws.rs.core.Response	refreshToken(String batchId)
jakarta.ws.rs.core.Response	removeFile(String batchId, String fileIdx)
jakarta.ws.rs.core.Response	upload(jakarta.servlet.http.HttpServletRequest request, String batchId, String fileIdx)
protected jakarta.ws.rs.core.Response	uploadNoTransaction(jakarta.servlet.http.HttpServletRequest request, String batchId, String fileIdx)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

REQUEST_BATCH_ID

protected static final String REQUEST_BATCH_ID

See Also:

• Constant Field Values

REQUEST_FILE_IDX

protected static final String REQUEST_FILE_IDX

See Also:

• Constant Field Values

OPERATION_ID

protected static final String OPERATION_ID

See Also:

• Constant Field Values

REQUEST_HANDLER_NAME

protected static final String REQUEST_HANDLER_NAME

See Also:

• Constant Field Values

UPLOAD_TYPE_NORMAL

public static final String UPLOAD_TYPE_NORMAL

See Also:

• Constant Field Values

UPLOAD_TYPE_CHUNKED

public static final String UPLOAD_TYPE_CHUNKED

See Also:

• Constant Field Values

KEY

public static final String KEY

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

MIMETYPE

public static final String MIMETYPE

See Also:

• Constant Field Values

FILE_SIZE

public static final String FILE_SIZE

See Also:

• Constant Field Values

MD5

public static final String MD5

See Also:

• Constant Field Values

request

@Context
protected jakarta.servlet.http.HttpServletRequest request

response

@Context
protected jakarta.servlet.http.HttpServletResponse response

Constructor Details

BatchUploadObject

public BatchUploadObject()

Method Details

mapWithName

protected Map<String,String> mapWithName(String name)

handlers

@GET
@Path("handlers")
public jakarta.ws.rs.core.Response handlers()
                                     throws IOException

Throws:

IOException

getHandlerInfo

@GET
@Path("handlers/{handlerName}")
public jakarta.ws.rs.core.Response getHandlerInfo(@PathParam("handlerName")
 String handlerName)
                                           throws IOException

Throws:

IOException

createNewBatch

@POST
@Path("new/{handlerName}")
public jakarta.ws.rs.core.Response createNewBatch(@PathParam("handlerName")
 String handlerName)
                                           throws IOException

Throws:

IOException

initBatch

@POST
public jakarta.ws.rs.core.Response initBatch()
                                      throws IOException

Throws:

IOException

upload

@POST
@Path("{batchId}/{fileIdx}")
public jakarta.ws.rs.core.Response upload(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx)
                                   throws IOException

Throws:

IOException

uploadNoTransaction

protected jakarta.ws.rs.core.Response uploadNoTransaction(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx)
                                                   throws IOException

Throws:

IOException

getUploadedSize

protected long getUploadedSize(jakarta.servlet.http.HttpServletRequest request)

addBlob

protected void addBlob(String uploadType,
 String batchId,
 String fileIdx,
 Blob blob,
 String fileName,
 String mimeType,
 long uploadedSize,
 int chunkCount,
 int uploadChunkIndex,
 long fileSize)

getBatchInfo

@GET
@Path("{batchId}")
public jakarta.ws.rs.core.Response getBatchInfo(@PathParam("batchId")
 String batchId)
                                         throws IOException

Throws:

IOException

getFileInfo

@GET
@Path("{batchId}/{fileIdx}")
public jakarta.ws.rs.core.Response getFileInfo(@PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx)
                                        throws IOException

Throws:

IOException

cancel

@DELETE
@Path("{batchId}")
public jakarta.ws.rs.core.Response cancel(@PathParam("batchId")
 String batchId)

removeFile

@DELETE
@Path("{batchId}/{fileIdx}")
public jakarta.ws.rs.core.Response removeFile(@PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx)

Since:

8.4

execute

@POST
@Produces("application/json")
@Path("{batchId}/execute/{operationId}")
public jakarta.ws.rs.core.Response execute(@PathParam("batchId")
 String batchId,
 @PathParam("operationId")
 String operationId,
 ExecutionRequest xreq)

execute

@POST
@Produces("application/json")
@Path("{batchId}/{fileIdx}/execute/{operationId}")
public jakarta.ws.rs.core.Response execute(@PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx,
 @PathParam("operationId")
 String operationId,
 ExecutionRequest xreq)

getBatchExtraInfo

@GET
@Path("{batchId}/info")
public jakarta.ws.rs.core.Response getBatchExtraInfo(@PathParam("batchId")
 String batchId)
                                              throws IOException

Throws:

IOException

refreshToken

@POST
@Path("{batchId}/refreshToken")
public jakarta.ws.rs.core.Response refreshToken(@PathParam("batchId")
 String batchId)
                                         throws IOException

Throws:

IOException

Since:

11.1

complete

@POST
@Path("{batchId}/{fileIdx}/complete")
public jakarta.ws.rs.core.Response complete(@PathParam("batchId")
 String batchId,
 @PathParam("fileIdx")
 String fileIdx,
 String body)
                                     throws IOException

Throws:

IOException

completeNoTransaction

protected jakarta.ws.rs.core.Response completeNoTransaction(String batchId,
 String fileIdx,
 String body)
                                                     throws IOException

Throws:

IOException

executeBatch

protected jakarta.ws.rs.core.Response executeBatch(String batchId,
 String fileIdx,
 String operationId,
 jakarta.servlet.http.HttpServletRequest request,
 ExecutionRequest xreq)

getUploadWaitTimeout

protected int getUploadWaitTimeout()

execute

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

buildResponse

protected jakarta.ws.rs.core.Response buildResponse(jakarta.ws.rs.core.Response.StatusType status,
 Object object)
                                             throws IOException

Throws:

IOException

buildResponse

@Deprecated(since="11.2")
protected jakarta.ws.rs.core.Response buildResponse(jakarta.ws.rs.core.Response.StatusType status,
 Object object,
 boolean html)
                                             throws IOException

Deprecated.

since 11.2, not used anymore

Throws:

IOException

buildJSONResponse

@Deprecated(since="11.2")
protected jakarta.ws.rs.core.Response buildJSONResponse(jakarta.ws.rs.core.Response.StatusType status,
 String message)

Deprecated.

since 11.2, not used anymore

buildHTMLResponse

@Deprecated(since="11.2")
protected jakarta.ws.rs.core.Response buildHTMLResponse(jakarta.ws.rs.core.Response.StatusType status,
 String message)

Deprecated.

since 11.2, not used anymore

buildTextResponse

protected jakarta.ws.rs.core.Response buildTextResponse(jakarta.ws.rs.core.Response.StatusType status,
 String message)

buildEmptyResponse

protected jakarta.ws.rs.core.Response buildEmptyResponse(jakarta.ws.rs.core.Response.StatusType status)

buildResponse

protected jakarta.ws.rs.core.Response buildResponse(jakarta.ws.rs.core.Response.StatusType status,
 String type,
 String message)

getFileInfo

protected Map<String,Object> getFileInfo(BatchFileEntry fileEntry)