Package 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.

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 String	FILE_SIZE
static String	KEY
protected static Log	log
static String	MD5
static String	MIMETYPE
static String	NAME
protected static String	OPERATION_ID
protected javax.servlet.http.HttpServletRequest	request
protected static String	REQUEST_BATCH_ID
protected static String	REQUEST_FILE_IDX
protected static String	REQUEST_HANDLER_NAME
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	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 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)	Deprecated. since 11.2, not used anymore
protected javax.ws.rs.core.Response	buildJSONResponse(javax.ws.rs.core.Response.StatusType status, String message)	Deprecated. since 11.2, not used anymore
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)	Deprecated. since 11.2, not used anymore
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)
javax.ws.rs.core.Response	createNewBatch(String handlerName)
Object	execute(String batchId, String fileIdx, String operationId, ExecutionRequest xreq)
Object	execute(String batchId, 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	getBatchExtraInfo(String batchId)
javax.ws.rs.core.Response	getBatchInfo(String batchId)
javax.ws.rs.core.Response	getFileInfo(String batchId, String fileIdx)
protected Map<String,Object>	getFileInfo(BatchFileEntry fileEntry)
javax.ws.rs.core.Response	getHandlerInfo(String handlerName)
protected long	getUploadedSize(javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	handlers()
javax.ws.rs.core.Response	initBatch()
protected Map<String,String>	mapWithName(String name)
javax.ws.rs.core.Response	refreshToken(String batchId)
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)
javax.ws.rs.core.Response	uploadCompleted(String batchId, String fileIdx, String body)
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 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

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 javax.servlet.http.HttpServletRequest request

response

@Context
protected javax.servlet.http.HttpServletResponse response

Constructor Detail

BatchUploadObject

public BatchUploadObject()

Method Detail

mapWithName

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

handlers

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

Throws:

IOException

getHandlerInfo

public javax.ws.rs.core.Response getHandlerInfo(String handlerName)
                                         throws IOException

Throws:

IOException

createNewBatch

public javax.ws.rs.core.Response createNewBatch(String handlerName)
                                         throws IOException

Throws:

IOException

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

getUploadedSize

protected long getUploadedSize(javax.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

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)

removeFile

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

Since:

8.4

execute

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

execute

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

getBatchExtraInfo

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

Throws:

IOException

refreshToken

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

Throws:

IOException

Since:

11.1

uploadCompleted

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

Throws:

IOException

executeBatch

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

buildResponse

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

Throws:

IOException

buildResponse

@Deprecated(since="11.2")
protected javax.ws.rs.core.Response buildResponse(javax.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 javax.ws.rs.core.Response buildJSONResponse(javax.ws.rs.core.Response.StatusType status,
                                                      String message)
                                               throws UnsupportedEncodingException

Deprecated.

since 11.2, not used anymore

Throws:

UnsupportedEncodingException

buildHTMLResponse

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

Deprecated.

since 11.2, not used anymore

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)