Days
Hours
Minutes
Seconds
x

Froala Editor v4.1.4 is Here LEARN MORE

Skip to content

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:

    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.

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

    Type: String
    Default:
    "file"
  • validation

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

    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:
    /// 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.

Map<Object, Object> responseData;
try {
  responseData = File.upload(request, fileRoute, options);
} catch (Exception e) {
  e.printStackTrace();
  responseData = new HashMap();
  responseData.put("error", e.toString());
}
String jsonResponseData = new Gson().toJson(responseData);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.getWriter().write(jsonResponseData);

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

Do you think we can improve this article? Let us know.

[class^="wpforms-"]
[class^="wpforms-"]
[bws_google_captcha]
<div class="gglcptch gglcptch_v2"><div id="gglcptch_recaptcha_659188250" class="gglcptch_recaptcha"></div> <noscript> <div style="width: 302px;"> <div style="width: 302px; height: 422px; position: relative;"> <div style="width: 302px; height: 422px; position: absolute;"> <iframe src="https://www.google.com/recaptcha/api/fallback?k=6Ld6lNoUAAAAAM626LfCOrnkBFJtYZAKESFCjgv_" frameborder="0" scrolling="no" style="width: 302px; height:422px; border-style: none;"></iframe> </div> </div> <div style="border-style: none; bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px; background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px; height: 60px; width: 300px;"> <textarea id="g-recaptcha-response" name="g-recaptcha-response" class="g-recaptcha-response" style="width: 250px !important; height: 40px !important; border: 1px solid #c1c1c1 !important; margin: 10px 25px !important; padding: 0px !important; resize: none !important;"></textarea> </div> </div> </noscript></div>
[class^="wpforms-"]
[class^="wpforms-"]
[bws_google_captcha]
<div class="gglcptch gglcptch_v2"><div id="gglcptch_recaptcha_1326973865" class="gglcptch_recaptcha"></div> <noscript> <div style="width: 302px;"> <div style="width: 302px; height: 422px; position: relative;"> <div style="width: 302px; height: 422px; position: absolute;"> <iframe src="https://www.google.com/recaptcha/api/fallback?k=6Ld6lNoUAAAAAM626LfCOrnkBFJtYZAKESFCjgv_" frameborder="0" scrolling="no" style="width: 302px; height:422px; border-style: none;"></iframe> </div> </div> <div style="border-style: none; bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px; background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px; height: 60px; width: 300px;"> <textarea id="g-recaptcha-response" name="g-recaptcha-response" class="g-recaptcha-response" style="width: 250px !important; height: 40px !important; border: 1px solid #c1c1c1 !important; margin: 10px 25px !important; padding: 0px !important; resize: none !important;"></textarea> </div> </div> </noscript></div>
[class^="wpforms-"]
[class^="wpforms-"]
[bws_google_captcha]
<div class="gglcptch gglcptch_v2"><div id="gglcptch_recaptcha_1171261867" class="gglcptch_recaptcha"></div> <noscript> <div style="width: 302px;"> <div style="width: 302px; height: 422px; position: relative;"> <div style="width: 302px; height: 422px; position: absolute;"> <iframe src="https://www.google.com/recaptcha/api/fallback?k=6Ld6lNoUAAAAAM626LfCOrnkBFJtYZAKESFCjgv_" frameborder="0" scrolling="no" style="width: 302px; height:422px; border-style: none;"></iframe> </div> </div> <div style="border-style: none; bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px; background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px; height: 60px; width: 300px;"> <textarea id="g-recaptcha-response" name="g-recaptcha-response" class="g-recaptcha-response" style="width: 250px !important; height: 40px !important; border: 1px solid #c1c1c1 !important; margin: 10px 25px !important; padding: 0px !important; resize: none !important;"></textarea> </div> </div> </noscript></div>