mobi.designmyapp.sdk.processor

Interface UploadProcessor<T>

All Known Implementing Classes:

IconUploadProcessor, ImageUploadProcessor, ZipUploadProcessor

public interface UploadProcessor<T>

Created by Loïc Ortola on 23/07/14. UploadProcessor is a descriptor class used to upload and process template specific files. Provide your own implementation(s) if resource upload features are needed through the API. Implementing UploadProcessor sub classes is not mandatory. An UploadProcessor specifies: - which extensions are valid or not - which specific processing to apply before response is sent. Warning: the processing is synchronous. The UploadProcessor can be Typed with a POJO used as payload in the Http Response.

Method Summary

Modifier and Type	Method and Description
String	getNamespace() The namespace identifies the UploadProcessor.
List<String>	getValidExtensions()
T	process(mobi.designmyapp.common.engine.model.UploadRequest request, File destDir) Called by the engine when a file has been successfully uploaded for the current matching namespace.

Method Detail

getNamespace

String getNamespace()

The namespace identifies the UploadProcessor. The namespace should represent the kind of entity which is bound to be uploaded (i.e: "spreadsheet", "image", ).

Returns:

the current UploadProcessor Implementation namespace.

process

T process(mobi.designmyapp.common.engine.model.UploadRequest request,
          File destDir)
   throws IOException

Called by the engine when a file has been successfully uploaded for the current matching namespace.

Parameters:

request - the UploadRequest. @see mobi.designmyapp.common.engine.model.UploadRequest.

destDir - the destination directory. Contains all resources already uploaded through this implementation.

Returns:

any POJO to be serialized and returned as a payload in the Http response.

Throws:

IOException

getValidExtensions

List<String> getValidExtensions()

Returns:

a List of valid extensions accepted by the UploadProcessor (i.e. "png", "jpg", "csv", ...)