Package org.silverpeas.core.webapi.upload

Class FileUploadResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.upload.FileUploadResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("fileUpload")
@Authenticated
public class FileUploadResource
extends RESTWebService

A REST Web resource that permits to upload files. It has to be used with one of the following plugins:

• silverpeas-filUpload.js: useful to handle file upload on resource creation
• silverpeas-ddUpload.js: useful to handle drag & drop file upload on existing resources

Author:

Yohann Chastagnier

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService

RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

Field Summary

Fields inherited from class org.silverpeas.core.web.rs.RESTWebService

RESPONSE_HEADER_ARRAYSIZE

Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource

BASE_PATH

Constructor Summary

Constructors

Constructor	Description
FileUploadResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	delete()
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
javax.ws.rs.core.Response	uploadFile(InputStream inputStream)	Permits to upload one file from http request.
javax.ws.rs.core.Response	uploadFiles()	Permits to upload files from multipart http request.
javax.ws.rs.core.Response	verify()	Performs some verifications before starting a file upload.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

createWebResourceUri, fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource

validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

FileUploadResource

public FileUploadResource()

Method Detail

verify

@POST
@Path("verify")
@Consumes("multipart/form-data")
public javax.ws.rs.core.Response verify()

Performs some verifications before starting a file upload. All the verifications are checked again on the effective upload (security).

Returns:

the result of the verification: HTTP OK.

uploadFiles

@POST
@Consumes("multipart/form-data")
@Produces("text/html")
public javax.ws.rs.core.Response uploadFiles()

Permits to upload files from multipart http request. If the user isn't authenticated, a 401 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response in relation with jQuery plugins used on the client side: a html textarea tag that contains a JSON array structure. Each line of this array contains information of an uploaded file :

• uploadSessionId : the uploaded session identifier
• fullPath : the full path of the uploaded file
• name : the name of the uploaded file (without its path)
• size : the byte size of the uploaded file
• formattedSize : the formatted file size according to the language of user
• iconUrl : the url of the icon that represents the type of the uploaded file

uploadFile

@POST
@Consumes("application/octet-stream")
@Produces("text/html")
public javax.ws.rs.core.Response uploadFile(InputStream inputStream)

Permits to upload one file from http request. If the user isn't authenticated, a 401 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response in relation with jQuery plugins used on the client side: a html textarea tag that contains a JSON array structure. Each line of this array contains information of an uploaded file :

• uploadSessionId : the uploaded session identifier
• fullPath : the full path of the uploaded file
• name : the name of the uploaded file (without its path)
• size : the byte size of the uploaded file
• formattedSize : the formatted file size according to the language of user
• iconUrl : the url of the icon that represents the type of the uploaded file

delete

@DELETE
@Produces("application/json")
public javax.ws.rs.core.Response delete()

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().

Specified by:

getResourceBasePath in class RESTWebService

Returns:

the relative path that identifies this REST web service among all other REST web services.

getComponentId

public String getComponentId()

Description copied from interface: SilverpeasWebResource

Gets the identifier of the component instance to which the requested resource belongs to.

Returns:

the identifier of the Silverpeas component instance.