Java SDK File Reference

Upload (request, fileRoute, options)

Returns: Map<Object, Object>

Method used to upload file to the specified location on disk.

Parameters:

• request

  All the HTTP specific information for the HTTP request.

  Type: HttpServletRequest

• fileRoute

  The server route for file uploads. This route must be public.

  Type: String

• options

  This parameter is optional. It is used to pass custom options for the file upload.

  Short example:

  Copy

  FileOptions options = new FileOptions();
  options.setResize(width, height, keepAspectRatio);
  

  Type: FileOptions

options parameter:

• fieldname

  Tag name that points to the file. Use getter/setter to access it.

  Copy

  option.('my-custom-fieldname');
  option.getFieldname();
  

  Type:	String
  Default:	"file"

• validation

  Specified the allowed file extensions and mimetypes. Use getter/setter to access it.

  Copy

  options.setValidation(new FileValidation());
  
  options.setValidation(new FileValidation(
      new String[] { "txt" }, 
      new String[] { "text/plain" }
  ));
  
  options.setValidation(new FileValidation(
      new CustomValidation() {
          @Override
          public boolean validate(String filePath, String mimeType) {
          }
      }
  ));
  
  options.getValidation();
  

  Type:	FileValidation
  Default:	Copy /// Allowed file validation default extensions. public static final String[] allowedFileExtsDefault = new String[] { "txt", "pdf", "doc" }; /// Allowed file validation default mimetypes. public static final String[] allowedFileMimeTypesDefault = new String[] { "text/plain", "application/msword", "application/x-pdf", "application/pdf" };

Response

If the upload is successful, the method returns an object with the absolute path to the uploaded file. If an error occurs, the method throws an exception.

Copy

Map<Object, Object> responseData;
try {
    responseData = File.upload(request, fileRoute, options);
} catch (Exception e) {
    e.printStackTrace();
    responseData = new HashMap

Delete (request, filePath)

Method used to delete a file from disk. Throws an exception if an error occurs.

Parameters:

• request

  All the HTTP specific information for the HTTP request.

  Type: HttpServletRequest

• filePath

  The server file path.

  Type: String