org.nuxeo.ecm.restapi.server.jaxrs

Class BatchUploadObject

java.lang.Object

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

org.nuxeo.ecm.restapi.server.jaxrs.BatchUploadObject

All Implemented Interfaces:

Resource, Adaptable

public class BatchUploadObject
extends AbstractResource<ResourceTypeImpl>

Batch upload endpoint.

Replaces the deprecated endpoints listed below:

• POST /batch/upload, see org.nuxeo.ecm.automation.server.jaxrs.batch.BatchResource#doPost(HttpServletRequest), use POST /upload/{batchId}/{fileIdx} instead, see upload(HttpServletRequest, String, String)
• GET /batch/files/{batchId}, see org.nuxeo.ecm.automation.server.jaxrs.batch.BatchResource#getFilesBatch(String), use GET /upload/{batchId} instead, see getBatchInfo(String) instead
• GET /batch/drop/{batchId}, see org.nuxeo.ecm.automation.server.jaxrs.batch.BatchResource#dropBatch(String), use DELETE /upload/{batchId} instead, see #dropBatch(String)

Also provides new endpoints:

• POST /upload, see initBatch()
• GET /upload/{batchId}/{fileIdx}, see getFileInfo(String, String)

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

Since:

7.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BatchUploadObject.ResumeIncompleteStatusType

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log
protected static String	OPERATION_ID
protected javax.servlet.http.HttpServletRequest	request
protected static String	REQUEST_BATCH_ID
protected static String	REQUEST_FILE_IDX
protected javax.servlet.http.HttpServletResponse	response
static String	UPLOAD_TYPE_CHUNKED
static String	UPLOAD_TYPE_NORMAL

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
BatchUploadObject()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	buildEmptyResponse(javax.ws.rs.core.Response.StatusType status)
protected javax.ws.rs.core.Response	buildHTMLResponse(javax.ws.rs.core.Response.StatusType status, String message)
protected javax.ws.rs.core.Response	buildJSONResponse(javax.ws.rs.core.Response.StatusType status, String message)
protected javax.ws.rs.core.Response	buildResponse(javax.ws.rs.core.Response.StatusType status, Object object)
protected javax.ws.rs.core.Response	buildResponse(javax.ws.rs.core.Response.StatusType status, Object object, boolean html)
protected javax.ws.rs.core.Response	buildResponse(javax.ws.rs.core.Response.StatusType status, String type, String message)
protected javax.ws.rs.core.Response	buildTextResponse(javax.ws.rs.core.Response.StatusType status, String message)
javax.ws.rs.core.Response	cancel(String batchId)
Object	execute(String batchId, String operationId, ExecutionRequest xreq)
Object	execute(String batchId, String fileIdx, String operationId, ExecutionRequest xreq)
protected Object	executeBatch(String batchId, String fileIdx, String operationId, javax.servlet.http.HttpServletRequest request, ExecutionRequest xreq)
javax.ws.rs.core.Response	getBatchInfo(String batchId)
protected Map<String,Object>	getFileInfo(BatchFileEntry fileEntry)
javax.ws.rs.core.Response	getFileInfo(String batchId, String fileIdx)
javax.ws.rs.core.Response	initBatch()
javax.ws.rs.core.Response	removeFile(String batchId, String fileIdx)
javax.ws.rs.core.Response	upload(javax.servlet.http.HttpServletRequest request, String batchId, String fileIdx)
protected javax.ws.rs.core.Response	uploadNoTransaction(javax.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 Detail

log

protected static final org.apache.commons.logging.Log log

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

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

request

@Context
protected javax.servlet.http.HttpServletRequest request

response

@Context
protected javax.servlet.http.HttpServletResponse response

Constructor Detail

BatchUploadObject

public BatchUploadObject()

Method Detail

initBatch

public javax.ws.rs.core.Response initBatch()
                                    throws IOException

Throws:

IOException

upload

public javax.ws.rs.core.Response upload(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        String batchId,
                                        String fileIdx)
                                 throws IOException

Throws:

IOException

uploadNoTransaction

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

Throws:

IOException

getBatchInfo

public javax.ws.rs.core.Response getBatchInfo(String batchId)
                                       throws IOException

Throws:

IOException

getFileInfo

public javax.ws.rs.core.Response getFileInfo(String batchId,
                                             String fileIdx)
                                      throws IOException

Throws:

IOException

cancel

public javax.ws.rs.core.Response cancel(String batchId)
                                 throws IOException

Throws:

IOException

removeFile

public javax.ws.rs.core.Response removeFile(String batchId,
                                            String fileIdx)
                                     throws IOException

Throws:

IOException

Since:

8.4

execute

public Object execute(String batchId,
                      String operationId,
                      ExecutionRequest xreq)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

execute

public Object execute(String batchId,
                      String fileIdx,
                      String operationId,
                      ExecutionRequest xreq)
               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

executeBatch

protected Object executeBatch(String batchId,
                              String fileIdx,
                              String operationId,
                              javax.servlet.http.HttpServletRequest request,
                              ExecutionRequest xreq)
                       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

buildResponse

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

Throws:

IOException

buildResponse

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

Throws:

IOException

buildJSONResponse

protected javax.ws.rs.core.Response buildJSONResponse(javax.ws.rs.core.Response.StatusType status,
                                                      String message)
                                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

buildHTMLResponse

protected javax.ws.rs.core.Response buildHTMLResponse(javax.ws.rs.core.Response.StatusType status,
                                                      String message)
                                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

buildTextResponse

protected javax.ws.rs.core.Response buildTextResponse(javax.ws.rs.core.Response.StatusType status,
                                                      String message)
                                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

buildEmptyResponse

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

buildResponse

protected javax.ws.rs.core.Response buildResponse(javax.ws.rs.core.Response.StatusType status,
                                                  String type,
                                                  String message)
                                           throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getFileInfo

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

Throws:

UnsupportedEncodingException